@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.nfv_service","description":"NFV Service manages the lifecycle  of the NFV appliance, which includes the functionalities like health checks, restarts, dynamic\naddition and deletion of NFV instances for auto scaling, defining the policies that steers the packets to NFV etc. The service is\ndefined as two different types Forwarding Service and Endpoint Service.\nForwarding Service receives the original packet as is using the help of Policies or Traffic Selectors and forwards the packets to\noriginal destination wihtout modifying its L3/L4 headers\nEndpoint Service packets are destined to NFV and the destination of the packets is modified to a new destination","version":""},"paths":{"/api/config/namespaces/system/nfv_service/{name}/force-delete":{"post":{"summary":"Force Delete NFV Service","description":"Force Delete NFV Service","operationId":"ves.io.schema.nfv_service.CustomAPI.ForceDeleteNFVService","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceForceDeleteNFVServiceResponse"}}}},"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":"name","description":"Name\n\nx-example: \"nfv-service-1\"\nName of the NFV object to be force deleted","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceForceDeleteNFVServiceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-customapi-forcedeletenfvservice"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.CustomAPI.ForceDeleteNFVService"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/nfv_services":{"post":{"summary":"Create NFV Service","description":"Creates a new NFV service with configured parameters","operationId":"ves.io.schema.nfv_service.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-api-create"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.API.Create"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/nfv_services/{metadata.name}":{"put":{"summary":"Replace NFV Service","description":"Replaces configured NFV Service with new set of parameters","operationId":"ves.io.schema.nfv_service.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-api-replace"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.API.Replace"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/nfv_services":{"get":{"summary":"List NFV Service","description":"List the set of nfv_service in a namespace","operationId":"ves.io.schema.nfv_service.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_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 nfv_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-nfv_service-api-list"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.API.List"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data/namespaces/{namespace}/nfv_services/metrics":{"post":{"summary":"Metrics","description":"Nfv Service metrics","operationId":"ves.io.schema.nfv_service.CustomDataAPI.Metrics","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceMetricsResponse"}}}},"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: \"system\"\nOnly `system` namespace is supported.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceMetricsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-customdataapi-metrics"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.CustomDataAPI.Metrics"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/nfv_services/{name}":{"get":{"summary":"Get NFV Service","description":"Gets NFV Service parameters","operationId":"ves.io.schema.nfv_service.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_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 CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-api-get"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.API.Get"},"delete":{"summary":"Delete NFV Service","description":"Delete the specified nfv_service","operationId":"ves.io.schema.nfv_service.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nfv_serviceDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-nfv_service-api-delete"},"x-ves-proto-rpc":"ves.io.schema.nfv_service.API.Delete"},"x-displayname":"NFV Service","x-ves-proto-service":"ves.io.schema.nfv_service.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"NFV Service","x-ves-proto-package":"ves.io.schema.nfv_service","components":{"schemas":{"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"}}},"k8s_manifest_paramsDeployStatus":{"type":"string","title":"- RUNNING: x-displayName: \"Running\"\n - STOPPED: x-displayName: \"Stopped\"\n - PROVISIONING: x-displayName: \"Provisioning\"\n - STARTING: x-displayName: \"Starting\"\n - PAUSED: x-displayName: \"Paused\"\n - STOPPING: x-displayName: \"Stopping\"\n - TERMINATING: x-displayName: \"Terminating\"\n - CRASHLOOP_BACKOFF: x-displayName: \"Crash Loop Back Off\"\n - MIGRATING: x-displayName: \"Migrating\"\n - UNKNOWN: x-displayName: \"Unknown\"\n - ERROR_RUN_SCHEDULABLE: x-displayName: \"Error Run Schedulable\"\n - ERR_IMAGE_PULL: x-displayName: \"Error Image Pull\"\n - IMAGE_PULL_BACKOFF: x-displayName: \"Image Pull BackOff\"\n - ERROR_PVC_NOTFOUND: x-displayName: \"Error PVC Not Found\"\n - DATA_VOLUME_ERROR: x-displayName: \"Data Volume Error\"\n - WAITING_FOR_VOLUME_BINDING: x-displayName: \"Waiting For Volume Binding\"\n - ERROR_UNSCHEDULABLE: x-displayName: \"Error Unschedulable\"\n - TIMEDOUT: x-displayName: \"Timed Out\"","enum":["RUNNING","STOPPED","PROVISIONING","STARTING","PAUSED","STOPPING","TERMINATING","CRASHLOOP_BACKOFF","MIGRATING","UNKNOWN","ERROR_RUN_SCHEDULABLE","ERR_IMAGE_PULL","IMAGE_PULL_BACKOFF","ERROR_PVC_NOTFOUND","DATA_VOLUME_ERROR","WAITING_FOR_VOLUME_BINDING","ERROR_UNSCHEDULABLE","TIMEDOUT"],"default":"RUNNING","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.k8s_manifest_params.DeployStatus"},"nfv_serviceCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of nfv_service","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.nfv_service.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemanfv_serviceCreateSpecType"}}},"nfv_serviceCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.nfv_service.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemanfv_serviceGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"nfv_serviceDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a nfv_service","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.nfv_service.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"nfv_serviceEndpointServiceReplaceType":{"type":"object","description":"Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with\na new destination address","title":"ReplaceEndpoint Service","x-displayname":"Replace Endpoint Service","x-ves-oneof-field-external_vip_choice":"[\"advertise_on_slo_ip\",\"advertise_on_slo_ip_external\",\"disable_advertise_on_slo_ip\"]","x-ves-oneof-field-tcp_port_choice":"[\"custom_tcp_ports\",\"default_tcp_ports\",\"http_port\",\"https_port\",\"no_tcp_ports\"]","x-ves-oneof-field-udp_port_choice":"[\"custom_udp_ports\",\"no_udp_ports\"]","x-ves-proto-message":"ves.io.schema.nfv_service.EndpointServiceReplaceType","properties":{"advertise_on_slo_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"advertise_on_slo_ip_external":{"$ref":"#/components/schemas/ioschemaEmpty"},"custom_tcp_ports":{"$ref":"#/components/schemas/schemaPortRangesType"},"custom_udp_ports":{"$ref":"#/components/schemas/schemaPortRangesType"},"default_tcp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_advertise_on_slo_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"https_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_tcp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_udp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"nfv_serviceEndpointServiceType":{"type":"object","description":"Endpoint Service is a type of NFV service where the packets are destined to NFV and service modifies the destination with\na new destination address","title":"Endpoint Service","x-displayname":"Endpoint Service","x-ves-oneof-field-external_vip_choice":"[\"advertise_on_slo_ip\",\"advertise_on_slo_ip_external\",\"disable_advertise_on_slo_ip\"]","x-ves-oneof-field-inside_vip_choice":"[\"automatic_vip\",\"configured_vip\"]","x-ves-oneof-field-tcp_port_choice":"[\"custom_tcp_ports\",\"default_tcp_ports\",\"http_port\",\"https_port\",\"no_tcp_ports\"]","x-ves-oneof-field-udp_port_choice":"[\"custom_udp_ports\",\"no_udp_ports\"]","x-ves-proto-message":"ves.io.schema.nfv_service.EndpointServiceType","properties":{"advertise_on_slo_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"advertise_on_slo_ip_external":{"$ref":"#/components/schemas/ioschemaEmpty"},"automatic_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"configured_vip":{"type":"string","description":"Exclusive with [automatic_vip]\n Enter IP address for the default VIP\n\nExample: ` \"10.1.2.6/32\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n  ves.io.schema.rules.string.not_in: 0.0.0.0\n","title":"Configured","x-displayname":"Configured VIP","x-ves-example":"10.1.2.6/32","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true","ves.io.schema.rules.string.not_in":"0.0.0.0"}},"custom_tcp_ports":{"$ref":"#/components/schemas/schemaPortRangesType"},"custom_udp_ports":{"$ref":"#/components/schemas/schemaPortRangesType"},"default_tcp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_advertise_on_slo_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"https_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_tcp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_udp_ports":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"nfv_serviceF5BigIpAWSBYOLImageType":{"type":"object","description":"x-displayName: \"BIG-IP AWS BYOL Image\"\nBIG-IP AWS VPC site specification","title":"BIG-IP AWS BYOL Image","properties":{"image":{"type":"string","description":"x-displayName: \"BIG-IP AWS Image\"\nx-required\nx-example: \"image1\"\nSelect the BIG-IP pay as you go image to be used for this service","title":"BIG-IP AWS Image"},"license":{"$ref":"#/components/schemas/schemaSecretType"}}},"nfv_serviceF5BigIpAWSMarketPlaceImageType":{"type":"object","description":"BIG-IP AWS Pay as You Go Image Selection","title":"BIG-IP AWS PayG Image","x-displayname":"BIG-IP AWS Pay as You Go Image","x-ves-oneof-field-ami_choice":"[\"AWAFPayG200Mbps\",\"AWAFPayG3Gbps\",\"BestPlusPayG200Mbps\",\"best_plus_payg_1gbps\"]","x-ves-proto-message":"ves.io.schema.nfv_service.F5BigIpAWSMarketPlaceImageType","properties":{"AWAFPayG200Mbps":{"$ref":"#/components/schemas/ioschemaEmpty"},"AWAFPayG3Gbps":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"nfv_serviceF5BigIpAWSReplaceType":{"type":"object","description":"Virtual BIG-IP specification for AWS","title":"Virtual BIG-IP AWS","x-displayname":"Virtual BIG-IP AWS","x-ves-proto-message":"ves.io.schema.nfv_service.F5BigIpAWSReplaceType","properties":{"endpoint_service":{"$ref":"#/components/schemas/nfv_serviceEndpointServiceReplaceType"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 127\n  ves.io.schema.rules.map.max_pairs: 40\n  ves.io.schema.rules.map.values.string.max_len: 255\n","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}}}},"nfv_serviceF5BigIpAWSTGWSiteType":{"type":"object","description":"BIG-IP AWS TGW site specification","title":"BIG-IP AWS TGW Site","x-displayname":"BIG-IP AWS TGW Site","x-ves-proto-message":"ves.io.schema.nfv_service.F5BigIpAWSTGWSiteType","properties":{"aws_tgw_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"nfv_serviceF5BigIpAWSType":{"type":"object","description":"Virtual BIG-IP specification for AWS","title":"Virtual BIG-IP AWS","x-displayname":"Virtual BIG-IP AWS","x-ves-oneof-field-image_choice":"[\"market_place_image\"]","x-ves-oneof-field-site_type_choice":"[\"aws_tgw_site_params\"]","x-ves-proto-message":"ves.io.schema.nfv_service.F5BigIpAWSType","properties":{"admin_password":{"$ref":"#/components/schemas/schemaSecretType"},"admin_username":{"type":"string","description":" Admin Username for BIG-IP\n\nExample: ` \"admin\"`\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":"Admin Username","maxLength":256,"x-displayname":"Admin Username","x-ves-example":"admin","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"aws_tgw_site_params":{"$ref":"#/components/schemas/nfv_serviceF5BigIpAWSTGWSiteType"},"endpoint_service":{"$ref":"#/components/schemas/nfv_serviceEndpointServiceType"},"market_place_image":{"$ref":"#/components/schemas/nfv_serviceF5BigIpAWSMarketPlaceImageType"},"nodes":{"type":"array","description":" Specify how and where the service nodes are spawned\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 2\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Service Nodes","minItems":1,"maxItems":2,"items":{"$ref":"#/components/schemas/nfv_serviceServiceNodesAWSType"},"x-displayname":"Service Nodes","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"2","ves.io.schema.rules.repeated.min_items":"1"}},"ssh_key":{"type":"string","description":" Public SSH key for accessing the Big IP nodes.\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 8192\n  ves.io.schema.rules.string.min_len: 1\n","title":"Public SSH key","minLength":1,"maxLength":8192,"x-displayname":"Public SSH key","x-ves-example":"ssh-rsa AAAAB...","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"8192","ves.io.schema.rules.string.min_len":"1"}},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 127\n  ves.io.schema.rules.map.max_pairs: 40\n  ves.io.schema.rules.map.values.string.max_len: 255\n","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}}}},"nfv_serviceF5BigIpAWSVPCSiteType":{"type":"object","description":"x-displayName: \"BIG-IP AWS VPC Site\"\nBIG-IP AWS VPC site specification","title":"BIG-IP AWS VPC Site","properties":{"aws_vpc_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"nfv_serviceForceDeleteNFVServiceRequest":{"type":"object","description":"Force Delete NFV Service Request","title":"ForceDeleteNFVServiceRequest","x-displayname":"Force Delete NFV Service Request","x-ves-proto-message":"ves.io.schema.nfv_service.ForceDeleteNFVServiceRequest","properties":{"name":{"type":"string","description":" Name of the NFV object to be force deleted\n\nExample: ` \"nfv-service-1\"`","title":"Name","x-displayname":"Name","x-ves-example":"nfv-service-1"}}},"nfv_serviceForceDeleteNFVServiceResponse":{"type":"object","description":"Force Delete NFV Service Response","title":"ForceDeleteNFVServiceResponse","x-displayname":"Force Delete NFV Service Response","x-ves-proto-message":"ves.io.schema.nfv_service.ForceDeleteNFVServiceResponse"},"nfv_serviceForwardingServiceType":{"type":"object","description":"Forwarding Service is a type of NFV service that processes the original packet as received from source and forwards it to the original\ndestination without modifying the destination addresses. The traffic is attracted to NFV using set of traffic selector\nrules.","title":"Forwarding Service","x-displayname":"Forwarding Service","x-ves-proto-message":"ves.io.schema.nfv_service.ForwardingServiceType"},"nfv_serviceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read nfv_service","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.nfv_service.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/nfv_serviceCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/nfv_serviceReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemanfv_serviceGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/nfv_serviceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"nfv_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_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"nfv_serviceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of nfv_service","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.nfv_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/nfv_serviceListResponseItem"},"x-displayname":"Items"}}},"nfv_serviceListResponseItem":{"type":"object","description":"By default a summary of nfv_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 nfv_service","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.nfv_service.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this nfv_service","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this nfv_service","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates nfv_service is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemanfv_serviceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this nfv_service","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this nfv_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/nfv_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 nfv_service\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"nfv_serviceMetricData":{"type":"object","description":"Metric data contains the metric type and the corresponding metric value","title":"Metric Data","x-displayname":"Metric Data","x-ves-proto-message":"ves.io.schema.nfv_service.MetricData","properties":{"data":{"type":"array","description":" List of metric data","title":"Data","items":{"$ref":"#/components/schemas/schemanfv_serviceMetricTypeData"},"x-displayname":"Data"},"type":{"$ref":"#/components/schemas/schemanfv_serviceMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"}}},"nfv_serviceMetricLabel":{"type":"string","description":"Labels in Nfv Service Metrics\n","title":"Metric Label","enum":["SITE","SERVICE","SERVICE_INSTANCE","SERVICE_INSTANCE_HOSTNAME"],"default":"SITE","x-displayname":"Metric Label","x-ves-proto-enum":"ves.io.schema.nfv_service.MetricLabel"},"nfv_serviceMetricsRequest":{"type":"object","description":"Request to get the metrics for Nfv services","title":"Metrics Request","x-displayname":"Metrics Request","x-ves-proto-message":"ves.io.schema.nfv_service.MetricsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"type":"array","description":" Select fields to be returned in the response.\n One or more fields in {TX_THROUGHPUT_BYTES, CONNECTION_RATE, TX_THROUGHPUT_PACKETS, RX_THROUGHPUT_BYTES, RX_THROUGHPUT_PACKETS} can be specified.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Selector","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/schemanfv_serviceMetricType"},"x-displayname":"Field Selector","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"filter":{"type":"string","description":" filter is used to specify the list of matchers\n syntax for filter := {[<matcher>]}\n <matcher> := <label><operator>\"<value>\"\n   <label> := string\n     One or more labels defined in MetricLabel {SITE, SERVICE, SERVICE_INSTANCE} can be specified in the filter.\n   <value> := string\n   <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n     =  : equal to\n     != : not equal to\n     =~ : regex match\n     !~ : not regex match\n\n Optional: If not specified, metric will be aggregated based on the group_by labels.\n\nExample: ` \"{HOSTNAME=\\\"WAF-1\\\"}\"`","title":"Label Filter","x-displayname":"Filter","x-ves-example":"{HOSTNAME=\\\"WAF-1\\\"}"},"group_by":{"type":"array","description":" Aggregate data by zero or more labels {SITE, SERVICE, SERVICE_INSTANCE}","title":"Group by","items":{"$ref":"#/components/schemas/nfv_serviceMetricLabel"},"x-displayname":"Group By"},"namespace":{"type":"string","description":" Only `system` namespace is supported.\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"start_time":{"type":"string","description":"\n start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"nfv_serviceMetricsResponse":{"type":"object","description":"Metrics for NFV Services","title":"Metrics Response","x-displayname":"Metrics Response","x-ves-proto-message":"ves.io.schema.nfv_service.MetricsResponse","properties":{"data":{"type":"array","description":" Data contains time-series metric data for Nfv services","title":"Data","items":{"$ref":"#/components/schemas/nfv_serviceMetricData"},"x-displayname":"Data"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"nfv_serviceNodeInfo":{"type":"object","description":"Per Node Information, populated after NFV instances are deployed","title":"Per Node Information","x-displayname":"Per Node Information","x-ves-proto-message":"ves.io.schema.nfv_service.NodeInfo","properties":{"node_name":{"type":"string","description":" The name of the Node which corresponds to the ssh command","title":"Node Name","x-displayname":"Node Name"},"ssh_command":{"type":"string","description":" Example ssh command string for users to ssh into individual node","title":"SSH Command","x-displayname":"SSH Command Help String"}}},"nfv_servicePANAWSAutoSetupType":{"type":"object","description":"For auto-setup, ssh public and pvt keys are needed.\nUsing the given config user, ssh and api access will be configured","title":"PAN VM Series Firewall Auto Setup","x-displayname":"PAN VM Series Firewall Auto Setup","x-ves-oneof-field-ssh_keys_choice":"[\"manual_ssh_keys\"]","x-ves-proto-message":"ves.io.schema.nfv_service.PANAWSAutoSetupType","properties":{"admin_password":{"$ref":"#/components/schemas/schemaSecretType"},"admin_username":{"type":"string","description":" Firewall Admin Username\n\nExample: ` \"admin\"`\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":"Firewall Admin Username","maxLength":256,"x-displayname":"Firewall Admin Username","x-ves-example":"admin","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"manual_ssh_keys":{"$ref":"#/components/schemas/nfv_serviceSSHKeyType"}}},"nfv_servicePaloAltoAzNodesAWSType":{"type":"object","title":"Palo Alto Networks Vm-Series AZ Nodes","x-displayname":"Palo Alto Networks Vm-Series AZ Nodes","x-ves-proto-message":"ves.io.schema.nfv_service.PaloAltoAzNodesAWSType","properties":{"nodes":{"type":"array","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 2\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Palo Alto Networks AZ Nodes","minItems":1,"maxItems":2,"items":{"$ref":"#/components/schemas/nfv_servicePaloAltoServiceNodesAWSType"},"x-displayname":"Palo Alto Networks AZ Nodes","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"2","ves.io.schema.rules.repeated.min_items":"1"}}}},"nfv_servicePaloAltoFWAWSInstanceType":{"type":"string","description":"\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_XLARGE: m4.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_2XLARGE: m4.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_4XLARGE: m4.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_LARGE: m5.large\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_XLARGE: m5.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_2XLARGE: m5.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_4XLARGE: m5.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_12XLARGE: m5.12xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_LARGE: m5n.large\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_XLARGE: m5n.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_2XLARGE: m5n.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_4XLARGE: m5n.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_LARGE: c4.large\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_XLARGE: c4.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_2XLARGE: c4.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_4XLARGE: c4.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_8XLARGE: c4.8xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_LARGE: c5.large\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_XLARGE: c5.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_2XLARGE: c5.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_4XLARGE: c5.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_9XLARGE: c5.9xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_18XLARGE: c5.18xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_LARGE: c5n.large\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_XLARGE: c5n.xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_2XLARGE: c5n.2xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_4XLARGE: c5n.4xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_9XLARGE: c5n.9xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_18XLARGE: c5n.18xlarge\n\n - PALO_ALTO_FW_AWS_INSTANCE_TYPE_R5_2XLARGE: r5.2xlarge\n","title":"Palo Alto Networks VM-Series Instance Type","enum":["PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_LARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5_12XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_LARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_M5N_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_LARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C4_8XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_LARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_9XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5_18XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_LARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_2XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_4XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_9XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_C5N_18XLARGE","PALO_ALTO_FW_AWS_INSTANCE_TYPE_R5_2XLARGE"],"default":"PALO_ALTO_FW_AWS_INSTANCE_TYPE_M4_XLARGE","x-displayname":"Palo Alto Networks VM-Series Instance Typ","x-ves-proto-enum":"ves.io.schema.nfv_service.PaloAltoFWAWSInstanceType"},"nfv_servicePaloAltoFWAWSReplaceType":{"type":"object","description":"Virtual PaloAlto Firewall specification","title":"Virtual PaloAlto Firewall","x-displayname":"Virtual PaloAlto Firewall","x-ves-proto-message":"ves.io.schema.nfv_service.PaloAltoFWAWSReplaceType","properties":{"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 127\n  ves.io.schema.rules.map.max_pairs: 40\n  ves.io.schema.rules.map.values.string.max_len: 255\n","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}}}},"nfv_servicePaloAltoFWAWSType":{"type":"object","description":"Palo Alto Networks VM-Series next-generation firewall configuration","title":"Palo Alto Networks VM-Series Firewall","x-displayname":"Palo Alto Networks VM-Series Firewall","x-ves-oneof-field-ami_choice":"[\"pan_ami_bundle1\",\"pan_ami_bundle2\"]","x-ves-oneof-field-panaroma_connection":"[\"disable_panaroma\",\"panorama_server\"]","x-ves-oneof-field-setup_options":"[\"auto_setup\",\"ssh_key\"]","x-ves-proto-message":"ves.io.schema.nfv_service.PaloAltoFWAWSType","properties":{"auto_setup":{"$ref":"#/components/schemas/nfv_servicePANAWSAutoSetupType"},"aws_tgw_site":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"disable_panaroma":{"$ref":"#/components/schemas/ioschemaEmpty"},"instance_type":{"$ref":"#/components/schemas/nfv_servicePaloAltoFWAWSInstanceType"},"pan_ami_bundle1":{"$ref":"#/components/schemas/ioschemaEmpty"},"pan_ami_bundle2":{"$ref":"#/components/schemas/ioschemaEmpty"},"panorama_server":{"$ref":"#/components/schemas/nfv_servicePanoramaServerType"},"service_nodes":{"$ref":"#/components/schemas/nfv_servicePaloAltoAzNodesAWSType"},"ssh_key":{"type":"string","description":"Exclusive with [auto_setup]\n Setup Authorized Public SSH key. User will be able to ssh to the vmseries nodes using\n its corresponding ssh private key.\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8192\n  ves.io.schema.rules.string.min_len: 1\n","title":"Setup Authorized Public SSH key","minLength":1,"maxLength":8192,"x-displayname":"Setup Authorized Public SSH key","x-ves-example":"ssh-rsa AAAAB...","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8192","ves.io.schema.rules.string.min_len":"1"}},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 127\n  ves.io.schema.rules.map.max_pairs: 40\n  ves.io.schema.rules.map.values.string.max_len: 255\n","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"127","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"255"}},"version":{"type":"string","description":" PAN-OS version\n\nExample: ` \"11.0.0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"11.0.0\\\"]\n","title":"PAN VM-Series version","x-displayname":"PAN VM-Series version","x-ves-example":"11.0.0","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"11.0.0\\\"]"}}}},"nfv_servicePaloAltoServiceNodesAWSType":{"type":"object","description":"Specification for service nodes, how and where","title":"Service Nodes","x-displayname":"Service Nodes","x-ves-oneof-field-mgmt_subnet_choice":"[\"mgmt_subnet\",\"reserved_mgmt_subnet\"]","x-ves-proto-message":"ves.io.schema.nfv_service.PaloAltoServiceNodesAWSType","properties":{"aws_az_name":{"type":"string","description":" AWS availability zone, must be consistent with the selected AWS region. It is recommended that AZ is one of the AZ for sites\n\nExample: ` \"us-west-2a\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$\n","title":"AWS AZ","x-displayname":"AWS AZ Name","x-ves-example":"us-west-2a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$"}},"mgmt_subnet":{"$ref":"#/components/schemas/viewsCloudSubnetType"},"node_name":{"type":"string","description":" Node Name will be used to assign as hostname to the service\n\nExample: ` \"node1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node Name","minLength":1,"maxLength":256,"x-displayname":"Node Name","x-ves-example":"node1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}},"reserved_mgmt_subnet":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"nfv_servicePanoramaServerType":{"type":"object","description":"Panorama Server Type","title":"Panorama server type","x-displayname":"Panorama Server Type","x-ves-proto-message":"ves.io.schema.nfv_service.PanoramaServerType","properties":{"authorization_key":{"$ref":"#/components/schemas/schemaSecretType"},"device_group_name":{"type":"string","description":" Device Group Name\n\nExample: ` \"group1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"Device Group Name","maxLength":128,"x-displayname":"Device Group Name","x-ves-example":"group1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"server":{"type":"string","description":" Panorama Server Address to which the firewall should connect to\n\nExample: ` \"1.1.1.1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ip: true\n","title":"Server Ipv4 Address","x-displayname":"Server Ipv4 Address","x-ves-example":"1.1.1.1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ip":"true"}},"template_stack_name":{"type":"string","description":" Template Stack Name\n\nExample: ` \"template1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"Template Stack Name","maxLength":128,"x-displayname":"template stack name","x-ves-example":"template1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}}}},"nfv_serviceReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a nfv_service","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.nfv_service.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemanfv_serviceReplaceSpecType"}}},"nfv_serviceReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.nfv_service.ReplaceResponse"},"nfv_serviceSSHKeyType":{"type":"object","description":"SSH Key includes both public and private key","title":"SSH key","x-displayname":"SSH key","x-ves-proto-message":"ves.io.schema.nfv_service.SSHKeyType","properties":{"private_key":{"$ref":"#/components/schemas/schemaSecretType"},"public_key":{"type":"string","description":" Authorized Public SSH key which will be programmed on the node\n\nExample: ` \"ssh-rsa AAAAB...\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 8192\n  ves.io.schema.rules.string.min_len: 1\n","title":"Public SSH key","minLength":1,"maxLength":8192,"x-displayname":"Public SSH key","x-ves-example":"ssh-rsa AAAAB...","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"8192","ves.io.schema.rules.string.min_len":"1"}}}},"nfv_serviceSSHManagementNodePorts":{"type":"object","description":"TCP Port configuration per node","title":"SSHManagement Port Configuration","x-displayname":"Management Node SSH Port","x-ves-proto-message":"ves.io.schema.nfv_service.SSHManagementNodePorts","properties":{"node_name":{"type":"string","description":" Node name will be used to match a particular node with the desired TCP port\n\nExample: ` \"node1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node Name","minLength":1,"maxLength":256,"x-displayname":"Node Name","x-ves-example":"node1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}},"ssh_port":{"type":"integer","description":" Enter TCP port per node\n\nExample: ` \"2222\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1024\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"SSH port per node","format":"int64","x-displayname":"SSH Port","x-ves-example":"2222","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1024","ves.io.schema.rules.uint32.lte":"65535"}}}},"nfv_serviceSSHManagementType":{"type":"object","description":"SSH based configuration","title":"SSH based management","x-displayname":"SSH based management","x-ves-oneof-field-advertise_choice":"[\"advertise_on_sli\",\"advertise_on_slo\",\"advertise_on_slo_sli\"]","x-ves-proto-message":"ves.io.schema.nfv_service.SSHManagementType","properties":{"advertise_on_sli":{"$ref":"#/components/schemas/ioschemaEmpty"},"advertise_on_slo":{"$ref":"#/components/schemas/ioschemaEmpty"},"advertise_on_slo_sli":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain_suffix":{"type":"string","description":" Domain suffix will be used along with node name to form the hostname for ssh node management\n\nExample: ` \"foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostname: true\n","title":"Domain Suffix","x-displayname":"Domain Suffix","x-ves-example":"foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true"}},"node_ssh_ports":{"type":"array","description":" Enter TCP port and node name per node\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 2\n","title":"List of SSH port and node name per node","maxItems":2,"items":{"$ref":"#/components/schemas/nfv_serviceSSHManagementNodePorts"},"x-displayname":"Management Node SSH Port","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"2"}}}},"nfv_serviceServiceHttpsManagementType":{"type":"object","description":"HTTPS based configuration","title":"HTTPS based management","x-displayname":"HTTPS based management","x-ves-oneof-field-advertise_choice":"[\"advertise_on_internet\",\"advertise_on_internet_default_vip\",\"advertise_on_sli_vip\",\"advertise_on_slo_internet_vip\",\"advertise_on_slo_sli\",\"advertise_on_slo_vip\"]","x-ves-oneof-field-internet_choice":"[]","x-ves-oneof-field-port_choice":"[\"default_https_port\",\"https_port\"]","x-ves-proto-message":"ves.io.schema.nfv_service.ServiceHttpsManagementType","properties":{"advertise_on_internet":{"$ref":"#/components/schemas/viewsAdvertisePublic"},"advertise_on_internet_default_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"advertise_on_sli_vip":{"$ref":"#/components/schemas/viewsDownstreamTlsParamsType"},"advertise_on_slo_internet_vip":{"$ref":"#/components/schemas/viewsDownstreamTlsParamsType"},"advertise_on_slo_sli":{"$ref":"#/components/schemas/viewsDownstreamTlsParamsType"},"advertise_on_slo_vip":{"$ref":"#/components/schemas/viewsDownstreamTlsParamsType"},"default_https_port":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain_suffix":{"type":"string","description":" Domain suffix will be used along with node name to form URL to access node management\n\nExample: ` \"foo.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostname: true\n","title":"Domain Suffix","x-displayname":"Domain Suffix","x-ves-example":"foo.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true"}},"https_port":{"type":"integer","description":"Exclusive with [default_https_port]\n Enter TCP port number\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"HTTPS port","format":"int64","x-displayname":"HTTPS Port","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}}}},"nfv_serviceServiceNodesAWSType":{"type":"object","description":"Specification for service nodes, how and where","title":"Service Nodes","x-displayname":"Service Nodes","x-ves-oneof-field-mgmt_subnet_choice":"[\"mgmt_subnet\",\"reserved_mgmt_subnet\"]","x-ves-oneof-field-tunnel_prefix_choice":"[\"automatic_prefix\",\"tunnel_prefix\"]","x-ves-proto-message":"ves.io.schema.nfv_service.ServiceNodesAWSType","properties":{"automatic_prefix":{"$ref":"#/components/schemas/ioschemaEmpty"},"aws_az_name":{"type":"string","description":" The AWS Availability Zone must be consistent with the AWS Region chosen. Please select an AZ in the same Region as your TGW Site\n\nExample: ` \"us-west-2a\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$\n","title":"AWS AZ","x-displayname":"AWS AZ Name","x-ves-example":"us-west-2a","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^([a-z]{2})-([a-z0-9]{4,20})-([a-z0-9]{2})$"}},"mgmt_subnet":{"$ref":"#/components/schemas/viewsCloudSubnetType"},"node_name":{"type":"string","description":" Node Name will be used to assign as hostname to the service\n\nExample: ` \"node1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node Name","minLength":1,"maxLength":256,"x-displayname":"Node Name","x-ves-example":"node1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}},"reserved_mgmt_subnet":{"$ref":"#/components/schemas/ioschemaEmpty"},"tunnel_prefix":{"type":"string","description":"Exclusive with [automatic_prefix]\n Enter IP prefix for the tunnel, it has to be /30\n\nExample: ` \"10.1.2.4/30\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4_prefix: true\n","title":"Tunnel IP Prefix","x-displayname":"Tunnel IP Prefix","x-ves-example":"10.1.2.4/30","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4_prefix":"true"}}}},"nfv_serviceStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Status for NFV Service","x-displayname":"Status","x-ves-displayorder":"1,3,4,5,8,7,9","x-ves-proto-message":"ves.io.schema.nfv_service.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"deployment_status":{"$ref":"#/components/schemas/terraform_parametersApplyStatus"},"external_cname":{"type":"string","description":" External CNAME","title":"External CNAME","x-displayname":"External CNAME"},"k8s_deployment_status_type":{"$ref":"#/components/schemas/viewsk8s_manifest_paramsDeploymentStatusType"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Reference to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"software_version":{"type":"string","description":" Software version","title":"Software version","x-displayname":"Software Version"},"vip":{"type":"string","description":" VIP","title":"VIP","x-displayname":"VIP"}}},"nfv_serviceSuggestedCommands":{"type":"object","description":"x-displayName: \"Suggested Commands for External Service\"\nList of commands which users can execute on the local external service. This is valid only for PAN VmSeries Firewall","title":"Suggested Commands for External Service","properties":{"command":{"type":"string","description":"x-displayName: \"Example command\"\nExample command. Which user can run it locally on the external service","title":"Example command"},"description":{"type":"string","description":"x-displayName: \"Description of the command\"\nDescription of the command, which explains in details on how it can be used based on the usecase.","title":"Description of the command"},"warning":{"type":"string","description":"x-displayName: \"Warning (if any)\"\nExample warning: It is imperative to ensure that all interfaces and sub-interfaces are properly configured and operational.","title":"Warning"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"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"}}},"schemaHashAlgorithm":{"type":"string","description":"Specifies the Hash Algorithm to be used\n\nInvalid hash algorithm\nsha256 hash algorithm\nsha1 hash algorithm","title":"HashAlgoritm","enum":["INVALID_HASH_ALGORITHM","SHA256","SHA1"],"default":"INVALID_HASH_ALGORITHM","x-displayname":"Hash Algorithm","x-ves-proto-enum":"ves.io.schema.HashAlgorithm"},"schemaHashAlgorithms":{"type":"object","description":"Specifies the hash algorithms to be used","title":"HashAlgorithms","x-displayname":"Hash Algorithms","x-ves-proto-message":"ves.io.schema.HashAlgorithms","properties":{"hash_algorithms":{"type":"array","description":" Ordered list of hash algorithms to be used.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Hash Algorithms","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/schemaHashAlgorithm"},"x-displayname":"Hash Algorithms","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"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"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaPortRangesType":{"type":"object","description":"List of port ranges","title":"Port Range List","x-displayname":"Port Range List","x-ves-proto-message":"ves.io.schema.PortRangesType","properties":{"ports":{"type":"array","description":" List of port ranges. Each range is a single port or a pair of start and end ports e.g. 8080-8192\n\nExample: ` \"100-200\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.port_range: true\n  ves.io.schema.rules.repeated.max_items: 128\n","title":"ports","maxItems":128,"items":{"type":"string"},"x-displayname":"Port Ranges","x-ves-example":"100-200","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.port_range":"true","ves.io.schema.rules.repeated.max_items":"128"}}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"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"}}},"schemaTlsCertificateType":{"type":"object","description":"Handle to fetch certificate and key","title":"TlsCertificateType","x-displayname":"TLS Certificate","x-ves-oneof-field-ocsp_stapling_choice":"[\"custom_hash_algorithms\",\"disable_ocsp_stapling\",\"use_system_defaults\"]","x-ves-proto-message":"ves.io.schema.TlsCertificateType","properties":{"certificate_url":{"type":"string","description":" TLS certificate.\n Certificate or certificate chain in PEM format including the PEM headers.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.certificate_url: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"certificate_url","minLength":1,"maxLength":131072,"x-displayname":"Certificate","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.certificate_url":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.min_bytes":"1"}},"custom_hash_algorithms":{"$ref":"#/components/schemas/schemaHashAlgorithms"},"description":{"type":"string","description":" Description for the certificate\n\nExample: ` \"Certificate used in production environment\"`","title":"description","x-displayname":"Description","x-ves-example":"Certificate used in production environment"},"disable_ocsp_stapling":{"$ref":"#/components/schemas/ioschemaEmpty"},"private_key":{"$ref":"#/components/schemas/schemaSecretType"},"use_system_defaults":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaTlsProtocol":{"type":"string","description":"TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.","title":"TlsProtocol","enum":["TLS_AUTO","TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"default":"TLS_AUTO","x-displayname":"TLS Protocol","x-ves-proto-enum":"ves.io.schema.TlsProtocol"},"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"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemaXfccElement":{"type":"string","description":"X-Forwarded-Client-Cert custom cookie elements\n\nThe entire client certificate in URL encoded PEM format.\nThe entire client certificate chain (including the leaf certificate) in URL encoded PEM format.\nThe Subject field of the current client certificate. The value is always double-quoted.\nThe URI type Subject Alternative Name field of the current client certificate.\nA client certificate may contain multiple URI type Subject Alternative Names,\neach will be a separate key-value pair.\nThe DNS type Subject Alternative Name field of the current client certificate.\nA client certificate may contain multiple DNS type Subject Alternative Names,\neach will be a separate key-value pair.","title":"XfccElement","enum":["XFCC_NONE","XFCC_CERT","XFCC_CHAIN","XFCC_SUBJECT","XFCC_URI","XFCC_DNS"],"default":"XFCC_NONE","x-displayname":"XFCC Elements","x-ves-proto-enum":"ves.io.schema.XfccElement"},"schemanfv_serviceCreateSpecType":{"type":"object","description":"Creates a new NFV service with configured parameters","title":"Create NFV Service","x-displayname":"Create NFV Service","x-ves-oneof-field-http_management_choice":"[\"disable_https_management\",\"https_management\"]","x-ves-oneof-field-service_provider_choice":"[\"f5_big_ip_aws_service\",\"palo_alto_fw_service\"]","x-ves-oneof-field-ssh_management_choice":"[\"disable_ssh_access\",\"enabled_ssh_access\"]","x-ves-proto-message":"ves.io.schema.nfv_service.CreateSpecType","properties":{"disable_https_management":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_ssh_access":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled_ssh_access":{"$ref":"#/components/schemas/nfv_serviceSSHManagementType"},"f5_big_ip_aws_service":{"$ref":"#/components/schemas/nfv_serviceF5BigIpAWSType"},"https_management":{"$ref":"#/components/schemas/nfv_serviceServiceHttpsManagementType"},"palo_alto_fw_service":{"$ref":"#/components/schemas/nfv_servicePaloAltoFWAWSType"}}},"schemanfv_serviceGetSpecType":{"type":"object","description":"Gets NFV Service parameters","title":"Get NFV Service","x-displayname":"Get NFV Service","x-ves-oneof-field-http_management_choice":"[\"disable_https_management\",\"https_management\"]","x-ves-oneof-field-service_provider_choice":"[\"f5_big_ip_aws_service\",\"palo_alto_fw_service\"]","x-ves-oneof-field-service_type_choice":"[\"endpoint_service\",\"forwarding_service\",\"transparent_service\"]","x-ves-oneof-field-ssh_management_choice":"[\"disable_ssh_access\",\"enabled_ssh_access\"]","x-ves-proto-message":"ves.io.schema.nfv_service.GetSpecType","properties":{"disable_https_management":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_ssh_access":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled_ssh_access":{"$ref":"#/components/schemas/nfv_serviceSSHManagementType"},"endpoint_service":{"$ref":"#/components/schemas/nfv_serviceEndpointServiceType"},"f5_big_ip_aws_service":{"$ref":"#/components/schemas/nfv_serviceF5BigIpAWSType"},"forwarding_service":{"$ref":"#/components/schemas/nfv_serviceForwardingServiceType"},"https_management":{"$ref":"#/components/schemas/nfv_serviceServiceHttpsManagementType"},"node_info":{"type":"array","description":" Node level information like, ssh command ex strings are populated here","items":{"$ref":"#/components/schemas/nfv_serviceNodeInfo"},"x-displayname":"Node Information"},"palo_alto_fw_service":{"$ref":"#/components/schemas/nfv_servicePaloAltoFWAWSType"},"transparent_service":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemanfv_serviceMetricType":{"type":"string","description":"List of metric types\n\nx-unit: \"Bps\"\nx-unit: \"Cps\"\nx-unit: \"pps\"\nx-unit: \"Bps\"\nx-unit: \"pps\"\nx-unit: \"percent\"\nx-unit: \"count\"\nx-unit: \"count\"\nx-unit: \"bytes\"\nx-unit: \"bytes\"\nx-unit: \"bytes\"\nx-unit: \"bytes\"\nx-unit: \"count\"\nx-unit: \"count\"\nx-unit: \"percentage\"","title":"Metric Type","enum":["TX_THROUGHPUT_BYTES","CONNECTION_RATE","TX_THROUGHPUT_PACKETS","RX_THROUGHPUT_BYTES","RX_THROUGHPUT_PACKETS","CPU_UTILIZATION","DISK_READ_OPS","DISK_WRITE_OPS","DISK_READ_BYTES","DISK_WRITE_BYTES","NETWORK_IN_BYTES","NETWORK_OUT_BYTES","NETWORK_IN_PACKETS","NETWORK_OUT_PACKETS","HEALTHSCORE"],"default":"TX_THROUGHPUT_BYTES","x-displayname":"Metric Type","x-ves-proto-enum":"ves.io.schema.nfv_service.MetricType"},"schemanfv_serviceMetricTypeData":{"type":"object","description":"Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.","title":"Metric Type Data","x-displayname":"Metric Type Data","x-ves-proto-message":"ves.io.schema.nfv_service.MetricTypeData","properties":{"key":{"type":"object","description":" Key contains the name/value pair.\n \"name\" is the label name defined in \"MetricLabel\"","title":"Key","x-displayname":"Key"},"value":{"type":"array","description":" List of metric values.","title":"Value","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Value"}}},"schemanfv_serviceReplaceSpecType":{"type":"object","description":"Replaces configured NFV Service with new set of parameters","title":"Replace NFV Service","x-displayname":"Replace NFV Service","x-ves-oneof-field-http_management_choice":"[\"disable_https_management\",\"https_management\"]","x-ves-oneof-field-service_provider_choice":"[\"f5_big_ip_aws_service\",\"palo_alto_fw_service\"]","x-ves-oneof-field-ssh_management_choice":"[\"disable_ssh_access\",\"enabled_ssh_access\"]","x-ves-proto-message":"ves.io.schema.nfv_service.ReplaceSpecType","properties":{"disable_https_management":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_ssh_access":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled_ssh_access":{"$ref":"#/components/schemas/nfv_serviceSSHManagementType"},"f5_big_ip_aws_service":{"$ref":"#/components/schemas/nfv_serviceF5BigIpAWSReplaceType"},"https_management":{"$ref":"#/components/schemas/nfv_serviceServiceHttpsManagementType"},"palo_alto_fw_service":{"$ref":"#/components/schemas/nfv_servicePaloAltoFWAWSReplaceType"}}},"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"}}}},"terraform_parametersApplyStageState":{"type":"string","title":"- APPLIED: x-displayName: \"Applied\"\n - APPLY_ERRORED: x-displayName: \"Apply errored\"\n - APPLY_INIT_ERRORED: x-displayName: \"Apply init errored\"\n - APPLYING: x-displayName: \"Applying\"\n - APPLY_PLANNING: x-displayName: \"Apply planning\"\n - APPLY_PLAN_ERRORED: x-displayName: \"Apply plan errored\"\n - APPLY_QUEUED: x-displayName: \"Apply queued\"","enum":["APPLIED","APPLY_ERRORED","APPLY_INIT_ERRORED","APPLYING","APPLY_PLANNING","APPLY_PLAN_ERRORED","APPLY_QUEUED"],"default":"APPLIED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.ApplyStageState"},"terraform_parametersApplyStatus":{"type":"object","x-ves-oneof-field-state":"[\"apply_state\",\"destroy_state\",\"infra_state\"]","x-ves-proto-message":"ves.io.schema.views.terraform_parameters.ApplyStatus","properties":{"apply_state":{"$ref":"#/components/schemas/terraform_parametersApplyStageState"},"container_version":{"type":"string","description":" Container image version","title":"container_version","x-displayname":"Container image version"},"destroy_state":{"$ref":"#/components/schemas/terraform_parametersDestroyStageState"},"error_output":{"type":"string","description":" Error output of terraform run\n\nExample: ` \"value\"`","title":"error_output","x-displayname":"Error Output","x-ves-example":"value"},"infra_state":{"$ref":"#/components/schemas/terraform_parametersInfraState"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this status was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"suggested_action","x-displayname":"Suggested Action","x-ves-example":"value"},"tf_output":{"type":"string","description":" The value of an \"output\" variable from the terraform state file.\n\nExample: ` \"value\"`","title":"tf_output","x-displayname":"Terraform Output","x-ves-example":"value"},"tf_stdout":{"type":"string","description":" The stdout of terraform apply command.","title":"tf_stdout","x-displayname":"Terraform Standard Output"}}},"terraform_parametersDestroyStageState":{"type":"string","title":"- DESTROYED: x-displayName: \"Destroyed\"\n - DESTROY_ERRORED: x-displayName: \"Destroy errored\"\n - DESTROYING: x-displayName: \"Destroying\"\n - DESTROY_QUEUED: x-displayName: \"Destroy Queued\"","enum":["DESTROYED","DESTROY_ERRORED","DESTROYING","DESTROY_QUEUED"],"default":"DESTROYED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.DestroyStageState"},"terraform_parametersInfraState":{"type":"string","title":"- PROVISIONED: x-displayName: \"Provisioned\"\n - TIMED_OUT: x-displayName: \"Timed out\"\n - ERRORED: x-displayName: \"Errored\"\n - PROVISIONING: x-displayName: \"Provisioning\"","enum":["PROVISIONED","TIMED_OUT","ERRORED","PROVISIONING"],"default":"PROVISIONED","x-displayname":"","x-ves-proto-enum":"ves.io.schema.views.terraform_parameters.InfraState"},"terraform_parametersRollbackState":{"type":"string","title":"- ROLLBACK_SUCCESSFUL: x-displayName: \"Rollback successful\"\n - ROLLBACK_ERRORED: x-displayName: \"Rollback errored\"\n - ROLLBACK_NOT_REQUIRED: x-displayName: \"Rollback not required\"","enum":["ROLLBACK_SUCCESSFUL","ROLLBACK_ERRORED","ROLLBACK_NOT_REQUIRED"],"default":"ROLLBACK_SUCCESSFUL"},"terraform_parametersUpgradeState":{"type":"string","description":"x-displayName: \"Upgrade State\"\nTerraform State after version Upgrade\n\n - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\"\n - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\"\n - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\"","title":"Upgrade State","enum":["UPGRADE_SUCCESSFUL","UPGRADE_ERRORED","UPGRADE_NOT_REQUIRED"],"default":"UPGRADE_SUCCESSFUL"},"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"}}},"viewsCloudSubnetParamType":{"type":"object","description":"Parameters for creating a new cloud subnet","title":"Cloud Subnet Param","x-displayname":"New Cloud Subnet Parameters","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.views.CloudSubnetParamType","properties":{"ipv4":{"type":"string","description":" IPv4 subnet prefix for this subnet\n\nExample: ` \"10.1.2.0/24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ipv4_prefix: true\n  ves.io.schema.rules.string.max_ip_prefix_length: 28\n","title":"IPv4 Subnet","x-displayname":"IPv4 Subnet","x-ves-example":"10.1.2.0/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"28"}}}},"viewsCloudSubnetType":{"type":"object","description":"Parameters for AWS subnet","title":"Cloud Subnet","x-displayname":"AWS Subnet","x-ves-oneof-field-choice":"[\"existing_subnet_id\",\"subnet_param\"]","x-ves-proto-message":"ves.io.schema.views.CloudSubnetType","properties":{"existing_subnet_id":{"type":"string","description":"Exclusive with [subnet_param]\n Information about existing subnet ID\n\nExample: ` \"subnet-12345678901234567\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.pattern: ^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Existing Subnet ID","maxLength":64,"x-displayname":"Existing Subnet ID","x-ves-example":"subnet-12345678901234567","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(subnet-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"subnet_param":{"$ref":"#/components/schemas/viewsCloudSubnetParamType"}}},"viewsCustomCiphers":{"type":"object","description":"This defines TLS protocol config including min/max versions and allowed ciphers","title":"CustomCiphers","x-displayname":"Custom Ciphers","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.views.CustomCiphers","properties":{"cipher_suites":{"type":"array","description":" The TLS listener will only support the specified cipher list.\n\nExample: ` \"TLS_AES_128_GCM_SHA256\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.in: [\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]\n  ves.io.schema.rules.repeated.unique: true\n","title":"cipher_suites","items":{"type":"string"},"x-displayname":"Cipher Suites","x-ves-example":"TLS_AES_128_GCM_SHA256","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.in":"[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]","ves.io.schema.rules.repeated.unique":"true"}},"max_version":{"$ref":"#/components/schemas/schemaTlsProtocol"},"min_version":{"$ref":"#/components/schemas/schemaTlsProtocol"}}},"viewsDownstreamTlsParamsType":{"type":"object","description":"Inline TLS parameters","title":"DownstreamTlsParamsType","x-displayname":"Inline TLS Parameters","x-ves-oneof-field-mtls_choice":"[\"no_mtls\",\"use_mtls\"]","x-ves-proto-message":"ves.io.schema.views.DownstreamTlsParamsType","properties":{"no_mtls":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_certificates":{"type":"array","description":" Users can add one or more certificates that share the same set of domains.\n for example, domain.com and *.domain.com - but use different signature algorithms\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"tls_certificates","minItems":1,"maxItems":16,"items":{"$ref":"#/components/schemas/schemaTlsCertificateType"},"x-displayname":"TLS Certificates","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1"}},"tls_config":{"$ref":"#/components/schemas/viewsTlsConfig"},"use_mtls":{"$ref":"#/components/schemas/viewsDownstreamTlsValidationContext"}}},"viewsDownstreamTlsValidationContext":{"type":"object","description":"Validation context for downstream client TLS connections","title":"DownstreamTlsValidationContext","x-displayname":"Clients TLS validation context","x-ves-oneof-field-crl_choice":"[\"crl\",\"no_crl\"]","x-ves-oneof-field-trusted_ca_choice":"[\"trusted_ca\",\"trusted_ca_url\"]","x-ves-oneof-field-xfcc_header":"[\"xfcc_disabled\",\"xfcc_options\"]","x-ves-proto-message":"ves.io.schema.views.DownstreamTlsValidationContext","properties":{"client_certificate_optional":{"type":"boolean","description":" Client certificate is optional. If the client has provided a certificate,\n the load balancer will verify it. If certification verification fails,\n the connection will be terminated. If the client does not provide a certificate,\n the connection will be accepted.","title":"client_certificate_optional","format":"boolean","x-displayname":"Client Certificate Optional"},"crl":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"no_crl":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_ca":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"trusted_ca_url":{"type":"string","description":"Exclusive with [trusted_ca]\n Upload a Root CA Certificate specifically for this Load Balancer\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.truststore_url: true\n","title":"trusted_ca_url","minLength":1,"maxLength":131072,"x-displayname":"Inline Root CA Certificate (legacy)","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.truststore_url":"true"}},"xfcc_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"xfcc_options":{"$ref":"#/components/schemas/viewsXfccHeaderKeys"}}},"viewsTlsConfig":{"type":"object","description":"This defines various options to configure TLS configuration parameters","title":"TlsConfig","x-displayname":"TLS Config","x-ves-displayorder":"5","x-ves-oneof-field-choice":"[\"custom_security\",\"default_security\",\"low_security\",\"medium_security\"]","x-ves-proto-message":"ves.io.schema.views.TlsConfig","properties":{"custom_security":{"$ref":"#/components/schemas/viewsCustomCiphers"},"default_security":{"$ref":"#/components/schemas/ioschemaEmpty"},"low_security":{"$ref":"#/components/schemas/ioschemaEmpty"},"medium_security":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"viewsXfccHeaderKeys":{"type":"object","description":"X-Forwarded-Client-Cert header elements to be added to requests","title":"XfccHeaderKeys","x-displayname":"XFCC Header Elements","x-ves-proto-message":"ves.io.schema.views.XfccHeaderKeys","properties":{"xfcc_header_elements":{"type":"array","description":" X-Forwarded-Client-Cert header elements to be added to requests\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n","title":"XFCC Header","items":{"$ref":"#/components/schemas/schemaXfccElement"},"x-displayname":"XFCC Header Elements","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]"}}}},"viewsk8s_manifest_paramsDeploymentStatusType":{"type":"object","x-ves-proto-message":"ves.io.schema.views.k8s_manifest_params.DeploymentStatusType","properties":{"status":{"$ref":"#/components/schemas/k8s_manifest_paramsDeployStatus"},"status_output":{"type":"string","description":" Status Output","title":"Status Output","x-displayname":"Status Output"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0161.public.ves.io.schema.nginx.one.nginx_csg.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.nginx.one.nginx_csg","description":"\nNGINX One CSG configuration","version":""},"paths":{"/api/config/namespaces/{namespace}/nginx_csgs":{"get":{"summary":"List NGINX One CSG Object configuration","description":"List the set of nginx_csg in a namespace","operationId":"ves.io.schema.nginx.one.nginx_csg.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nginx_csgListResponse"}}}},"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 nginx_csg","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-nginx-one-nginx_csg-api-list"},"x-ves-proto-rpc":"ves.io.schema.nginx.one.nginx_csg.API.List"},"x-displayname":"NGINX One CSG Object configuration","x-ves-proto-service":"ves.io.schema.nginx.one.nginx_csg.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/nginx_csgs/{name}":{"get":{"summary":"Get Request","description":"Get NGINX csg configuration","operationId":"ves.io.schema.nginx.one.nginx_csg.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/nginx_csgGetResponse"}}}},"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-nginx-one-nginx_csg-api-get"},"x-ves-proto-rpc":"ves.io.schema.nginx.one.nginx_csg.API.Get"},"x-displayname":"NGINX One CSG Object configuration","x-ves-proto-service":"ves.io.schema.nginx.one.nginx_csg.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"NGINX One CSG Object configuration","x-ves-proto-package":"ves.io.schema.nginx.one.nginx_csg","components":{"schemas":{"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"}}},"nginx_csgGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read nginx_csg","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_csg.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/onenginx_csgGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"nginx_csgGetResponseFormatCode":{"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"},"nginx_csgListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of nginx_csg","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_csg.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/nginx_csgListResponseItem"},"x-displayname":"Items"}}},"nginx_csgListResponseItem":{"type":"object","description":"By default a summary of nginx_csg 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 nginx_csg","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_csg.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this nginx_csg","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this nginx_csg","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates nginx_csg is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/onenginx_csgGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this nginx_csg","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this nginx_csg\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 nginx_csg\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"nginx_instanceAPIDiscoverySpec":{"type":"object","x-ves-oneof-field-enablement_mode":"[\"disabled\",\"enabled\"]","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_instance.APIDiscoverySpec","properties":{"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"nginx_instanceWAFSpec":{"type":"object","x-ves-oneof-field-policy_management_platform":"[\"distributed_cloud_policy_management\",\"nginx_policy_management\"]","x-ves-oneof-field-waf_mode":"[\"blocking_waf_mode\",\"monitoring_waf_mode\",\"none_waf_mode\"]","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_instance.WAFSpec","properties":{"blocking_waf_mode":{"$ref":"#/components/schemas/ioschemaEmpty"},"distributed_cloud_policy_management":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitoring_waf_mode":{"$ref":"#/components/schemas/ioschemaEmpty"},"nginx_policy_management":{"$ref":"#/components/schemas/ioschemaEmpty"},"none_waf_mode":{"$ref":"#/components/schemas/ioschemaEmpty"},"policy_file_name":{"type":"string","description":" Policy file name for WAF\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"policy_file_name","x-displayname":"WAF Policy File Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"policy_name":{"type":"string","description":" Policy name configured for WAF\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"policy_name","x-displayname":"WAF Policy Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"security_log_enabled":{"type":"boolean","description":" Specifies if security logging is enabled","title":"security_log_enabled","format":"boolean","x-displayname":"WAF Log Enabled"},"security_log_file_names":{"type":"array","description":" Specifies the list of security log files specification","title":"security_log_file_names","items":{"type":"string"},"x-displayname":"WAF Log File Names"}}},"onenginx_csgGetSpecType":{"type":"object","description":"Get NGINX csg configuration","title":"Get NGINX csg configuration","x-displayname":"Get Request","x-ves-proto-message":"ves.io.schema.nginx.one.nginx_csg.GetSpecType","properties":{"api_discovery_spec":{"$ref":"#/components/schemas/nginx_instanceAPIDiscoverySpec"},"csg_name":{"type":"string","description":" Name for CSG in NGINX One","x-displayname":"CSGName"},"object_id":{"type":"string","description":" Identifier for config sync group in NGINX One","x-displayname":"ObjectId"},"waf_spec":{"$ref":"#/components/schemas/nginx_instanceWAFSpec"}}},"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"}}},"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"}}},"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"}}},"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"}}},"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"}}}}}}