@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0101.public.ves.io.schema.discovery.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.discovery","description":"Service discovery in F5XC performs following\n\nDynamic service discovery: Resolving the load balancer endpoints for a ADC cluster\nDynamic VIP discovery: Publishing virtual IP to attract traffic from clients","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/discoverys":{"post":{"summary":"Create Discovery","description":"API to create discovery object for a site or virtual site in system namespace","operationId":"ves.io.schema.discovery.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-api-create"},"x-ves-proto-rpc":"ves.io.schema.discovery.API.Create"},"x-displayname":"Discovery","x-ves-proto-service":"ves.io.schema.discovery.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/discoverys/{metadata.name}":{"put":{"summary":"Replace Discovery","description":"API to replace discovery object for a site or virtual site in system namespace","operationId":"ves.io.schema.discovery.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-api-replace"},"x-ves-proto-rpc":"ves.io.schema.discovery.API.Replace"},"x-displayname":"Discovery","x-ves-proto-service":"ves.io.schema.discovery.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/discovery/{name}/download_certificates":{"post":{"summary":"Download Certificates","description":"Download the cerificates files for the Log Collerctor\nIn order to establish connection from the third party application server to the\nLog Colletor the user should download a zip file with the certificates files:\n- client.crt\n- client.key\n- server_ca.crt","operationId":"ves.io.schema.discovery.CustomAPI.DownloadCertificates","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryDownloadCertificatesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"shared\"\nx-required\nNamespace of the discovered service for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Discovery Name\n\nx-example: \"ds1\"\nx-required\nIdentifies the discovery name","in":"path","required":true,"x-displayname":"Discovery Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryDownloadCertificatesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-customapi-downloadcertificates"},"x-ves-proto-rpc":"ves.io.schema.discovery.CustomAPI.DownloadCertificates"},"x-displayname":"Discovery","x-ves-proto-service":"ves.io.schema.discovery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/discoverys":{"get":{"summary":"List Discovery","description":"List the set of discovery in a namespace","operationId":"ves.io.schema.discovery.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of discovery","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-api-list"},"x-ves-proto-rpc":"ves.io.schema.discovery.API.List"},"x-displayname":"Discovery","x-ves-proto-service":"ves.io.schema.discovery.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/discoverys/{name}":{"get":{"summary":"Get Discovery","description":"API to Get discovery object for a site or virtual site in system namespace","operationId":"ves.io.schema.discovery.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-api-get"},"x-ves-proto-rpc":"ves.io.schema.discovery.API.Get"},"delete":{"summary":"Delete Discovery","description":"Delete the specified discovery","operationId":"ves.io.schema.discovery.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discoveryDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovery-api-delete"},"x-ves-proto-rpc":"ves.io.schema.discovery.API.Delete"},"x-displayname":"Discovery","x-ves-proto-service":"ves.io.schema.discovery.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Discovery","x-ves-proto-package":"ves.io.schema.discovery","components":{"schemas":{"discoveryCBIPDeviceStatus":{"type":"object","title":"Status for each cbip device","x-ves-proto-message":"ves.io.schema.discovery.CBIPDeviceStatus","properties":{"cbip_mgmt_ip":{"type":"string","description":" IP Address of the Classic BIG-IP device\n\nExample: ` \"10.1.1.1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ipv4: true\n","title":"Management IP","x-displayname":"Management IP","x-ves-example":"10.1.1.1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4":"true"}},"condition":{"$ref":"#/components/schemas/schemaConditionType"}}},"discoveryCBIPStatusType":{"type":"object","description":"This status captures the status of the cBIP discovery and its internal objects like LB.","title":"Status for cBIP Discovery","x-displayname":"cBIP Discovery Status","x-ves-proto-message":"ves.io.schema.discovery.CBIPStatusType","properties":{"device_status":{"type":"array","description":" Status of the discovery task for each cbip device","title":"cbip Device Discovery Status","items":{"$ref":"#/components/schemas/discoveryCBIPDeviceStatus"},"x-displayname":"Device Discovery Status"}}},"discoveryCbipAdminCredentials":{"type":"object","description":"x-displayName: \"Admin Credentials\"","title":"Classic BIG-IP Admin Credentials","properties":{"password":{"$ref":"#/components/schemas/schemaSecretType"},"username":{"type":"string","description":"x-example: \"admin\"\nx-displayName: \"Admin Username\"\nx-required\nUsername used to log into an admin account on the BIG-IP device","title":"Classic BIG-IP Admin Username"}}},"discoveryCbipCertificateAuthority":{"type":"object","description":"x-displayName: \"Root CA Certificate\"\nBIG-IP Root CA Certificate","title":"BIG-IP Root CA Certificate","properties":{"skip_server_verification":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_ca":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discoveryCbipCluster":{"type":"object","description":"x-displayName: \"Classic BIG-IP Cluster\"\nA BIG-IP cluster is a set of BIG-IP devices which are in an\nActive-Active or Active-Standby setup or even a standalone BIG-IP device.","title":"Classic BIG-IP Cluster","properties":{"admin_credentials":{"$ref":"#/components/schemas/discoveryCbipAdminCredentials"},"cbip_certificate_authority":{"$ref":"#/components/schemas/discoveryCbipCertificateAuthority"},"cbip_devices":{"type":"array","description":"x-displayName: \"Classic BIG-IP Devices\"\nx-required\nList of Classic BIG-IP devices.","title":"Classic BIG-IP Devices","items":{"$ref":"#/components/schemas/discoveryCbipDeviceConfig"}},"cbip_mgmt_ips":{"type":"array","description":"x-displayName: \"Management IP\"\nx-required\nx-example: \"['10.1.1.1', '10.2.2.2']\"\nIP Addresses of Classic BIG-IP devices. Hostname is not supported.","title":"Classic BIG-IP Devices","items":{"type":"string"}},"default_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"mgmt_port":{"$ref":"#/components/schemas/discoveryManagementPort"},"namespace_mapping":{"$ref":"#/components/schemas/discoveryNamespaceMapping"},"virtual_server_filter":{"$ref":"#/components/schemas/discoveryVirtualServerFilter"}}},"discoveryCbipDeviceConfig":{"type":"object","description":"x-displayName: \"Classic BIG-IP Configuration\"","title":"Classic BIG-IP Configuration","properties":{"admin_credentials":{"$ref":"#/components/schemas/discoveryCbipAdminCredentials"},"cbip_certificate_authority":{"$ref":"#/components/schemas/discoveryCbipCertificateAuthority"},"cbip_mgmt_ip":{"type":"string","description":"x-displayName: \"Management IP\"\nx-required\nx-example: \"10.1.1.1\"\nIP Address of the Classic BIG-IP device. Hostname is not supported.","title":"Management IP"},"default_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"namespace_mapping":{"$ref":"#/components/schemas/discoveryNamespaceMapping"},"virtual_server_filter":{"$ref":"#/components/schemas/discoveryVirtualServerFilter"}}},"discoveryCbipDiscoveryType":{"type":"object","description":"x-displayName: \"Classic BIG-IP Discovery Configuration\"\nDiscovery configuration for Classic BIG-IP","title":"Classic BIG-IP Discovery Type","properties":{"cbip_clusters":{"type":"array","description":"x-displayName: \"Classic BIG-IP Clusters\"\nx-required\nList of Classic BIG-IP clusters. A BIG-IP cluster is a set of BIG-IP devices which\nare in an Active-Active or Active-Standby setup or even a standalone BIG-IP device.","title":"Classic BIG-IP Clusters","items":{"$ref":"#/components/schemas/discoveryCbipCluster"}},"internal_lb_domain":{"type":"string","description":"x-displayName: \"Internal LB domain\"\nDomain name of the internal LB","title":"Internal LB"},"server_ca":{"type":"array","description":"x-displayName: \"Server CA certificate\"\nServer CA certificate to connect to LB","title":"Server CA certificate to connect to internal LB","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"}}}},"discoveryConsulAccessInfo":{"type":"object","description":"Hashicorp Consul API server information","title":"ConsulAccessInfo","x-displayname":"Hashicorp Consul Parameters","x-ves-proto-message":"ves.io.schema.discovery.ConsulAccessInfo","properties":{"connection_info":{"$ref":"#/components/schemas/discoveryRestConfigType"},"http_basic_auth_info":{"$ref":"#/components/schemas/discoveryConsulHttpBasicAuthInfoType"}}},"discoveryConsulDiscoveryType":{"type":"object","description":"Discovery configuration for Hashicorp Consul","title":"consul discovery type","x-displayname":"Consul Discovery Configuration","x-ves-oneof-field-namespace_mapping_choice":"[]","x-ves-proto-message":"ves.io.schema.discovery.ConsulDiscoveryType","properties":{"access_info":{"$ref":"#/components/schemas/discoveryConsulAccessInfo"},"publish_info":{"$ref":"#/components/schemas/discoveryConsulVipDiscoveryInfoType"}}},"discoveryConsulHttpBasicAuthInfoType":{"type":"object","description":"Authentication parameters to access Hashicorp Consul.","title":"Hashicorp Consul Credentials","x-displayname":"Hashicorp Consul Credentials","x-ves-proto-message":"ves.io.schema.discovery.ConsulHttpBasicAuthInfoType","properties":{"passwd_url":{"$ref":"#/components/schemas/schemaSecretType"},"user_name":{"type":"string","description":" username in consul\n\nExample: ` \"Joe\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"username","maxLength":64,"x-displayname":"User Name","x-ves-example":"Joe","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}}}},"discoveryConsulNamespaceMapping":{"type":"object","description":"x-displayName: \"Consul Namespace Mapping\"\nSelect the mapping between Consul namespaces from which services will be discovered and App Namespace to which the discovered services will be shared.","title":"Consul Namespace Mapping","properties":{"items":{"type":"array","description":"x-displayName: \"Regex Matching\"\nx-required\nMap Consul namespace(s) to App Namespaces","title":"Consul Namespace to App Namespace Mapping","items":{"$ref":"#/components/schemas/discoveryConsulNamespaceMappingItem"}}}},"discoveryConsulNamespaceMappingItem":{"type":"object","description":"x-displayName: \"Consul Namespace Mapping Item\"\nMap Consul Namespace(s) to an App Namespace. If not specified, all virtual\nservers will be discovered under shared namespace.","title":"Consul Namespace Mapping Item","properties":{"namespace":{"type":"string","description":"x-displayName: \"F5XC Application Namespaces\"\nSelect a namespace","title":"App Namespace"},"namespace_regex":{"type":"string","description":"x-displayName: \"Consul Namespaces\"\nThe regex here will be used to match Consul namespace(s).","title":"Consul Namespace Regex"}}},"discoveryConsulVipDiscoveryInfoType":{"type":"object","description":"Consul Configuration to publish VIPs","title":"Consul VIP Discovery Info Type","x-displayname":"VIP Publish Configuration","x-ves-oneof-field-publish_choice":"[\"disable\",\"publish\"]","x-ves-proto-message":"ves.io.schema.discovery.ConsulVipDiscoveryInfoType","properties":{"disable":{"$ref":"#/components/schemas/ioschemaEmpty"},"publish":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"discoveryCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of discovery","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.discovery.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/discoveryCreateSpecType"}}},"discoveryCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.discovery.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/discoveryGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"discoveryCreateSpecType":{"type":"object","description":"API to create discovery object for a site or virtual site in system namespace","title":"Create discovery","x-displayname":"Create Discovery","x-ves-oneof-field-cluster_identifier_choice":"[\"cluster_id\",\"no_cluster_id\"]","x-ves-oneof-field-discovery_choice":"[\"discovery_consul\",\"discovery_k8s\"]","x-ves-proto-message":"ves.io.schema.discovery.CreateSpecType","properties":{"cluster_id":{"type":"string","description":"Exclusive with [no_cluster_id]\n Specify identifier for discovery cluster. This identifier can be\n specified in endpoint object to discover only from this discovery object.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Discovery cluster Identifier","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"discovery_consul":{"$ref":"#/components/schemas/discoveryConsulDiscoveryType"},"discovery_k8s":{"$ref":"#/components/schemas/discoveryK8SDiscoveryType"},"no_cluster_id":{"$ref":"#/components/schemas/ioschemaEmpty"},"where":{"$ref":"#/components/schemas/schemaNetworkSiteRefSelector"}}},"discoveryDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a discovery","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.discovery.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"discoveryDiscoveredServiceType":{"type":"object","description":"Details of each Discovered Service","title":"Discovered Service","x-displayname":"Service","x-ves-proto-message":"ves.io.schema.discovery.DiscoveredServiceType","properties":{"cluster_ip":{"type":"string","description":" IP Address of the service\n\nExample: ` \"192.1.2.3\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"Service IP","x-displayname":"IP","x-ves-example":"192.1.2.3","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}},"cluster_ipv6":{"type":"string","description":" IPv6 Address of the service\n\nExample: ` \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"Service IPv6","x-displayname":"IPv6","x-ves-example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}},"labels":{"type":"object","description":" Key value pairs defined as labels for the service\n\nValidation Rules:\n  ves.io.schema.rules.map.max_pairs: 16\n  ves.io.schema.rules.map.values.string.k8s_label_value: true\n","title":"Service labels","x-displayname":"Labels","x-ves-validation-rules":{"ves.io.schema.rules.map.max_pairs":"16","ves.io.schema.rules.map.values.string.k8s_label_value":"true"}},"namespace":{"type":"string","description":" Namespace of the discovered service\n\nExample: ` \"mynamespace\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"Namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"mynamespace","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}},"pods":{"type":"array","description":" List of pod-name to IP address mappings for the service","title":"POD list","items":{"$ref":"#/components/schemas/discoveryPodInfoType"},"x-displayname":"PODs"},"ports":{"type":"array","description":" List of ports along with protocol on which the service is exposed.","title":"Port list","items":{"$ref":"#/components/schemas/discoveryPortInfoType"},"x-displayname":"Ports"},"service_name":{"type":"string","description":" Name of the discovered service\n\nExample: ` \"myservice\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"Service name","maxLength":64,"x-displayname":"Service","x-ves-example":"myservice","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}},"service_type":{"type":"string","description":" Type of discovered service. Examples include \"ClusterIP\", \"NodePort\" etc\n\nExample: ` \"NodePort\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"Service Type","maxLength":64,"x-displayname":"Type","x-ves-example":"NodePort","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}}}},"discoveryDownloadCertificatesRequest":{"type":"object","description":"Download Certificates Of Log Collector","title":"DownloadCertificatesRequest","x-displayname":"Download Certificates","x-ves-proto-message":"ves.io.schema.discovery.DownloadCertificatesRequest","properties":{"name":{"type":"string","description":" Identifies the discovery name\n\nExample: ` \"ds1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Discovery Name","x-displayname":"Discovery Name","x-ves-example":"ds1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace of the discovered service for current request\n\nExample: ` \"shared\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"discoveryDownloadCertificatesResponse":{"type":"object","description":"Response to the DownloadCertificatesResponse\nA zip file with the certificates files:\n- client.crt\n- client.key\n- server_ca.crt","title":"DownloadCertificatesResponse","x-displayname":"Download Certificates Response","x-ves-displayorder":"1","x-ves-proto-message":"ves.io.schema.discovery.DownloadCertificatesResponse","properties":{"data":{"type":"string","description":" data is base64 encoded value of certificate in PKCS12 format.\n\nExample: ` \"value\"`","title":"Data","format":"byte","x-displayname":"Credentials","x-ves-example":"value"}}},"discoveryGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read discovery","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.discovery.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/discoveryCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/discoveryReplaceRequest"},"spec":{"$ref":"#/components/schemas/discoveryGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/discoveryStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"discoveryGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"discoveryGetSpecType":{"type":"object","description":"API to Get discovery object for a site or virtual site in system namespace","title":"Get discovery","x-displayname":"Get Discovery","x-ves-oneof-field-cluster_identifier_choice":"[\"cluster_id\",\"no_cluster_id\"]","x-ves-oneof-field-discovery_choice":"[\"discovery_consul\",\"discovery_k8s\"]","x-ves-proto-message":"ves.io.schema.discovery.GetSpecType","properties":{"cluster_id":{"type":"string","description":"Exclusive with [no_cluster_id]\n Specify identifier for discovery cluster. This identifier can be\n specified in endpoint object to discover only from this discovery object.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Discovery cluster Identifier","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"discovery_consul":{"$ref":"#/components/schemas/discoveryConsulDiscoveryType"},"discovery_k8s":{"$ref":"#/components/schemas/discoveryK8SDiscoveryType"},"no_cluster_id":{"$ref":"#/components/schemas/ioschemaEmpty"},"where":{"$ref":"#/components/schemas/schemaNetworkSiteRefSelector"}}},"discoveryK8SAccessInfo":{"type":"object","description":"K8S API server access","title":"K8S access info","x-displayname":"K8s API Server","x-ves-displayorder":"10,11","x-ves-oneof-field-config_type":"[\"connection_info\",\"kubeconfig_url\"]","x-ves-oneof-field-k8s_pod_network_choice":"[\"isolated\",\"reachable\"]","x-ves-proto-message":"ves.io.schema.discovery.K8SAccessInfo","properties":{"connection_info":{"$ref":"#/components/schemas/discoveryRestConfigType"},"isolated":{"$ref":"#/components/schemas/ioschemaEmpty"},"kubeconfig_url":{"$ref":"#/components/schemas/schemaSecretType"},"reachable":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"discoveryK8SDNSMode":{"type":"string","description":"Two modes are possible\n\nCoreDNS: Whether external K8s cluster is running core-dns\nKubeDNS: External K8s cluster is running kube-dns","title":"K8SDNSMode","enum":["CORE_DNS","KUBE_DNS"],"default":"CORE_DNS","x-displayname":"DNS Mode","x-ves-proto-enum":"ves.io.schema.discovery.K8SDNSMode"},"discoveryK8SDelegationType":{"type":"object","title":"K8SDelegationType","x-displayname":"K8SDelegationType","x-ves-proto-message":"ves.io.schema.discovery.K8SDelegationType","properties":{"dns_mode":{"$ref":"#/components/schemas/discoveryK8SDNSMode"},"subdomain":{"type":"string","description":" The DNS subdomain for which F5XC will respond to DNS queries.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"subdomain","maxLength":256,"x-displayname":"Subdomain","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}}}},"discoveryK8SDiscoveryType":{"type":"object","description":"Discovery configuration for K8s.","title":"K8s discovery type","x-displayname":"K8S Discovery Configuration","x-ves-oneof-field-namespace_mapping_choice":"[\"default_all\",\"namespace_mapping\"]","x-ves-proto-message":"ves.io.schema.discovery.K8SDiscoveryType","properties":{"access_info":{"$ref":"#/components/schemas/discoveryK8SAccessInfo"},"default_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"namespace_mapping":{"$ref":"#/components/schemas/discoveryK8SNamespaceMapping"},"publish_info":{"$ref":"#/components/schemas/discoveryK8SVipDiscoveryInfoType"}}},"discoveryK8SNamespaceMapping":{"type":"object","description":"Select the mapping between K8s namespaces from which services will be discovered and App Namespace to which the discovered services will be shared.","title":"K8S Namespace Mapping","x-displayname":"K8S Namespace Mapping","x-ves-proto-message":"ves.io.schema.discovery.K8SNamespaceMapping","properties":{"items":{"type":"array","description":" Map K8s namespace(s) to App Namespaces. In Shared Configuration, Discovered Services can only be mapped to a single App Namespace, which is determined by the first matched regex.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"K8S Namespace to App Namespace Mapping","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/discoveryK8SNamespaceMappingItem"},"x-displayname":"Regex Matching","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"discoveryK8SNamespaceMappingItem":{"type":"object","description":"Map K8s Namespace(s) to an App Namespace. If not specified, all virtual\nservers will be discovered under shared namespace.","title":"K8S Namespace Mapping Item","x-displayname":"K8S Namespace Mapping Item","x-ves-proto-message":"ves.io.schema.discovery.K8SNamespaceMappingItem","properties":{"namespace":{"type":"string","description":" Select a namespace","title":"App Namespace","x-displayname":"F5XC Application Namespaces"},"namespace_regex":{"type":"string","description":" The regex here will be used to match K8s namespace(s).\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.regex: true\n","title":"Kubernetes Namespace Regex","maxLength":256,"x-displayname":"K8S Namespaces","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.regex":"true"}}}},"discoveryK8SPublishType":{"type":"object","title":"K8SPublishType","x-displayname":"K8SPublishType","x-ves-proto-message":"ves.io.schema.discovery.K8SPublishType","properties":{"namespace":{"type":"string","description":" The namespace where the service/endpoints need to be created if it's not included in the domain.\n The external K8S administrator needs to ensure that the namespace exists.\n\nExample: ` \"default\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n","title":"namespace","maxLength":64,"x-displayname":"Default Namespace","x-ves-example":"default","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64"}}}},"discoveryK8SVipDiscoveryInfoType":{"type":"object","description":"K8S Configuration to publish VIPs","title":"K8S VIP Discovery Info Type","x-displayname":"VIP Publish Configurations","x-ves-oneof-field-publish_choice":"[\"disable\",\"dns_delegation\",\"publish\",\"publish_fqdns\"]","x-ves-proto-message":"ves.io.schema.discovery.K8SVipDiscoveryInfoType","properties":{"disable":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns_delegation":{"$ref":"#/components/schemas/discoveryK8SDelegationType"},"publish":{"$ref":"#/components/schemas/discoveryK8SPublishType"},"publish_fqdns":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"discoveryListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of discovery","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.discovery.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/discoveryListResponseItem"},"x-displayname":"Items"}}},"discoveryListResponseItem":{"type":"object","description":"By default a summary of discovery is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of discovery","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.discovery.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this discovery","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this discovery","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates discovery is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/discoveryGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this discovery","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this discovery\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/discoveryStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this discovery\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"discoveryManagementPort":{"type":"object","description":"x-displayName: \"Management Port\"","title":"Management Port","properties":{"port":{"type":"integer","description":"x-displayName: \"Management Port\"\nx-example: \"443\"\nManagement Port of the BIGIP HA cluster","title":"Management Port","format":"int64"}}},"discoveryNamespaceMapping":{"type":"object","description":"x-displayName: \"Namespace Mapping\"\nSelect the mapping between BIG-IP partition from which services will be discovered and App Namespace to which the discovered services will be shared.","title":"Namespace Mapping","properties":{"items":{"type":"array","description":"x-displayName: \"Partition to Namespace Mapping\"\nx-required\nMap BIG-IP partition(s) to App Namespaces","title":"Partition to Namespace Mapping","items":{"$ref":"#/components/schemas/discoveryNamespaceMappingItem"}}}},"discoveryNamespaceMappingItem":{"type":"object","description":"x-displayName: \"Namespace Mapping Item\"\nMap BIG-IP partition(s) to an App Namespace. If not specified, all virtual\nservers will be discovered under shared namespace.","title":"Namespace Mapping Item","properties":{"namespace":{"type":"string","description":"x-displayName: \"App Namespace\"\nSelect a namespace","title":"App Namespace"},"partition_regex":{"type":"string","description":"x-displayName: \"Regex To Match BIG-IP device partition(s)\"\nThe regex here will be used to match BIG-IP partition(s).","title":"Classic BIG-IP Partition Regex"}}},"discoveryPodInfoType":{"type":"object","description":"Information about POD providing the service","title":"Pod info","x-displayname":"POD","x-ves-proto-message":"ves.io.schema.discovery.PodInfoType","properties":{"ip":{"type":"string","description":" IP Address of the POD\n\nExample: ` \"192.1.2.3\"`","title":"IP Address","x-displayname":"IP","x-ves-example":"192.1.2.3"},"pod_name":{"type":"string","description":" Name of the Pod\n\nExample: ` \"mypod-nk8wr\"`","title":"POD name","x-displayname":"Name","x-ves-example":"mypod-nk8wr"}}},"discoveryPortInfoType":{"type":"object","description":"Information about port and protocol on which the service is provided","title":"Port information","x-displayname":"Port details","x-ves-proto-message":"ves.io.schema.discovery.PortInfoType","properties":{"port":{"type":"integer","description":" Port number on which the service is exposed\n\nExample: ` \"8080\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port","format":"int64","x-displayname":"Port number","x-ves-example":"8080","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}},"protocol":{"type":"string","description":" Protocol on which the service is exposed\n\nExample: ` \"TCP\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Protocol","x-displayname":"Protocol","x-ves-example":"TCP","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"target_port":{"type":"integer","description":" Port on which the pods targeted by the service can be reached.\n TargetPort of Kubernetes service when its type is ClusterIP.\n NodePort of Kubernetes service when its type is NodePort.\n\nExample: ` \"8081\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Target Port","format":"int64","x-displayname":"Target Port number","x-ves-example":"8081","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}}}},"discoveryReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a discovery","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.discovery.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/discoveryReplaceSpecType"}}},"discoveryReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.discovery.ReplaceResponse"},"discoveryReplaceSpecType":{"type":"object","description":"API to replace discovery object for a site or virtual site in system namespace","title":"Replace discovery","x-displayname":"Replace Discovery","x-ves-oneof-field-cluster_identifier_choice":"[\"cluster_id\",\"no_cluster_id\"]","x-ves-oneof-field-discovery_choice":"[\"discovery_consul\",\"discovery_k8s\"]","x-ves-proto-message":"ves.io.schema.discovery.ReplaceSpecType","properties":{"cluster_id":{"type":"string","description":"Exclusive with [no_cluster_id]\n Specify identifier for discovery cluster. This identifier can be\n specified in endpoint object to discover only from this discovery object.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Discovery cluster Identifier","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"discovery_consul":{"$ref":"#/components/schemas/discoveryConsulDiscoveryType"},"discovery_k8s":{"$ref":"#/components/schemas/discoveryK8SDiscoveryType"},"no_cluster_id":{"$ref":"#/components/schemas/ioschemaEmpty"},"where":{"$ref":"#/components/schemas/schemaNetworkSiteRefSelector"}}},"discoveryRestConfigType":{"type":"object","description":"Configuration details to access discovery service rest API.","title":"REST API config","x-displayname":"REST API Config","x-ves-proto-message":"ves.io.schema.discovery.RestConfigType","properties":{"api_server":{"type":"string","description":" API server must be a fully qualified domain string and port specified as host:port pair\n\nExample: ` \"api.acme.com:4430\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostport: true\n  ves.io.schema.rules.string.max_len: 262\n","title":"Discovery Service API server","maxLength":262,"x-displayname":"API Server and Port","x-ves-example":"api.acme.com:4430","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostport":"true","ves.io.schema.rules.string.max_len":"262"}},"tls_info":{"$ref":"#/components/schemas/discoveryTLSClientConfigType"}}},"discoverySchemeType":{"type":"string","description":"x-displayName: \"Scheme\"\nScheme to use when doing REST API to discovery server\n\n - HTTP: x-displayName: \"HTTP\"\nhttp:// Scheme\n - HTTPS: x-displayName: \"HTTPS\"\nhttps:// Scheme","title":"REST scheme","enum":["HTTP","HTTPS"],"default":"HTTP"},"discoveryStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Discovery Status Object","x-displayname":"Discovery Status","x-ves-proto-message":"ves.io.schema.discovery.StatusObject","properties":{"cbip_status":{"$ref":"#/components/schemas/discoveryCBIPStatusType"},"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"ver_status":{"$ref":"#/components/schemas/discoveryVerStatusType"}}},"discoveryTLSClientConfigType":{"type":"object","description":"TLS config for client of discovery service","title":"TLS config","x-displayname":"Client TLS Config","x-ves-proto-message":"ves.io.schema.discovery.TLSClientConfigType","properties":{"certificate":{"type":"string","description":" Client  certificate is PEM-encoded certificate or certificate-chain.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","maxLength":131072,"x-displayname":"Client Certificate","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}},"key_url":{"$ref":"#/components/schemas/schemaSecretType"},"server_name":{"type":"string","description":" ServerName is passed to the server for SNI and is used in the client to check server\n certificates against. If ServerName is empty, the hostname used to contact the\n server is used\n\nExample: ` \"k8s.acme.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Server Name","maxLength":256,"x-displayname":"SNI name","x-ves-example":"k8s.acme.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256"}},"trusted_ca_url":{"type":"string","description":" The URL or value for trusted Server CA certificate or certificate chain\n Certificates in PEM format including the PEM headers.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Server CA certificates","maxLength":131072,"x-displayname":"Server CA Certificates","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"discoveryThirdPartyDiscoveryType":{"type":"object","description":"x-displayName: \"Discovery\"\nConfigure third party log source applications to send logs to your XC environment. Define application names and allowed IP ranges using CIDR notation.\nSee Tech Docs for details setup instractions.","title":"Third Party Application","properties":{"applications":{"type":"array","description":"x-required\nx-displayName: \"Application Source Name\"\nDefines names to identify and distingish log source system or platforms","title":"Third Party Application","items":{"type":"string"}},"expiration_timestamp":{"type":"string","description":"x-displayName: \"Expiration Time\"\nThis discovery service expiration timestamp","title":"expiration_timestamp","format":"date-time"},"source_cidr":{"type":"array","description":"x-required\nx-displayName: \"Source Subnet IP\"\nx-example: \"1.1.1.0/24 or 2001:10/64\"\nSource IP of the packet to match","title":"source IP","items":{"type":"string"}}}},"discoveryVerStatusType":{"type":"object","description":"This VER status is per site on which discovery is happening and it lists all services that site has discovered.","title":"VER status for k8s and consul Discovery","x-displayname":"VER Status","x-ves-proto-message":"ves.io.schema.discovery.VerStatusType","properties":{"connected":{"type":"boolean","description":" Indicates connection status to external discovery service","title":"Connection status","format":"boolean","x-displayname":"Connection Status"},"services":{"type":"array","description":" List of discovered services","title":"Discovered Services","items":{"$ref":"#/components/schemas/discoveryDiscoveredServiceType"},"x-displayname":"Discovered Services"},"site":{"type":"string","description":" Name of the site that reported this status","title":"Origin site","x-displayname":"Site"},"type":{"$ref":"#/components/schemas/schemaDiscoveryType"}}},"discoveryVipDiscoveryInfoType":{"type":"object","description":"x-displayName: \"VIP Publish Configuration\"\nK8S Configuration to publish VIPs","title":"VIP Discovery Info Type","properties":{"dns_mode":{"$ref":"#/components/schemas/discoveryK8SDNSMode"},"namespace":{"type":"string","description":"x-displayName: \"Default Namespace\"\nWhen virtual IP is published with \"PUBLISH_SERVICE\" mode, this field indicates the namespace\nwhere the service/endpoints needs to be created if the domain name doesn't specify it\nexplicitly. K8S administrator of the external K8s should ensure this namespace is created","title":"default namespace"},"publish_virtual_ip":{"type":"boolean","description":"x-displayName: \"VIP Publish Enable\"\nAre we publishing Virtual Host domains to Virtual IP mapping to external cluster","title":"enable/disable publish VIP","format":"boolean"},"subdomain":{"type":"string","description":"x-displayName: \"Subdomain\"\nSubdomain for which DNS delegation is done\nF5XC Edge Router will only respond for DNS queries on this sub-domain\nWhile programming the DNS DELEGATE on external cluster, VER will take ownership of this\nsub-domain","title":"DNS delegation sub-domain"},"type":{"$ref":"#/components/schemas/discoveryVirtualIPDiscoveryType"}}},"discoveryVirtualIPDiscoveryType":{"type":"string","description":"x-displayName: \"Virtual IP Discovery\"\nHow is the Virtual IP discovery done\nTwo modes are possible\n  DNS_DELEGATION: Program DNS delegation for a sub-domain in external K8s cluster\n  PUBLISH_SERVICE: Create/Register a service in external K8s/consul cluster\n\n - DNS_DELEGATION: x-displayName: \"DNS Delegation\"\nDNS sub domain is delegated to volterra site.\n - PUBLISH_SERVICE: x-displayName: \"Publish\"\nName to VIP mapping is published in external discovery service","title":"VirtualIPDiscoveryType","enum":["DNS_DELEGATION","PUBLISH_SERVICE"],"default":"DNS_DELEGATION"},"discoveryVirtualServerFilter":{"type":"object","description":"x-displayName: \"Virtual Server Filter\"\nFilters to discover only required BIG-IP Virtual Servers. The Virtual Server will be discovered only if it matches all criteria specified below. A blank criteria will be treated as match all.","title":"Virtual Server Filter","properties":{"description_regex":{"type":"string","description":"x-displayName: \"Regex To Match Virtual Server Description\"\nRegex to match Virtual Server description","title":"Regex To Match Virtual Server Description"},"discover_disabled_virtual_servers":{"type":"boolean","description":"x-displayName: \"Discover Disabled Virtual Servers\"\nWhen checked, disabled virtual servers will be included","title":"Discover Disabled Virtual Servers","format":"boolean"},"name_regex":{"type":"string","description":"x-displayName: \"Regex To Match Virtual Server Name\"\nRegex to match Virtual Server name","title":"Regex To Match Virtual Server Name"},"port_ranges":{"type":"string","description":"x-displayName: \"Port Ranges\"\nx-example: \"80,443,8080-8191,9080\"\nA string containing a comma separated list of individual service ports or port ranges.\nEach port range consists of a single port or two ports separated by \"-\". For example, 8000-8191.\nMaximum number of ports allowed is 1024.","title":"Port_ranges"},"protocols":{"type":"array","description":"x-displayName: \"Protocol(s)\"\nx-example: \"TCP\"\nFilter by protocol(s)","title":"protocols","items":{"type":"string"}}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaDiscoveryType":{"type":"string","description":"Specifies whether the discovery is from Kubernetes or Consul cluster\n\nInvalid Discovery mechanism\nDiscover from Kubernetes cluster\nDiscover from Consul service\nDiscover from Classic BIG-IP Clusters\nDiscover for Third Party Application","title":"DiscoveryType","enum":["INVALID_DISCOVERY","K8S","CONSUL","CLASSIC_BIGIP","THIRD_PARTY"],"default":"INVALID_DISCOVERY","x-displayname":"Discovery Type","x-ves-proto-enum":"ves.io.schema.DiscoveryType"},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaMessageMetaType":{"type":"object","description":"x-displayName: \"Message Metadata\"\nMessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","properties":{"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Virtual Host for acmecorp website\"\nHuman readable description.","title":"description"},"disable":{"type":"boolean","description":"x-displayName: \"Disable\"\nx-example: \"true\"\nA value of true will administratively disable the object that corresponds to the containing message.","title":"disable","format":"boolean"},"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"acmecorp-web\"\nx-required\nThis is the name of the message.\nThe value of name has to follow DNS-1035 format.","title":"name"}}},"schemaNetworkRefType":{"type":"object","description":"This specifies a direct reference to a network configuration object","title":"NetworkRefType","x-displayname":"Network Reference","x-ves-proto-message":"ves.io.schema.NetworkRefType","properties":{"ref":{"type":"array","description":" A virtual network direct reference\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Reference","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaNetworkSiteRefSelector":{"type":"object","description":"NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network  or reference to virtual_site\nIt is used to determine virtual network using following rules\n * Direct reference to virtual_network object\n * Site local network when refering to site object\n * All site local networks for sites selected by refering to virtual_site object","title":"NetworkSiteRefSelector","x-displayname":"Network or Site Reference","x-ves-oneof-field-ref_or_selector":"[\"site\",\"virtual_network\",\"virtual_site\"]","x-ves-proto-message":"ves.io.schema.NetworkSiteRefSelector","properties":{"site":{"$ref":"#/components/schemas/schemaSiteRefType"},"virtual_network":{"$ref":"#/components/schemas/schemaNetworkRefType"},"virtual_site":{"$ref":"#/components/schemas/schemaVSiteRefType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaSiteRefType":{"type":"object","description":"This specifies a direct reference to a site configuration object","title":"SiteRefType","x-displayname":"Site Reference","x-ves-oneof-field-internet_vip_choice":"[\"disable_internet_vip\",\"enable_internet_vip\"]","x-ves-proto-message":"ves.io.schema.SiteRefType","properties":{"disable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkType"},"ref":{"type":"array","description":" A site direct reference\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Reference","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaVSiteRefType":{"type":"object","description":"A reference to virtual_site object","title":"VSiteRefType","x-displayname":"Virtual Site","x-ves-oneof-field-internet_vip_choice":"[\"disable_internet_vip\",\"enable_internet_vip\"]","x-ves-proto-message":"ves.io.schema.VSiteRefType","properties":{"disable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_internet_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkType"},"ref":{"type":"array","description":" A virtual_site direct reference\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Reference","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaVirtualNetworkType":{"type":"string","description":"Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly conects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Neworks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nfor volterra fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nvK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on volterra RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user","title":"VirtualNetworkType","enum":["VIRTUAL_NETWORK_SITE_LOCAL","VIRTUAL_NETWORK_SITE_LOCAL_INSIDE","VIRTUAL_NETWORK_PER_SITE","VIRTUAL_NETWORK_PUBLIC","VIRTUAL_NETWORK_GLOBAL","VIRTUAL_NETWORK_SITE_SERVICE","VIRTUAL_NETWORK_VER_INTERNAL","VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE","VIRTUAL_NETWORK_IP_AUTO","VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK","VIRTUAL_NETWORK_SRV6_NETWORK","VIRTUAL_NETWORK_IP_FABRIC","VIRTUAL_NETWORK_SEGMENT"],"default":"VIRTUAL_NETWORK_SITE_LOCAL","x-displayname":"Virtual Network Type","x-ves-proto-enum":"ves.io.schema.VirtualNetworkType"},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemaviewsObjectRefType":{"type":"object","description":"x-displayName: \"Object reference\"\nThis type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"contacts-route\"\nx-required\nWhen a configuration object(e.g. virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. route's) name.","title":"name"},"namespace":{"type":"string","description":"x-displayName: \"Namespace\"\nx-example: \"ns1\"\nWhen a configuration object(e.g. virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. route's) namespace.","title":"namespace"},"tenant":{"type":"string","description":"x-displayName: \"Tenant\"\nx-example: \"acmecorp\"\nWhen a configuration object(e.g. virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. route's) tenant.","title":"tenant"}}}}}}