@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.discovered_service","description":"Discovered Services represents the services (virtual-servers, k8s services, etc) which are discovered via the different discovery workflows.\n\npackage for Discovered Services","version":""},"paths":{"/api/discovery/custom/namespaces/{namespace}/discovered_services":{"get":{"summary":"List discovered services of specific type","description":"List the discovered services of specific type like virtual-servers, k8s, consul, nginx server, etc","operationId":"ves.io.schema.discovered_service.CustomAPI.ListDiscoveredServices","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceListServicesResponse"}}}},"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":"service_type","description":"x-example: \"bigip_virtual_server\"\nIdentifies the discovered service type. Omit for all types.","in":"query","required":false,"x-displayname":"Service Type","schema":{"type":"string"}},{"name":"discovery_name","description":"x-example: \"disc-cbip-1\"\nFilter results to only include items referencing this discovery object name","in":"query","required":false,"x-displayname":"Discovery Name Filter","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-listdiscoveredservices"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.ListDiscoveredServices"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services":{"get":{"summary":"List Discovered Services","description":"List the set of discovered_service in a namespace","operationId":"ves.io.schema.discovered_service.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceListResponse"}}}},"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 discovered_service","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-discovered_service-api-list"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.API.List"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services/{name}":{"get":{"summary":"Get Discovered Service Object","description":"Get Discovered Service Object.","operationId":"ves.io.schema.discovered_service.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceGetResponse"}}}},"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 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_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-discovered_service-api-get"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.API.Get"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_http_load_balancer":{"post":{"summary":"Create HTTP/HTTPS load balancer","description":"Create HTTP/HTTPS load balancer using the discovered virtual server as an origin server","operationId":"ves.io.schema.discovered_service.CustomAPI.CreateHTTPLoadBalancer","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceCreateHTTPLoadBalancerResponse"}}}},"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":"Service Name\n\nx-example: \"vs1\"\nx-required\nIdentifies the discovered service name","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceCreateHTTPLoadBalancerRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-createhttploadbalancer"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.CreateHTTPLoadBalancer"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_tcp_load_balancer":{"post":{"summary":"Create TCP load balancer","description":"Create TCP load balancer using the discovered virtual server as an origin server","operationId":"ves.io.schema.discovered_service.CustomAPI.CreateTCPLoadBalancer","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceCreateTCPLoadBalancerResponse"}}}},"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":"Service Name\n\nx-example: \"vs1\"\nx-required\nIdentifies the discovered service name","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceCreateTCPLoadBalancerRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-createtcploadbalancer"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.CreateTCPLoadBalancer"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services/{name}/disable_visibility":{"post":{"summary":"Disable visibility in all workspaces","description":"Disable Visibility of the service in all workspaces. This will remove the discovered service\nfrom being visible in other wokspaces like WAAP.","operationId":"ves.io.schema.discovered_service.CustomAPI.DisableVisibility","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceDisableVisibilityResponse"}}}},"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":"Service Name\n\nx-example: \"vs1\"\nx-required\nIdentifies the discovered service name","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceDisableVisibilityRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-disablevisibility"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.DisableVisibility"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/discovery/namespaces/{namespace}/discovered_services/{name}/enable_visibility":{"post":{"summary":"Enable visibility in all workspaces","description":"Enable Visibility of the service in all workspaces. This action will make the\ndiscovered service visible within WAAP, App Connect where the user can perform\nthe workspace specific actions.","operationId":"ves.io.schema.discovered_service.CustomAPI.EnableVisibility","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceEnableVisibilityResponse"}}}},"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":"Service Name\n\nx-example: \"vs1\"\nx-required\nIdentifies the discovered service name","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceEnableVisibilityRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-enablevisibility"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.EnableVisibility"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/discovered_services/{name}/health_status":{"get":{"summary":"Discovered Service Health Status","description":"Get Discovered Service Health status","operationId":"ves.io.schema.discovered_service.CustomDataAPI.DiscoveredServiceHealthStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceDiscoveredServiceHealthStatusResponse"}}}},"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-required\nx-example: \"ns1\"\nNamespace in which the Discovered Service is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-required\nx-example: \"vs1\"\nName of the Discovered Service","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customdataapi-discoveredservicehealthstatus"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomDataAPI.DiscoveredServiceHealthStatus"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/discovery/namespaces/{namespace}/suggest-values":{"post":{"summary":"Suggest Values","description":"SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.","operationId":"ves.io.schema.discovered_service.CustomAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemadiscovered_serviceSuggestValuesResp"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/discovered_serviceSuggestValuesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-discovered_service-customapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.discovered_service.CustomAPI.SuggestValues"},"x-displayname":"Discovered Services","x-ves-proto-service":"ves.io.schema.discovered_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Discovered Services","x-ves-proto-package":"ves.io.schema.discovered_service","components":{"schemas":{"discovered_serviceConsulService":{"type":"object","description":"Service details discovered from Consul.","title":"Consul Service","x-displayname":"Consul Service","x-ves-proto-message":"ves.io.schema.discovered_service.ConsulService","properties":{"discovery_object":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"pods":{"type":"array","description":" List of pod-name to IP address mappings for the service\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 50\n","title":"Pod List","maxItems":50,"items":{"$ref":"#/components/schemas/discoveryPodInfoType"},"x-displayname":"PODs","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"50"}},"ports":{"type":"array","description":" List of ports along with protocol on which the service is exposed\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 50\n","title":"Port List","maxItems":50,"items":{"$ref":"#/components/schemas/discoveryPortInfoType"},"x-displayname":"Ports","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"50"}},"service_name":{"type":"string","description":" Name of the discovered service\n\nExample: ` \"myservice\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Name","x-displayname":"Service","x-ves-example":"myservice","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"discovered_serviceCreateHTTPLoadBalancerRequest":{"type":"object","description":"CreateHTTPLoadBalancerRequest","title":"CreateHTTPLoadBalancerRequest","x-displayname":"CreateHTTPLoadBalancerRequest","x-ves-proto-message":"ves.io.schema.discovered_service.CreateHTTPLoadBalancerRequest","properties":{"http_lb_request":{"$ref":"#/components/schemas/discovered_serviceHTTPLBRequest"}}},"discovered_serviceCreateHTTPLoadBalancerResponse":{"type":"object","description":"CreateHTTPLoadBalancerResponse","title":"CreateHTTPLoadBalancerResponse","x-displayname":"CreateHTTPLoadBalancerResponse","x-ves-proto-message":"ves.io.schema.discovered_service.CreateHTTPLoadBalancerResponse","properties":{"http_loadbalancer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discovered_serviceCreateTCPLoadBalancerRequest":{"type":"object","description":"CreateTCPLoadBalancerRequest","title":"CreateTCPLoadBalancerRequest","x-displayname":"CreateTCPLoadBalancerRequest","x-ves-proto-message":"ves.io.schema.discovered_service.CreateTCPLoadBalancerRequest","properties":{"name":{"type":"string","description":" Identifies the discovered service name\n\nExample: ` \"vs1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Name","x-displayname":"Service Name","x-ves-example":"vs1","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"}},"tcp_lb_request":{"$ref":"#/components/schemas/discovered_serviceTCPLBRequest"}}},"discovered_serviceCreateTCPLoadBalancerResponse":{"type":"object","description":"CreateTCPLoadBalancerResponse","title":"CreateTCPLoadBalancerResponse","x-displayname":"CreateTCPLoadBalancerResponse","x-ves-proto-message":"ves.io.schema.discovered_service.CreateTCPLoadBalancerResponse","properties":{"tcp_loadbalancer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discovered_serviceDisableVisibilityRequest":{"type":"object","description":"Disable visibility on the discovered service","title":"DisableVisibilityRequest","x-displayname":"Disable visibility on the discovered service","x-ves-proto-message":"ves.io.schema.discovered_service.DisableVisibilityRequest","properties":{"name":{"type":"string","description":" Identifies the discovered service name\n\nExample: ` \"vs1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Name","x-displayname":"Service Name","x-ves-example":"vs1","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"}}}},"discovered_serviceDisableVisibilityResponse":{"type":"object","description":"Response to the Disable Visibility request","title":"DisableVisibilityResponse","x-displayname":"Disable Visibility Response","x-ves-proto-message":"ves.io.schema.discovered_service.DisableVisibilityResponse"},"discovered_serviceDiscoveredServiceHealthStatusResponse":{"type":"object","description":"Response for Discovered Service Health Status Request","title":"DiscoveredServiceHealthStatusResponse","x-displayname":"Discovered Service Health Status Response","x-ves-proto-message":"ves.io.schema.discovered_service.DiscoveredServiceHealthStatusResponse","properties":{"status":{"type":"array","description":" Health Status of Discovered Service","title":"Status","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Status"},"virtual_server_pool_members_health":{"$ref":"#/components/schemas/discovered_serviceVirtualServerPoolMemberHealth"}}},"discovered_serviceEnableVisibilityRequest":{"type":"object","description":"Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc","title":"EnableVisibilityRequest","x-displayname":"Enable visibility","x-ves-proto-message":"ves.io.schema.discovered_service.EnableVisibilityRequest","properties":{"name":{"type":"string","description":" Identifies the discovered service name\n\nExample: ` \"vs1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Name","x-displayname":"Service Name","x-ves-example":"vs1","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"}}}},"discovered_serviceEnableVisibilityResponse":{"type":"object","description":"Response to the Enable Visibility request","title":"EnableVisibilityResponse","x-displayname":"Enable Visibility Response","x-ves-proto-message":"ves.io.schema.discovered_service.EnableVisibilityResponse","properties":{"virtual_host_ref":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discovered_serviceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read discovered_service","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.discovered_service.GetResponse","properties":{"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"},"spec":{"$ref":"#/components/schemas/schemadiscovered_serviceGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"discovered_serviceGetResponseFormatCode":{"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_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_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"discovered_serviceHTTPLBRequest":{"type":"object","description":"HTTP LB Request Parameters","title":"HTTP LB Request","x-displayname":"HTTP(s) LB Request","x-ves-displayorder":"1,2,9,6","x-ves-oneof-field-advertise_choice":"[]","x-ves-oneof-field-loadbalancer_type":"[\"http\",\"https\",\"https_auto_cert\"]","x-ves-oneof-field-server_validation_choice":"[\"skip_server_verification\",\"trusted_ca\"]","x-ves-proto-message":"ves.io.schema.discovered_service.HTTPLBRequest","properties":{"domain":{"type":"string","description":"\nExample: ` \"www.foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.vh_domain: true\n","title":"Domain","x-displayname":"Domain","x-ves-example":"www.foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.vh_domain":"true"}},"http":{"$ref":"#/components/schemas/discovered_serviceProxyTypeHttp"},"https":{"$ref":"#/components/schemas/discovered_serviceProxyTypeHttps"},"https_auto_cert":{"$ref":"#/components/schemas/ioschemaEmpty"},"name":{"type":"string","description":" The configuration object will be created with name. It has to be unique within the namespace.\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"}},"skip_server_verification":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_ca":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discovered_serviceK8sService":{"type":"object","description":"Service details discovered from K8s.","title":"K8s Service","x-displayname":"K8s Service","x-ves-proto-message":"ves.io.schema.discovered_service.K8sService","properties":{"discovery_object":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"pods":{"type":"array","description":" List of pod-name to IP address mappings for the service\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 50\n","title":"Pod List","maxItems":50,"items":{"$ref":"#/components/schemas/discoveryPodInfoType"},"x-displayname":"PODs","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"50"}},"ports":{"type":"array","description":" List of ports along with protocol on which the service is exposed\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 50\n","title":"Port List","maxItems":50,"items":{"$ref":"#/components/schemas/discoveryPortInfoType"},"x-displayname":"Ports","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"50"}},"service_name":{"type":"string","description":" Name of the discovered service\n\nExample: ` \"myservice\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service Name","x-displayname":"Service","x-ves-example":"myservice","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"discovered_serviceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of discovered_service","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.discovered_service.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/discovered_serviceListResponseItem"},"x-displayname":"Items"}}},"discovered_serviceListResponseItem":{"type":"object","description":"By default a summary of discovered_service 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 discovered_service","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.discovered_service.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this discovered_service","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this discovered_service","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates discovered_service is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemadiscovered_serviceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this discovered_service","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this discovered_service\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"},"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 discovered_service\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"discovered_serviceListServicesResponse":{"type":"object","description":"This is the output message of List for specific service type.","title":"ListServicesResponse is the collection of discovered service","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.discovered_service.ListServicesResponse","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/discovered_serviceListServicesResponseItem"},"x-displayname":"Items"}}},"discovered_serviceListServicesResponseItem":{"type":"object","description":"By default a summary of discovered services is returned in 'List'. By setting\n'report_fields' in the ListServicesRequest more details of each item can be got.","title":"ListServicesResponseItem is an individual item in a collection of discovered services of specific type","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.discovered_service.ListServicesResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this discovered service","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this discovered service","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates discovered service is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemadiscovered_serviceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this discovered service","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this discovered service\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/discovered_serviceStatusObject"},"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 discovered service\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"discovered_serviceNginxOneDiscoveredServer":{"type":"object","description":"Discovered Servers Info","title":"NginxOneDiscoveredServer","x-displayname":"NGINX One Discovered Server","x-ves-proto-message":"ves.io.schema.discovered_service.NginxOneDiscoveredServer","properties":{"domains":{"type":"array","description":" Domains configured on the Server\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domains","maxItems":32,"items":{"type":"string"},"x-displayname":"Domains","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}},"nginx_one_object_id":{"type":"string","description":" ID of the NGINX Instance or Config Sync Group\n\nExample: ` \"inst_awuzd-6yRb2zbUPRxLa0SQ\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"NGINX Instance or Config Sync Group ID","maxLength":256,"x-displayname":"Instance or Config Sync Group Object ID","x-ves-example":"inst_awuzd-6yRb2zbUPRxLa0SQ","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"nginx_one_object_name":{"type":"string","description":" Hostname value set for Instance or Name for a Config Sync Group\n in NGINX One","title":"NGINX Instance or Config Sync Group Name","x-displayname":"Instance or Config Sync Group Name"},"nginx_service_discovery_ref":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"port":{"type":"integer","description":" Port number on which the Server 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","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"}},"server_block":{"type":"string","description":" Server Block Name\n\nExample: ` \"server-block-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"Server Block Name","maxLength":256,"x-displayname":"Server Block Name","x-ves-example":"server-block-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}}}},"discovered_serviceProxyTypeHttp":{"type":"object","description":"Choice for selecting HTTP proxy","title":"HTTP Choice","x-displayname":"HTTP","x-ves-oneof-field-advertise_choice":"[\"advertise_on_public_default_vip\",\"site\",\"virtual_site\"]","x-ves-proto-message":"ves.io.schema.discovered_service.ProxyTypeHttp","properties":{"advertise_on_public_default_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"site":{"$ref":"#/components/schemas/schemadiscovered_serviceWhereSite"},"virtual_site":{"$ref":"#/components/schemas/schemadiscovered_serviceWhereVirtualSite"}}},"discovered_serviceProxyTypeHttps":{"type":"object","description":"Choice for selecting HTTP proxy with bring your own certificate","title":"BYOC HTTPS Choice","x-displayname":"BYOC HTTPS Choice","x-ves-oneof-field-advertise_choice":"[\"advertise_on_public_default_vip\",\"site\",\"virtual_site\"]","x-ves-proto-message":"ves.io.schema.discovered_service.ProxyTypeHttps","properties":{"advertise_on_public_default_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"certificates":{"type":"array","description":" Select a certificate\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":"TLS Certificate","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"TLS Certificate","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}},"site":{"$ref":"#/components/schemas/schemadiscovered_serviceWhereSite"},"virtual_site":{"$ref":"#/components/schemas/schemadiscovered_serviceWhereVirtualSite"}}},"discovered_serviceStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Discovered Services Status Object","x-displayname":"Discovered Services Status Object","x-ves-proto-message":"ves.io.schema.discovered_service.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"}}},"discovered_serviceSuggestValuesReq":{"type":"object","description":"Request body of SuggestValues request","title":"SuggestValuesReq","x-displayname":"Request for SuggestValues","x-ves-proto-message":"ves.io.schema.discovered_service.SuggestValuesReq","properties":{"field_path":{"type":"string","description":" JSON path of the field for which the suggested values are being requested.\n\nExample: ` \"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"field_path","maxLength":1024,"x-displayname":"Field Path","x-ves-example":"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"match_value":{"type":"string","description":" A substring that must be present in either the value or description of each SuggestedItem in the response.\n\nExample: ` \"some-substring\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"match_value","maxLength":256,"x-displayname":"Match Value","x-ves-example":"some-substring","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"request_body":{"$ref":"#/components/schemas/protobufAny"}}},"discovered_serviceTCPLBRequest":{"type":"object","description":"TCP LB Request","title":"TCP LB Request","x-displayname":"TCP LB Request","x-ves-displayorder":"1,2,3,6,9","x-ves-oneof-field-advertise_choice":"[\"advertise_custom\",\"advertise_on_public_default_vip\"]","x-ves-oneof-field-port_choice":"[\"listen_port\",\"port_ranges\"]","x-ves-oneof-field-sni_default_lb_choice":"[\"no_sni\",\"sni\"]","x-ves-proto-message":"ves.io.schema.discovered_service.TCPLBRequest","properties":{"advertise_custom":{"$ref":"#/components/schemas/viewsAdvertiseCustom"},"advertise_on_public_default_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"type":"string","description":"\nExample: ` \"www.foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.vh_domain: true\n","title":"Domain","x-displayname":"Domain","x-ves-example":"www.foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.vh_domain":"true"}},"listen_port":{"type":"integer","description":"Exclusive with [port_ranges]\n Listen Port for this load balancer\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port","format":"int64","x-displayname":"Listen Port","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"65535"}},"name":{"type":"string","description":" The configuration object will be created with name. It has to be unique within the namespace.\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"}},"no_sni":{"$ref":"#/components/schemas/ioschemaEmpty"},"port_ranges":{"type":"string","description":"Exclusive with [listen_port]\n A string containing a comma separated list of port ranges.\n Each port range consists of a single port or two ports separated by \"-\".\n\nExample: ` \"80,443,8080-8191,9080\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.max_ports: 64\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.unique_port_range_list: true\n","title":"Port_ranges","minLength":1,"maxLength":512,"x-displayname":"Port Ranges","x-ves-example":"80,443,8080-8191,9080","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.max_ports":"64","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.unique_port_range_list":"true"}},"sni":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"discovered_serviceThirdPartyApplicationDiscovery":{"type":"object","description":"Configure 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 detailed setup instructions.","title":"third_party_application","x-displayname":"Discovery","x-ves-proto-message":"ves.io.schema.discovered_service.ThirdPartyApplicationDiscovery","properties":{"discovery_object":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"discovered_serviceTransmissionProtocol":{"type":"string","description":"x-displayName: \"Transmission Protocol\"\nx-example: \"TCP\"\nProtocol on which the virtual-server will transmit data","title":"TransmissionProtocol","enum":["UNDEFINED","HTTP","HTTPS","TCP"],"default":"UNDEFINED"},"discovered_serviceVirtualServer":{"type":"object","description":"Virtual Server discovered from BIG-IP.","title":"virtual_server","x-displayname":"Virtual Server","x-ves-proto-message":"ves.io.schema.discovered_service.VirtualServer","properties":{"bigip_version":{"type":"string","description":" Version of the BIG-IP from where the service was discovered\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":"BIG-IP version","maxLength":256,"x-displayname":"BIG-IP Version","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"cbip_cluster":{"type":"string","description":" Name of CBIP Cluster.\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":"CBIP Cluster Name","maxLength":256,"x-displayname":"CBIP Cluster Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"discovery_object":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"enabled_state":{"$ref":"#/components/schemas/discovered_serviceVirtualServerEnabledState"},"ip_address":{"type":"string","description":" IP address of the BIG-IP Virtual Server\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ip: true\n","title":"Virtual Server IP Address","x-displayname":"Virtual Server IP","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ip":"true"}},"partition":{"type":"string","description":" Partition of virtual-server\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":"partition","maxLength":256,"x-displayname":"Partition","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"port":{"type":"integer","description":" Port number on which the virtual-server is exposed\n\nExample: ` \"8080\"`\n\nValidation Rules:\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-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}},"server_name":{"type":"string","description":" Virtual Server name\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"Server Name","maxLength":1024,"x-displayname":"Server Name","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"status":{"$ref":"#/components/schemas/discovered_serviceVirtualServerStatus"},"sub_path":{"type":"string","description":" BIG-IP Virtual Server sub path in relation to partition\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"Sub Path","maxLength":1024,"x-displayname":"Sub Path","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}}}},"discovered_serviceVirtualServerEnabledState":{"type":"string","description":"Enabled state of the virtual server.\n\n - NONE: NONE\n\nInvalid state.\n - ENABLED: ENABLED\n\nVirtual Server is enabled.\n - DISABLED: DISABLED\n\nVirtual Server is administratively disabled.","title":"Enabled state of the virtual server","enum":["NONE","ENABLED","DISABLED"],"default":"NONE","x-displayname":"Virtual Server Enabled State","x-ves-proto-enum":"ves.io.schema.discovered_service.VirtualServerEnabledState"},"discovered_serviceVirtualServerPoolHealthStatusListResponseItem":{"type":"object","description":"Pool member health","title":"VirtualServerPoolHealthStatusListResponseItem","x-displayname":"Discovered Service Pool Health Status List Item","x-ves-proto-message":"ves.io.schema.discovered_service.VirtualServerPoolHealthStatusListResponseItem","properties":{"name":{"type":"string","description":" Name of the Virtual Server's Pool Member\n\nExample: ` \"vs_pm_1\"`","title":"Name","x-displayname":"Pool Member Name","x-ves-example":"vs_pm_1"},"status":{"type":"array","description":" Health Status of Pool Member","title":"Status","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Status"}}},"discovered_serviceVirtualServerPoolMemberHealth":{"type":"object","description":"Health of each pool member of the virtual server","title":"BIG-IP Virtual Server's Pool Member Health","x-displayname":"Virtual Server's Pool Members Health","x-ves-proto-message":"ves.io.schema.discovered_service.VirtualServerPoolMemberHealth","properties":{"virtual_server_pool_members":{"type":"array","description":" Collection of Pool member health status","title":"BIG-IP Virtual Server's Pool Member Health","items":{"$ref":"#/components/schemas/discovered_serviceVirtualServerPoolHealthStatusListResponseItem"},"x-displayname":"Pool Member health"}}},"discovered_serviceVirtualServerStatus":{"type":"string","description":"Availability Status of the virtual server.\n\n - UNSPECIFIED: UNSPECIFIED\n\nInvalid status.\n - AVAILABLE: AVAILABLE\n\nVirtual Server is available and serving traffic.\n - OFFLINE: OFFLINE\n\nVirtual Server is not serving traffic.\n - UNKNOWN: UNKNOWN\n\nVirtual Server availability is unknown. It can indicate that no service checks are enabled on the virtual server.\n - UNAVAILABLE: UNAVAILABLE\n\nVirtual Server is temporarily unavailable maybe due to hitting connection limit.\n - DELETED: DELETED\n\nVirtual Server has been deleted on the BIG-IP but is in use on Distributed Cloud.","title":"Availability Status of the virtual server","enum":["UNSPECIFIED","AVAILABLE","OFFLINE","UNKNOWN","UNAVAILABLE","DELETED"],"default":"UNSPECIFIED","x-displayname":"Virtual Server Availability Status","x-ves-proto-enum":"ves.io.schema.discovered_service.VirtualServerStatus"},"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"}}}},"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"}}},"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\\\"]"}}}},"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"}}},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"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"}}},"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"}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"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"}}},"schemadiscovered_serviceGetSpecType":{"type":"object","description":"Get Discovered Service Object.","title":"Get Discovered Service Object","x-displayname":"Get Discovered Service Object","x-ves-oneof-field-service_type":"[\"consul_service\",\"k8s_service\",\"n1_discovered_server\",\"third_party\",\"virtual_server\"]","x-ves-oneof-field-visibility_action_choice":"[\"visibility_disabled\",\"visibility_enabled\"]","x-ves-proto-message":"ves.io.schema.discovered_service.GetSpecType","properties":{"consul_service":{"$ref":"#/components/schemas/discovered_serviceConsulService"},"http_load_balancers":{"type":"array","description":" List of references to HTTP Load Balancers using this service","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"HTTP Load Balancers"},"k8s_service":{"$ref":"#/components/schemas/discovered_serviceK8sService"},"n1_discovered_server":{"$ref":"#/components/schemas/discovered_serviceNginxOneDiscoveredServer"},"tcp_load_balancers":{"type":"array","description":" List of references to TCP Load Balancers using this service","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"TCP Load Balancers"},"third_party":{"$ref":"#/components/schemas/discovered_serviceThirdPartyApplicationDiscovery"},"virtual_server":{"$ref":"#/components/schemas/discovered_serviceVirtualServer"},"visibility_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"visibility_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemadiscovered_serviceSuggestValuesResp":{"type":"object","description":"Response body of SuggestValues request","title":"SuggestValuesResp","x-displayname":"Response for SuggestValues","x-ves-proto-message":"ves.io.schema.discovered_service.SuggestValuesResp","properties":{"items":{"type":"array","description":" List of suggested items.","title":"item_lists","items":{"$ref":"#/components/schemas/schemadiscovered_serviceSuggestedItem"},"x-displayname":"Suggested Items"}}},"schemadiscovered_serviceSuggestedItem":{"type":"object","description":"A tuple with a suggested value and it's description.","title":"SuggestedItem","x-displayname":"Suggested Item","x-ves-oneof-field-value_choice":"[\"ref_value\",\"str_value\"]","x-ves-proto-message":"ves.io.schema.discovered_service.SuggestedItem","properties":{"description":{"type":"string","description":" Optional description for the suggested value.","title":"description","x-displayname":"Description"},"ref_value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"str_value":{"type":"string","description":"Exclusive with [ref_value]\n","title":"str_value","x-displayname":"String"}}},"schemadiscovered_serviceWhereSite":{"type":"object","description":"This defines a reference to a CE site where a load balancer could be advertised","title":"WhereSite","x-displayname":"Site","x-ves-proto-message":"ves.io.schema.discovered_service.WhereSite","properties":{"site":{"type":"array","description":" Reference to site object\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":"Site","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Site Reference","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemadiscovered_serviceWhereVirtualSite":{"type":"object","description":"This defines a reference to a customer site virtual site where a load balancer could be advertised","title":"WhereVirtualSite","x-displayname":"Virtual Site","x-ves-proto-message":"ves.io.schema.discovered_service.WhereVirtualSite","properties":{"virtual_site":{"type":"array","description":" Reference to virtual site object\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":"Virtual Site","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Site Reference","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaviewsObjectRefType":{"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","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"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: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"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\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"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\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"schemaviewsWhereSite":{"type":"object","description":"This defines a reference to a CE site along with network type and an optional ip address where a load balancer could be advertised","title":"WhereSite","x-displayname":"Site","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.views.WhereSite","properties":{"ip":{"type":"string","description":" Use given IP address as VIP on the site\n\nExample: ` \"8.8.8.8\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IP address on the site","x-displayname":"IP Address","x-ves-example":"8.8.8.8","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"network":{"$ref":"#/components/schemas/viewsSiteNetwork"},"site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"schemaviewsWhereVirtualSite":{"type":"object","description":"This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised","title":"WhereVirtualSite","x-displayname":"Virtual Site","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.WhereVirtualSite","properties":{"network":{"$ref":"#/components/schemas/viewsSiteNetwork"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsAdvertiseCustom":{"type":"object","description":"This defines a way to advertise a VIP on specific sites","title":"AdvertiseWhere","x-displayname":"Advertise Custom","x-ves-proto-message":"ves.io.schema.views.AdvertiseCustom","properties":{"advertise_where":{"type":"array","description":" Where should this load balancer be available\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":"Advertise Where","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/viewsWhereType"},"x-displayname":"List of Sites to Advertise","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"}}}},"viewsAdvertisePublic":{"type":"object","description":"This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available","title":"AdvertisePublic","x-displayname":"Advertise Public","x-ves-proto-message":"ves.io.schema.views.AdvertisePublic","properties":{"public_ip":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsSiteNetwork":{"type":"string","description":"This defines network types to be used on site\n\nAll inside and outside networks.\nAll inside and outside networks with internet VIP support.\nAll inside networks.\nAll outside networks.\nAll outside networks with internet VIP support.\nvK8s service network.\n - SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site\n\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","title":"SiteNetwork","enum":["SITE_NETWORK_INSIDE_AND_OUTSIDE","SITE_NETWORK_INSIDE","SITE_NETWORK_OUTSIDE","SITE_NETWORK_SERVICE","SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP","SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP","SITE_NETWORK_IP_FABRIC"],"default":"SITE_NETWORK_INSIDE_AND_OUTSIDE","x-displayname":"Site Network","x-ves-proto-enum":"ves.io.schema.views.SiteNetwork"},"viewsSiteNetworkSpecifiedVIP":{"type":"string","description":"This defines network types to be used on virtual-site with specified VIP\n\nAll outside networks.\nAll inside networks.","title":"SiteNetworkSpecifiedVIP","enum":["SITE_NETWORK_SPECIFIED_VIP_OUTSIDE","SITE_NETWORK_SPECIFIED_VIP_INSIDE"],"default":"SITE_NETWORK_SPECIFIED_VIP_OUTSIDE","x-displayname":"Site Network","x-ves-proto-enum":"ves.io.schema.views.SiteNetworkSpecifiedVIP"},"viewsWhereCloudEdgeSegment":{"type":"object","description":"x-displayName: \"Segment on a Cloud Edge\"\nThis defines a reference to a Segment on a Cloud Edge and an optional ip address where a load balancer could be advertised","title":"WhereCloudEdgeSegment","properties":{"cloud_edge":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"ip":{"type":"string","description":"x-displayName: \"IP Address\"\nx-required\nx-example: \"8.8.8.8\"\nUse given IP address as VIP on the Cloud Edge","title":"IP address on the Cloud Edge"},"ipv6":{"type":"string","description":"x-displayName: \"IPv6 Address\"\nx-example: \"2001::1\"\nUse given IPv6 address as VIP on the Cloud Edge","title":"IPv6 address on the Cloud Edge"},"segment":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereSegment":{"type":"object","description":"x-displayName: \"Virtual Network\"\nParameters to advertise on a given virtual network","title":"WhereVirtualNetwork","properties":{"ipv4_vip":{"type":"string","description":"x-displayName: \"IPV4 VIP\"\nx-required\nConfigure IPV4 VIP address","title":"IPv4 VIP"},"ipv6_vip":{"type":"string","description":"x-displayName: \"IPV6 VIP\"\nConfigure IPV6 VIP address","title":"IPv6 VIP"},"segment":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereSiteSegment":{"type":"object","description":"x-displayName: \"Segment on Site\"\nThis defines a reference to a Segment on a Site and an optional ip address where a load balancer could be advertised","title":"WhereSiteSegment","properties":{"ip":{"type":"string","description":"x-displayName: \"IP Address\"\nx-required\nx-example: \"8.8.8.8\"\nUse given IP address as VIP on the site","title":"IP address on the site"},"ipv6":{"type":"string","description":"x-displayName: \"IPv6 Address\"\nx-example: \"2001::1\"\nUse given IPv6 address as VIP on the site","title":"IPv6 address on the site"},"segment":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereType":{"type":"object","description":"This defines various options where a Loadbalancer could be advertised","title":"WhereType","x-displayname":"Select Where to Advertise","x-ves-displayorder":"4,5","x-ves-oneof-field-choice":"[\"advertise_on_public\",\"cloud_edge_segment\",\"segment\",\"site\",\"site_segment\",\"virtual_network\",\"virtual_site\",\"virtual_site_segment\",\"virtual_site_with_vip\",\"vk8s_service\"]","x-ves-oneof-field-port_choice":"[\"port\",\"port_ranges\",\"use_default_port\"]","x-ves-proto-message":"ves.io.schema.views.WhereType","properties":{"advertise_on_public":{"$ref":"#/components/schemas/viewsAdvertisePublic"},"port":{"type":"integer","description":"Exclusive with [port_ranges use_default_port]\n Port to Listen.\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port to listen","format":"int64","x-displayname":"Listen Port","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}},"port_ranges":{"type":"string","description":"Exclusive with [port use_default_port]\n A string containing a comma separated list of port ranges.\n Each port range consists of a single port or two ports separated by \"-\".\n\nExample: ` \"80,443,8080-8191,9080\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.max_ports: 64\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.unique_port_range_list: true\n","title":"Port ranges to listen","minLength":1,"maxLength":512,"x-displayname":"Listen Port Ranges","x-ves-example":"80,443,8080-8191,9080","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.max_ports":"64","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.unique_port_range_list":"true"}},"site":{"$ref":"#/components/schemas/schemaviewsWhereSite"},"use_default_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"virtual_network":{"$ref":"#/components/schemas/viewsWhereVirtualNetwork"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsWhereVirtualSite"},"virtual_site_with_vip":{"$ref":"#/components/schemas/viewsWhereVirtualSiteSpecifiedVIP"},"vk8s_service":{"$ref":"#/components/schemas/viewsWhereVK8SService"}}},"viewsWhereVK8SService":{"type":"object","description":"This defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network","title":"WhereVK8SService","x-displayname":"vK8s Services on RE","x-ves-displayorder":"3","x-ves-oneof-field-choice":"[\"site\",\"virtual_site\"]","x-ves-proto-message":"ves.io.schema.views.WhereVK8SService","properties":{"site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereVirtualNetwork":{"type":"object","description":"Parameters to advertise on a given virtual network","title":"WhereVirtualNetwork","x-displayname":"Virtual Network","x-ves-displayorder":"1,2,10","x-ves-oneof-field-v6_vip_choice":"[\"default_v6_vip\",\"specific_v6_vip\"]","x-ves-oneof-field-vip_choice":"[\"default_vip\",\"specific_vip\"]","x-ves-proto-message":"ves.io.schema.views.WhereVirtualNetwork","properties":{"default_v6_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"specific_v6_vip":{"type":"string","description":"Exclusive with [default_v6_vip]\n Use given IPV6 address as VIP on virtual Network\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Specific V6 VIP","x-displayname":"Specific V6 VIP","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"specific_vip":{"type":"string","description":"Exclusive with [default_vip]\n Use given IPV4 address as VIP on virtual Network\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Specific VIP","x-displayname":"Specific V4 VIP","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"virtual_network":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereVirtualSiteSegment":{"type":"object","description":"x-displayName: \"Virtual Site\"\nThis defines a reference to a customer site virtual site along with network type where a load balancer could be advertised","title":"WhereVirtualSiteSegment","properties":{"ip":{"type":"string","description":"x-displayName: \"IP Address\"\nx-required\nx-example: \"8.8.8.8\"\nUse given IP address as VIP on the site","title":"IP address on the site"},"ipv6":{"type":"string","description":"x-displayName: \"IPv6 Address\"\nx-example: \"2001::1\"\nUse given IPv6 address as VIP on the site","title":"IPv6 address on the site"},"segment":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"viewsWhereVirtualSiteSpecifiedVIP":{"type":"object","description":"This defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised","title":"WhereVirtualSiteSpecifiedVIP","x-displayname":"Virtual Site with Specified VIP","x-ves-proto-message":"ves.io.schema.views.WhereVirtualSiteSpecifiedVIP","properties":{"ip":{"type":"string","description":" Use given IP address as VIP on the site\n\nExample: ` \"8.8.8.8\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IP address on the site","x-displayname":"IP Address","x-ves-example":"8.8.8.8","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"network":{"$ref":"#/components/schemas/viewsSiteNetworkSpecifiedVIP"},"virtual_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}}}}}