@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0104.public.ves.io.schema.views.external_connector.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.views.external_connector","description":"External Connector configuration mainly includes the following:\n1. Tunnel connfiguration between F5 CE and external (3rd party) device\n2. Tunnel specific parameters (IPSec, GRE)","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/external_connectors":{"post":{"summary":"Create external_connector configuration","description":"Shape of the external_connector configuration specification","operationId":"ves.io.schema.views.external_connector.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_connectorCreateResponse"}}}},"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/external_connectorCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-external_connector-api-create"},"x-ves-proto-rpc":"ves.io.schema.views.external_connector.API.Create"},"x-displayname":"External Connector Configuration","x-ves-proto-service":"ves.io.schema.views.external_connector.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/external_connectors/{metadata.name}":{"put":{"summary":"Replace external_connector configuration","description":"Shape of the external_connector configuration specification","operationId":"ves.io.schema.views.external_connector.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_connectorReplaceResponse"}}}},"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/external_connectorReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-external_connector-api-replace"},"x-ves-proto-rpc":"ves.io.schema.views.external_connector.API.Replace"},"x-displayname":"External Connector Configuration","x-ves-proto-service":"ves.io.schema.views.external_connector.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/external_connectors":{"get":{"summary":"List External Connector Configuration","description":"List the set of external_connector in a namespace","operationId":"ves.io.schema.views.external_connector.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_connectorListResponse"}}}},"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 external_connector","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-views-external_connector-api-list"},"x-ves-proto-rpc":"ves.io.schema.views.external_connector.API.List"},"x-displayname":"External Connector Configuration","x-ves-proto-service":"ves.io.schema.views.external_connector.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/external_connectors/{name}":{"get":{"summary":"Get external_connector configuration","description":"Shape of the external_connector configuration specification","operationId":"ves.io.schema.views.external_connector.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_connectorGetResponse"}}}},"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-views-external_connector-api-get"},"x-ves-proto-rpc":"ves.io.schema.views.external_connector.API.Get"},"delete":{"summary":"Delete External Connector Configuration","description":"Delete the specified external_connector","operationId":"ves.io.schema.views.external_connector.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/external_connectorDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-views-external_connector-api-delete"},"x-ves-proto-rpc":"ves.io.schema.views.external_connector.API.Delete"},"x-displayname":"External Connector Configuration","x-ves-proto-service":"ves.io.schema.views.external_connector.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"External Connector Configuration","x-ves-proto-package":"ves.io.schema.views.external_connector","components":{"schemas":{"external_connectorConnectionTypeDirect":{"type":"object","description":"x-displayName: \"Direct Connection Type\"\nExternal Connector with direct connection","title":"Direct Connection Type"},"external_connectorConnectionTypeGRE":{"type":"object","description":"x-displayName: \"GRE\"\nExternal Connector with GRE tunnel","title":"GRE","properties":{"gre_parameters":{"$ref":"#/components/schemas/external_connectorGRETunnelParameters"}}},"external_connectorConnectionTypeIPSec":{"type":"object","description":"External Connector with IPSec tunnel","title":"IPSec","x-displayname":"IPSec","x-ves-proto-message":"ves.io.schema.views.external_connector.ConnectionTypeIPSec","properties":{"ike_parameters":{"$ref":"#/components/schemas/external_connectorIkeParameters"},"ipsec_tunnel_parameters":{"$ref":"#/components/schemas/external_connectorTunnelParameters"}}},"external_connectorCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of external_connector","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.views.external_connector.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/external_connectorCreateSpecType"}}},"external_connectorCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.external_connector.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/external_connectorGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"external_connectorCreateSpecType":{"type":"object","description":"Shape of the external_connector configuration specification","title":"CreateSpecType","x-displayname":"Create external_connector configuration","x-ves-displayorder":"1,2","x-ves-oneof-field-connection_type":"[\"ipsec\"]","x-ves-proto-message":"ves.io.schema.views.external_connector.CreateSpecType","properties":{"ce_site_reference":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"ipsec":{"$ref":"#/components/schemas/external_connectorConnectionTypeIPSec"}}},"external_connectorDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a external_connector","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.views.external_connector.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"}}},"external_connectorDpdKeepAliveTimer":{"type":"object","title":"Keepalive Timer","x-displayname":"Keepalive Timer","x-ves-proto-message":"ves.io.schema.views.external_connector.DpdKeepAliveTimer","properties":{"timeout":{"type":"integer","description":"\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 5\n","title":"Keepalive Timer","format":"int64","x-displayname":"Keepalive Timer","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"5"}}}},"external_connectorGRETunnelParameters":{"type":"object","description":"x-displayName: \"GRE Tunnel Parameters\"\nGRE configuration parameters required for GRE Connection type","title":"GRE Tunnel Parameters","properties":{"peer_ip_address":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"segment":{"$ref":"#/components/schemas/schemaSegmentRefType"},"site_local_inside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"tunnel_eps":{"type":"array","description":"x-displayName: \"Tunnel Endpoint\"\nx-required\nConfigure tunnel parameters, source, destination, IP addresses.","title":"Tunnel Endpoint","items":{"$ref":"#/components/schemas/external_connectorTunnelEndpoint"}},"tunnel_mtu":{"type":"integer","description":"x-displayName: \"Tunnel MTU\"\nConfigure MTU for the GRE tunnel interface.","title":"Tunnel MTU","format":"int64"}}},"external_connectorGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read external_connector","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.views.external_connector.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/external_connectorCreateRequest"},"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/external_connectorReplaceRequest"},"spec":{"$ref":"#/components/schemas/external_connectorGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/external_connectorStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"external_connectorGetResponseFormatCode":{"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"},"external_connectorGetSpecType":{"type":"object","description":"Shape of the external_connector configuration specification","title":"GetSpecType","x-displayname":"Get external_connector configuration","x-ves-displayorder":"1,2","x-ves-oneof-field-connection_type":"[\"ipsec\"]","x-ves-proto-message":"ves.io.schema.views.external_connector.GetSpecType","properties":{"ce_site_reference":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"ipsec":{"$ref":"#/components/schemas/external_connectorConnectionTypeIPSec"}}},"external_connectorIkeParameters":{"type":"object","description":"IKE configuration parameters required for IPSec Connection type","title":"IKE Parameters","x-displayname":"IKE Parameters","x-ves-oneof-field-dpd_choice":"[\"dpd_disabled\",\"dpd_keep_alive_timer\"]","x-ves-oneof-field-local_ike_id":"[\"use_default_local_ike_id\"]","x-ves-oneof-field-mode_choice":"[\"initiator\",\"responder\"]","x-ves-oneof-field-remote_ike_id":"[\"rm_hostname\",\"rm_ip_address\",\"use_default_remote_ike_id\"]","x-ves-proto-message":"ves.io.schema.views.external_connector.IkeParameters","properties":{"dpd_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"dpd_keep_alive_timer":{"$ref":"#/components/schemas/external_connectorDpdKeepAliveTimer"},"ike_phase1_profile":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"ike_phase2_profile":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"initiator":{"$ref":"#/components/schemas/ioschemaEmpty"},"responder":{"$ref":"#/components/schemas/ioschemaEmpty"},"rm_hostname":{"type":"string","description":"Exclusive with [rm_ip_address use_default_remote_ike_id]\n Configure an hostname Remote IKE ID","title":"Hostname","x-displayname":"Hostname"},"rm_ip_address":{"$ref":"#/components/schemas/schemaIpAddressType"},"use_default_local_ike_id":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_default_remote_ike_id":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"external_connectorListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of external_connector","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.views.external_connector.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/external_connectorListResponseItem"},"x-displayname":"Items"}}},"external_connectorListResponseItem":{"type":"object","description":"By default a summary of external_connector 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 external_connector","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.views.external_connector.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this external_connector","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this external_connector","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates external_connector is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/external_connectorGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this external_connector","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this external_connector\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/external_connectorStatusObject"},"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 external_connector\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"external_connectorReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a external_connector","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.views.external_connector.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/external_connectorReplaceSpecType"}}},"external_connectorReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.views.external_connector.ReplaceResponse"},"external_connectorReplaceSpecType":{"type":"object","description":"Shape of the external_connector configuration specification","title":"ReplaceSpecType","x-displayname":"Replace external_connector configuration","x-ves-displayorder":"1,2","x-ves-oneof-field-connection_type":"[\"ipsec\"]","x-ves-proto-message":"ves.io.schema.views.external_connector.ReplaceSpecType","properties":{"ce_site_reference":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"ipsec":{"$ref":"#/components/schemas/external_connectorConnectionTypeIPSec"}}},"external_connectorStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.views.external_connector.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions represent the normalized status values for configuration object","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Proxy view object direct reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"external_connectorTunnelEndpoint":{"type":"object","description":"Configure tunnel endpoints, local and remote IP addresses","title":"Tunnel Endpoint","x-displayname":"Tunnel Endpoint","x-ves-displayorder":"1,2,5,6","x-ves-proto-message":"ves.io.schema.views.external_connector.TunnelEndpoint","properties":{"interface":{"type":"string","description":" For the chosen node, specify the interface that will be the tunnel source.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Interface","x-displayname":"Interface","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"local_tunnel_ip":{"type":"string","description":" For a particular tunnel on a node, specify the local tunnel IP Address i.e. the IP address of the tunnel on the CE node itself and a subnet prefix length\n\nExample: ` \"10.10.15.1/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","title":"Local Tunnel IP Address","x-displayname":"Local Tunnel IP Address/Prefix Length","x-ves-example":"10.10.15.1/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true"}},"node":{"type":"string","description":" A CE site is composed of multiple nodes. Choose a node that will be part of this external connection.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Node","x-displayname":"Node","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"remote_tunnel_ip":{"type":"string","description":" For a particular tunnel on a node, specify the remote tunnel IP Address i.e. the IP address of the tunnel on the remote gateway and a subnet prefix length\n\nExample: ` \"10.10.15.2/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","title":"Remote Tunnel IP Address","x-displayname":"Remote Tunnel IP Address/Prefix Length","x-ves-example":"10.10.15.2/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true"}}}},"external_connectorTunnelParameters":{"type":"object","description":"In this section, we will configure the tunnel parameters, source, destination, IP addresses,  and segment.","title":"TunnelParameters","x-displayname":"Configure IPSec Tunnel Parameters","x-ves-oneof-field-tunnel_source_vn":"[\"segment\",\"site_local_inside_network\",\"site_local_network\"]","x-ves-proto-message":"ves.io.schema.views.external_connector.TunnelParameters","properties":{"peer_ip_address":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"psk":{"type":"string","description":" The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Pre-Shared Key","x-displayname":"Pre-Shared Key","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"segment":{"$ref":"#/components/schemas/schemaSegmentRefType"},"site_local_inside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"tunnel_eps":{"type":"array","description":" Configure tunnel parameters, local and remote IP addresses \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","title":"Tunnel Endpoint","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/external_connectorTunnelEndpoint"},"x-displayname":"Tunnel Endpoint","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"}},"tunnel_mtu":{"type":"integer","description":" The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 512\n  ves.io.schema.rules.uint32.lte: 1370\n","title":"MTU","format":"int64","x-displayname":"MTU","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"512","ves.io.schema.rules.uint32.lte":"1370"}}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaIpAddressType":{"type":"object","description":"IP Address used to specify an IPv4 or IPv6 address","title":"IP Address","x-displayname":"IP Address","x-ves-displayorder":"3","x-ves-oneof-field-ver":"[\"ipv4\",\"ipv6\"]","x-ves-proto-message":"ves.io.schema.IpAddressType","properties":{"ipv4":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"ipv6":{"$ref":"#/components/schemas/schemaIpv6AddressType"}}},"schemaIpv4AddressType":{"type":"object","description":"IPv4 Address in dot-decimal notation","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-proto-message":"ves.io.schema.Ipv4AddressType","properties":{"addr":{"type":"string","description":" IPv4 Address in string form with dot-decimal notation\n\nExample: ` \"192.168.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-example":"192.168.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"schemaIpv6AddressType":{"type":"object","description":"IPv6 Address specified as hexadecimal numbers separated by ':'","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-proto-message":"ves.io.schema.Ipv6AddressType","properties":{"addr":{"type":"string","description":" IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':'\n The address can be compacted by suppressing zeros\n e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'\n\nExample: ` \"2001:db8:0:0:0:0:2:1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-example":"2001:db8:0:0:0:0:2:1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"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"}}},"schemaSegmentRefType":{"type":"object","description":"Reference to Segment Object","title":"SegmentRefType","x-displayname":"Segment Reference Type","x-ves-proto-message":"ves.io.schema.SegmentRefType","properties":{"refs":{"type":"array","description":" Reference to Segment Object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"Segment","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Segment","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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"}}},"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"}}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0105.public.ves.io.schema.dns_zone.rrset.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.dns_zone.rrset","description":"x-required\nAPIs to create, update or delete individual records of a DNS zone without having to send the whole DNS zone information.","version":""},"paths":{"/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}":{"post":{"summary":"Create","operationId":"ves.io.schema.dns_zone.rrset.CustomAPI.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetResponse"}}}},"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":"dns_zone_name","description":"dns_zone_name\n\nx-required","in":"path","required":true,"x-displayname":"dns zone name","schema":{"type":"string"}},{"name":"group_name","description":"group_name\n\nx-required","in":"path","required":true,"x-displayname":"group name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-rrset-customapi-create"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.rrset.CustomAPI.Create"},"x-displayname":"F5XC DNS Management RRSet API","x-ves-proto-service":"ves.io.schema.dns_zone.rrset.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type}":{"get":{"summary":"Get","operationId":"ves.io.schema.dns_zone.rrset.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetResponse"}}}},"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":"dns_zone_name","description":"dns_zone_name\n\nx-required","in":"path","required":true,"x-displayname":"dns zone name","schema":{"type":"string"}},{"name":"group_name","description":"group_name\n\nx-required","in":"path","required":true,"x-displayname":"group name","schema":{"type":"string"}},{"name":"record_name","description":"record_name\n\nx-required","in":"path","required":true,"x-displayname":"record name","schema":{"type":"string"}},{"name":"type","description":"type\n\nx-required","in":"path","required":true,"x-displayname":"type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-rrset-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.rrset.CustomAPI.Get"},"delete":{"summary":"Delete","operationId":"ves.io.schema.dns_zone.rrset.CustomAPI.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetResponse"}}}},"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":"dns_zone_name","description":"dns_zone_name\n\nx-required","in":"path","required":true,"x-displayname":"dns zone name","schema":{"type":"string"}},{"name":"group_name","description":"group_name\n\nx-required","in":"path","required":true,"x-displayname":"group name","schema":{"type":"string"}},{"name":"record_name","description":"record_name\n\nx-required","in":"path","required":true,"x-displayname":"record name","schema":{"type":"string"}},{"name":"type","description":"type\n\nx-required","in":"path","required":true,"x-displayname":"type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-rrset-customapi-delete"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.rrset.CustomAPI.Delete"},"put":{"summary":"Replace","operationId":"ves.io.schema.dns_zone.rrset.CustomAPI.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetResponse"}}}},"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":"dns_zone_name","description":"dns_zone_name\n\nx-required","in":"path","required":true,"x-displayname":"dns zone name","schema":{"type":"string"}},{"name":"group_name","description":"group_name\n\nx-required","in":"path","required":true,"x-displayname":"group name","schema":{"type":"string"}},{"name":"record_name","description":"record_name\n\nx-required","in":"path","required":true,"x-displayname":"record name","schema":{"type":"string"}},{"name":"type","description":"type\n\nx-required","in":"path","required":true,"x-displayname":"type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rrsetReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-rrset-customapi-replace"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.rrset.CustomAPI.Replace"},"x-displayname":"F5XC DNS Management RRSet API","x-ves-proto-service":"ves.io.schema.dns_zone.rrset.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5XC DNS Management RRSet API","x-ves-proto-package":"ves.io.schema.dns_zone.rrset","components":{"schemas":{"dns_zoneAFSDBRecordSubtype":{"type":"string","description":"AFS Volume Location Server or DCE Authentication Server.\n\n - NONE: NONE\n\n - AFSVolumeLocationServer: AFS Volume Location Server\n\n - DCEAuthenticationServer: DCE Authentication Server\n","title":"AFSDB Record Subtype","enum":["NONE","AFSVolumeLocationServer","DCEAuthenticationServer"],"default":"NONE","x-displayname":"AFSDB Record Subtype","x-ves-proto-enum":"ves.io.schema.dns_zone.AFSDBRecordSubtype"},"dns_zoneAFSDBRecordValue":{"type":"object","title":"AFSDBRecordValue","x-displayname":"AFSDBRecordValue","x-ves-proto-message":"ves.io.schema.dns_zone.AFSDBRecordValue","properties":{"hostname":{"type":"string","description":" Server name of the AFS cell database server or the DCE name server.\n\nExample: ` \"mail.example.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":"Hostname","x-displayname":"Hostname","x-ves-example":"mail.example.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hostname":"true"}},"subtype":{"$ref":"#/components/schemas/dns_zoneAFSDBRecordSubtype"}}},"dns_zoneCERTAlgorithm":{"type":"string","description":"CERT algorithm value must be compatible with the specified algorithm.\n\n - RESERVEDALGORITHM: RESERVEDALGORITHM\n\n - RSAMD5: RSAMD5\n\n - DH: DH\n\n - DSASHA1: DSASHA1\n\n - ECC: ECC\n\n - RSASHA1ALGORITHM: RSA-SHA1\n\n - INDIRECT: INDIRECT\n\n - PRIVATEDNS: PRIVATEDNS\n\n - PRIVATEOID: PRIVATEOID\n","title":"CERT Algorithm","enum":["RESERVEDALGORITHM","RSAMD5","DH","DSASHA1","ECC","RSASHA1ALGORITHM","INDIRECT","PRIVATEDNS","PRIVATEOID"],"default":"RESERVEDALGORITHM","x-displayname":"CERT Algorithm","x-ves-proto-enum":"ves.io.schema.dns_zone.CERTAlgorithm"},"dns_zoneCERTRecordValue":{"type":"object","title":"CERTRecordValue","x-displayname":"CERTRecordValue","x-ves-proto-message":"ves.io.schema.dns_zone.CERTRecordValue","properties":{"algorithm":{"$ref":"#/components/schemas/dns_zoneCERTAlgorithm"},"cert_key_tag":{"type":"integer","description":"\nExample: ` \"3\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Key Tag","format":"int64","x-displayname":"Key Tag","x-ves-example":"3","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}},"cert_type":{"$ref":"#/components/schemas/dns_zoneCERTType"},"certificate":{"type":"string","description":" Certificate in base 64 format.\n\nExample: ` \"Ab100cFg\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 4096\n  ves.io.schema.rules.string.min_len: 1\n","title":"Certificate","minLength":1,"maxLength":4096,"x-displayname":"Certificate","x-ves-example":"Ab100cFg","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"4096","ves.io.schema.rules.string.min_len":"1"}}}},"dns_zoneCERTResourceRecord":{"type":"object","description":"DNS CERT Record","title":"CERTResourceRecord","x-displayname":"DNS CERT Record","x-ves-proto-message":"ves.io.schema.dns_zone.CERTResourceRecord","properties":{"name":{"type":"string","description":" CERT Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"values\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"CERT Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneCERTRecordValue"},"x-displayname":"CERT Value","x-ves-example":"values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneCERTType":{"type":"string","description":"CERT type value must be compatible with the specified types.\n\n - INVALIDCERTTYPE: INVALIDCERTTYPE\n\n - PKIX: PKIX\n\n - SPKI: SPKI\n\n - PGP: PGP\n\n - IPKIX: IPKIX\n\n - ISPKI: ISPKI\n\n - IPGP: IPGP\n\n - ACPKIX: ACPKIX\n\n - IACPKIX: IACPKIX\n\n - URI_: URI\n\n - OID: OID\n","title":"CERT Type","enum":["INVALIDCERTTYPE","PKIX","SPKI","PGP","IPKIX","ISPKI","IPGP","ACPKIX","IACPKIX","URI_","OID"],"default":"INVALIDCERTTYPE","x-displayname":"CERT Type","x-ves-proto-enum":"ves.io.schema.dns_zone.CERTType"},"dns_zoneCertificationAuthorityAuthorization":{"type":"object","title":"CertificationAuthorityAuthorization","x-displayname":"CertificationAuthorityAuthorization","x-ves-proto-message":"ves.io.schema.dns_zone.CertificationAuthorityAuthorization","properties":{"flags":{"type":"integer","description":" This flag should be an integer between 0 and 255.\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","title":"Certification authority authorization flags","format":"int64","x-displayname":"Flags","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}},"tag":{"type":"string","description":"\n\nExample: ` \"issue\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"issue\\\", \\\"issuewild\\\", \\\"iodef\\\"]\n","title":"Certification authority authorization tag","x-displayname":"Tag","x-ves-example":"issue","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"issue\\\", \\\"issuewild\\\", \\\"iodef\\\"]"}},"value":{"type":"string","description":"\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.min_len: 1\n","title":"Certification authority authorization value","minLength":1,"maxLength":1024,"x-displayname":"Value","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.min_len":"1"}}}},"dns_zoneDLVResourceRecord":{"type":"object","description":"x-displayName: \"DNS DLV Record\"\nDNS DLV Record","title":"DLVResourceRecord","properties":{"name":{"type":"string","description":"x-displayName: \"Record Name (Excluding Domain name)\"\nx-example: \"www or mail or * or ww* or *ab\"\nDLV Record name, please provide only the specific subdomain or record name without the base domain.","title":"Record Name"},"values":{"type":"array","description":"x-displayName: \"DLV Value\"\nx-example: \"values\"\nx-required\nIt uses the same format as the DS record.","title":"DLV Value","items":{"$ref":"#/components/schemas/dns_zoneDSRecordValue"}}}},"dns_zoneDNSAAAAResourceRecord":{"type":"object","description":"RecordSet for AAAA Records","title":"DNSAAAAResourceRecord","x-displayname":"DNSAAAAResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSAAAAResourceRecord","properties":{"name":{"type":"string","description":" AAAA Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":" A valid IPv6 address, for example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334\n\nExample: ` \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.ipv6: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"IPv6 addresses","minItems":1,"maxItems":100,"items":{"type":"string"},"x-displayname":"IPv6 Addresses","x-ves-example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.ipv6":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"dns_zoneDNSAFSDBRecord":{"type":"object","description":"DNS AFSDB Record","title":"DNSAFSDBRecord","x-displayname":"DNS AFSDB Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSAFSDBRecord","properties":{"name":{"type":"string","description":" AFSDB Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"values\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"AFSDB Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneAFSDBRecordValue"},"x-displayname":"AFSDB Value","x-ves-example":"values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSAResourceRecord":{"type":"object","description":"A Records","title":"DNSAResourceRecord","x-displayname":"DNSAResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSAResourceRecord","properties":{"name":{"type":"string","description":" A Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":" A valid IPv4 address, for example: 1.1.1.1\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.repeated.items.string.ipv4: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"IPv4 addresses","minItems":1,"maxItems":100,"items":{"type":"string"},"x-displayname":"IPv4 Addresses","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.repeated.items.string.ipv4":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"dns_zoneDNSAliasResourceRecord":{"type":"object","title":"DNSAliasResourceRecord","x-displayname":"DNSAliasResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSAliasResourceRecord","properties":{"value":{"type":"string","description":" A valid domain name, for example: example.com\n\nExample: ` \"example.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 255\n","title":"Domain","maxLength":255,"x-displayname":"Domain","x-ves-example":"example.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"255"}}}},"dns_zoneDNSCAAResourceRecord":{"type":"object","title":"DNSCAAResourceRecord","x-displayname":"DNSCAAResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSCAAResourceRecord","properties":{"name":{"type":"string","description":" CAA Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":"\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 100\n","title":"CAA Record Value","maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneCertificationAuthorityAuthorization"},"x-displayname":"CAA Record Value","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"100"}}}},"dns_zoneDNSCDSRecord":{"type":"object","description":"DNS CDS Record","title":"DNSCDSRecord","x-displayname":"DNS CDS Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSCDSRecord","properties":{"name":{"type":"string","description":" CDS Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"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: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"DS Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneDSRecordValue"},"x-displayname":"DS Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSCNAMEResourceRecord":{"type":"object","title":"DNSCNAMEResourceRecord","x-displayname":"DNSCNAMEResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSCNAMEResourceRecord","properties":{"name":{"type":"string","description":" CName Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"value":{"type":"string","description":"\n\nExample: ` \"example.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 255\n","title":"Domain","maxLength":255,"x-displayname":"Domain","x-ves-example":"example.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"255"}}}},"dns_zoneDNSDSRecord":{"type":"object","description":"DNS DS Record","title":"DNSDSRecord","x-displayname":"DNS DS Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSDSRecord","properties":{"name":{"type":"string","description":" DS Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"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: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"DS Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneDSRecordValue"},"x-displayname":"DS Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSEUI48ResourceRecord":{"type":"object","description":"DNS EUI48 Record","title":"DNSEUI48ResourceRecord","x-displayname":"DNS EUI48 Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSEUI48ResourceRecord","properties":{"name":{"type":"string","description":" EUI48 Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"value":{"type":"string","description":" A valid eui48 identifier, for example: 01-23-45-67-89-ab\n\nExample: ` \"01-23-45-67-89-ab\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 17\n  ves.io.schema.rules.string.min_len: 17\n  ves.io.schema.rules.string.pattern: ^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$\n","title":"EUI48 Identifier","minLength":17,"maxLength":17,"x-displayname":"EUI48 Identifier","x-ves-example":"01-23-45-67-89-ab","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"17","ves.io.schema.rules.string.min_len":"17","ves.io.schema.rules.string.pattern":"^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$"}}}},"dns_zoneDNSEUI64ResourceRecord":{"type":"object","description":"DNS EUI64 Record","title":"DNSEUI64ResourceRecord","x-displayname":"DNS EUI64 Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSEUI64ResourceRecord","properties":{"name":{"type":"string","description":" EUI64 Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"value":{"type":"string","description":" A valid EUI64 identifier, for example: 01-23-45-67-89-ab-cd-ef\n\nExample: ` \"01-23-45-67-89-ab-cd-ef\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 23\n  ves.io.schema.rules.string.min_len: 23\n  ves.io.schema.rules.string.pattern: ^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$\n","title":"EUI64 Identifier","minLength":23,"maxLength":23,"x-displayname":"EUI64 Identifier","x-ves-example":"01-23-45-67-89-ab-cd-ef","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"23","ves.io.schema.rules.string.min_len":"23","ves.io.schema.rules.string.pattern":"^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$"}}}},"dns_zoneDNSLBResourceRecord":{"type":"object","description":"DNS Load Balancer Record","title":"DNSLBResourcerecord","x-displayname":"DNS Load Balancer Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSLBResourceRecord","properties":{"name":{"type":"string","description":" Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 255\n","title":"Record Name","maxLength":255,"x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"255"}},"value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"dns_zoneDNSLOCResourceRecord":{"type":"object","description":"DNS LOC Record","title":"DNSLOCResourceRecord","x-displayname":"DNS LOC Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSLOCResourceRecord","properties":{"name":{"type":"string","description":" LOC Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"32 7 19 S 116 2 25 E 10m\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"LOC Values","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneLOCValue"},"x-displayname":"LOC Value","x-ves-example":"32 7 19 S 116 2 25 E 10m","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSMXResourceRecord":{"type":"object","title":"DNSMXResourceRecord","x-displayname":"DNSMXResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSMXResourceRecord","properties":{"name":{"type":"string","description":" MX Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"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: 100\n","title":"Value","maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneMailExchanger"},"x-displayname":"MX Record Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100"}}}},"dns_zoneDNSNAPTRResourceRecord":{"type":"object","description":"DNS NAPTR Record","title":"DNSNAPTRResourceRecord","x-displayname":"DNS NAPTR Record","x-ves-proto-message":"ves.io.schema.dns_zone.DNSNAPTRResourceRecord","properties":{"name":{"type":"string","description":" NAPTR Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"values\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"NAPTR Values","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneNAPTRValue"},"x-displayname":"NAPTR Value","x-ves-example":"values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSNSResourceRecord":{"type":"object","title":"DNSNSResourceRecord","x-displayname":"DNSNSResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSNSResourceRecord","properties":{"name":{"type":"string","description":" NS Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.we\" or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.we\" or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":"\nExample: ` \"ns1.example.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.hostname: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Name-servers","minItems":1,"maxItems":100,"items":{"type":"string"},"x-displayname":"Name Servers","x-ves-example":"ns1.example.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.hostname":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"dns_zoneDNSPTRResourceRecord":{"type":"object","title":"DNSPTRResourceRecord","x-displayname":"DNSPTRResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSPTRResourceRecord","properties":{"name":{"type":"string","description":" PTR Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":"\nExample: ` \"my.example.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.hostname: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domain names","minItems":1,"maxItems":100,"items":{"type":"string"},"x-displayname":"Domain Name","x-ves-example":"my.example.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.hostname":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"dns_zoneDNSSRVResourceRecord":{"type":"object","title":"DNSSRVResourceRecord","x-displayname":"DNSSRVResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSSRVResourceRecord","properties":{"name":{"type":"string","description":" SRV Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$"}},"values":{"type":"array","description":"\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"SRV Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneSRVService"},"x-displayname":"SRV Value","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneDNSTXTResourceRecord":{"type":"object","title":"DNSTXTResourceRecord","x-displayname":"DNSTXTResourceRecord","x-ves-proto-message":"ves.io.schema.dns_zone.DNSTXTResourceRecord","properties":{"name":{"type":"string","description":" TXT Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or corp.web or *.b\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or corp.web or *.b","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$"}},"values":{"type":"array","description":"\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 4000\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Text","minItems":1,"maxItems":100,"items":{"type":"string","maxLength":4000},"x-displayname":"Text","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"4000","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"dns_zoneDSKeyAlgorithm":{"type":"string","description":"DS key value must be compatible with the specified algorithm.\n\n - UNSPECIFIED: UNSPECIFIED\n\n - RSASHA1: RSASHA1\n\n - RSASHA1NSEC3SHA1: RSASHA1-NSEC3-SHA1\n\n - RSASHA256: RSASHA256\n\n - RSASHA512: RSASHA512\n\n - ECDSAP256SHA256: ECDSAP256SHA256\n\n - ECDSAP384SHA384: ECDSAP384SHA384\n\n - ED25519: ED25519\n\n - ED448: ED448\n","title":"DS Key Algorithm","enum":["UNSPECIFIED","RSASHA1","RSASHA1NSEC3SHA1","RSASHA256","RSASHA512","ECDSAP256SHA256","ECDSAP384SHA384","ED25519","ED448"],"default":"UNSPECIFIED","x-displayname":"DS Key algorithm","x-ves-proto-enum":"ves.io.schema.dns_zone.DSKeyAlgorithm"},"dns_zoneDSRecordValue":{"type":"object","title":"DSRecordValue","x-displayname":"DSRecordValue","x-ves-oneof-field-digest_choice":"[\"sha1_digest\",\"sha256_digest\",\"sha384_digest\"]","x-ves-proto-message":"ves.io.schema.dns_zone.DSRecordValue","properties":{"ds_key_algorithm":{"$ref":"#/components/schemas/dns_zoneDSKeyAlgorithm"},"key_tag":{"type":"integer","description":" A short numeric value which can help quickly identify the referenced DNSKEY-record.\n\nExample: ` \"15228\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Key Tag","format":"int64","x-displayname":"Key Tag","x-ves-example":"15228","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}},"sha1_digest":{"$ref":"#/components/schemas/dns_zoneSHA1Digest"},"sha256_digest":{"$ref":"#/components/schemas/dns_zoneSHA256Digest"},"sha384_digest":{"$ref":"#/components/schemas/dns_zoneSHA384Digest"}}},"dns_zoneLOCValue":{"type":"object","title":"LOCValue","x-displayname":"LOCValue","x-ves-proto-message":"ves.io.schema.dns_zone.LOCValue","properties":{"altitude":{"type":"number","description":" Altitude in meters\n\nExample: ` \"20.3\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: -100000.00\n  ves.io.schema.rules.float.lte: 42849672.95\n  ves.io.schema.rules.message.required: true\n","title":"Altitude","format":"float","x-displayname":"Altitude","x-ves-example":"20.3","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"-100000.00","ves.io.schema.rules.float.lte":"42849672.95","ves.io.schema.rules.message.required":"true"}},"horizontal_precision":{"type":"number","description":" Horizontal Precision in meters\n\nExample: ` \"30.00m\"`\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: 0.0\n  ves.io.schema.rules.float.lte: 90000000.00\n","title":"Horizontal Precision","format":"float","x-displayname":"Horizontal Precision","x-ves-example":"30.00m","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"0.0","ves.io.schema.rules.float.lte":"90000000.00"}},"latitude_degree":{"type":"integer","description":" Latitude degree, an integer between 0 and 90, including 0 and 90\n\nExample: ` \"51\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n  ves.io.schema.rules.int32.lte: 90\n  ves.io.schema.rules.message.required: true\n","title":"Latitude degree","format":"int32","x-displayname":"Latitude degree","x-ves-example":"51","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0","ves.io.schema.rules.int32.lte":"90","ves.io.schema.rules.message.required":"true"}},"latitude_hemisphere":{"$ref":"#/components/schemas/dns_zoneLatitudeHemisphere"},"latitude_minute":{"type":"integer","description":" Latitude minute, an integer between 0 and 59, including 0 and 59\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n  ves.io.schema.rules.int32.lte: 59\n","title":"Latitude minute","format":"int32","x-displayname":"Latitude minute","x-ves-example":"30","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0","ves.io.schema.rules.int32.lte":"59"}},"latitude_second":{"type":"number","description":" Latitude second, an decimal between 0 and 59.999, including 0 and 59.999\n\nExample: ` \"12.000\"`\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: 0.0\n  ves.io.schema.rules.float.lte: 59.999\n","title":"Latitude second","format":"float","x-displayname":"Latitude second","x-ves-example":"12.000","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"0.0","ves.io.schema.rules.float.lte":"59.999"}},"location_diameter":{"type":"number","description":" Diameter of a sphere enclosing the described entity, in meters\n\nExample: ` \"30.00m\"`\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: 0.0\n  ves.io.schema.rules.float.lte: 90000000.00\n","title":"Size","format":"float","x-displayname":"Size","x-ves-example":"30.00m","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"0.0","ves.io.schema.rules.float.lte":"90000000.00"}},"longitude_degree":{"type":"integer","description":" Longitude degree, an integer between 0 and 180, including 0 and 180\n\nExample: ` \"51\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n  ves.io.schema.rules.int32.lte: 180\n  ves.io.schema.rules.message.required: true\n","title":"Longitude degree","format":"int32","x-displayname":"Longitude degree","x-ves-example":"51","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0","ves.io.schema.rules.int32.lte":"180","ves.io.schema.rules.message.required":"true"}},"longitude_hemisphere":{"$ref":"#/components/schemas/dns_zoneLongitudeHemisphere"},"longitude_minute":{"type":"integer","description":" Longitude minute, an integer between 0 and 59, including 0 and 59\n\nExample: ` \"30\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n  ves.io.schema.rules.int32.lte: 59\n","title":"Longitude minute","format":"int32","x-displayname":"Longitude minute","x-ves-example":"30","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0","ves.io.schema.rules.int32.lte":"59"}},"longitude_second":{"type":"number","description":" Longitude second, an decimal between 0 and 59.999, including 0 and 59.999\n\nExample: ` \"12.000\"`\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: 0.0\n  ves.io.schema.rules.float.lte: 59.999\n","title":"Longitude second","format":"float","x-displayname":"Longitude second","x-ves-example":"12.000","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"0.0","ves.io.schema.rules.float.lte":"59.999"}},"vertical_precision":{"type":"number","description":" Vertical Precision in meters\n\nExample: ` \"10.00m\"`\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: 0.0\n  ves.io.schema.rules.float.lte: 90000000.00\n","title":"Vertical Precision","format":"float","x-displayname":"Vertical Precision","x-ves-example":"10.00m","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"0.0","ves.io.schema.rules.float.lte":"90000000.00"}}}},"dns_zoneLatitudeHemisphere":{"type":"string","description":"Latitude hemisphere can only be N or S\n\n - N: North Hemisphere\n\n - S: South Hemisphere\n","title":"Latitude Hemisphere","enum":["N","S"],"default":"N","x-displayname":"Latitude hemisphere","x-ves-proto-enum":"ves.io.schema.dns_zone.LatitudeHemisphere"},"dns_zoneLongitudeHemisphere":{"type":"string","description":"Longitude hemisphere can only be E or W\n\n - E: East Hemisphere\n\n - W: West Hemisphere\n","title":"Longitude Hemisphere","enum":["E","W"],"default":"E","x-displayname":"Longitude hemisphere","x-ves-proto-enum":"ves.io.schema.dns_zone.LongitudeHemisphere"},"dns_zoneMailExchanger":{"type":"object","title":"MailExchanger","x-displayname":"MailExchanger","x-ves-proto-message":"ves.io.schema.dns_zone.MailExchanger","properties":{"domain":{"type":"string","description":" Mail exchanger domain name, please provide the full hostname, for example: mail.example.com\n\nExample: ` \"mail.example.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n","title":"Domain","x-displayname":"Domain","x-ves-example":"mail.example.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true"}},"priority":{"type":"integer","description":" Mail exchanger priority code\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}}}},"dns_zoneNAPTRValue":{"type":"object","title":"NAPTRValue","x-displayname":"NAPTRValue","x-ves-proto-message":"ves.io.schema.dns_zone.NAPTRValue","properties":{"flags":{"type":"string","description":" Flag to control aspects of the rewriting and interpretation of the fields in the record. At this time only four flags, S/A/U/P, are defined.\n\nExample: ` \"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 255\n  ves.io.schema.rules.string.pattern: ^(S|s|A|a|U|u|P|p)$\n","title":"Flags","maxLength":255,"x-displayname":"Flags","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"255","ves.io.schema.rules.string.pattern":"^(S|s|A|a|U|u|P|p)$"}},"order":{"type":"integer","description":" Order in which the NAPTR records must be processed. A lower number indicates a higher preference.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Order","format":"int64","x-displayname":"Order","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}},"preference":{"type":"integer","description":" Preference when records have the same order. A lower number indicates a higher preference.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Preference","format":"int64","x-displayname":"Preference","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}},"regexp":{"type":"string","description":" Regular expression to construct the next domain name to lookup.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 255\n","title":"Regular Expression","maxLength":255,"x-displayname":"Regular Expression","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"255"}},"replacement":{"type":"string","description":" The next NAME to query for NAPTR, SRV, or address records depending on the value of the flags field.\n\nExample: ` \"\"`","title":"Replacement","x-displayname":"Replacement"},"service":{"type":"string","description":" Specifies the service(s) available down this rewrite path.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 255\n  ves.io.schema.rules.string.pattern: ^([A-Za-z][A-Za-z0-9]{0,31}(\\\\+[A-Za-z][A-Za-z0-9]{0,31})*$|^$)\n","title":"Protocol Resolution Service","maxLength":255,"x-displayname":"Protocol Resolution Service","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"255","ves.io.schema.rules.string.pattern":"^([A-Za-z][A-Za-z0-9]{0,31}(\\\\+[A-Za-z][A-Za-z0-9]{0,31})*$|^$)"}}}},"dns_zoneRRSet":{"type":"object","title":"RRSet is a set of Resource Record Sets for specific type","x-displayname":"Resource Record Set","x-ves-oneof-field-type_record_set":"[\"a_record\",\"aaaa_record\",\"afsdb_record\",\"alias_record\",\"caa_record\",\"cds_record\",\"cert_record\",\"cname_record\",\"ds_record\",\"eui48_record\",\"eui64_record\",\"lb_record\",\"loc_record\",\"mx_record\",\"naptr_record\",\"ns_record\",\"ptr_record\",\"srv_record\",\"sshfp_record\",\"tlsa_record\",\"txt_record\"]","x-ves-proto-message":"ves.io.schema.dns_zone.RRSet","properties":{"a_record":{"$ref":"#/components/schemas/dns_zoneDNSAResourceRecord"},"aaaa_record":{"$ref":"#/components/schemas/dns_zoneDNSAAAAResourceRecord"},"afsdb_record":{"$ref":"#/components/schemas/dns_zoneDNSAFSDBRecord"},"alias_record":{"$ref":"#/components/schemas/dns_zoneDNSAliasResourceRecord"},"caa_record":{"$ref":"#/components/schemas/dns_zoneDNSCAAResourceRecord"},"cds_record":{"$ref":"#/components/schemas/dns_zoneDNSCDSRecord"},"cert_record":{"$ref":"#/components/schemas/dns_zoneCERTResourceRecord"},"cname_record":{"$ref":"#/components/schemas/dns_zoneDNSCNAMEResourceRecord"},"description":{"type":"string","description":"\n\nExample: ` \"Comment\"`","title":"Comment","x-displayname":"Comment","x-ves-example":"Comment"},"ds_record":{"$ref":"#/components/schemas/dns_zoneDNSDSRecord"},"eui48_record":{"$ref":"#/components/schemas/dns_zoneDNSEUI48ResourceRecord"},"eui64_record":{"$ref":"#/components/schemas/dns_zoneDNSEUI64ResourceRecord"},"lb_record":{"$ref":"#/components/schemas/dns_zoneDNSLBResourceRecord"},"loc_record":{"$ref":"#/components/schemas/dns_zoneDNSLOCResourceRecord"},"mx_record":{"$ref":"#/components/schemas/dns_zoneDNSMXResourceRecord"},"naptr_record":{"$ref":"#/components/schemas/dns_zoneDNSNAPTRResourceRecord"},"ns_record":{"$ref":"#/components/schemas/dns_zoneDNSNSResourceRecord"},"ptr_record":{"$ref":"#/components/schemas/dns_zoneDNSPTRResourceRecord"},"srv_record":{"$ref":"#/components/schemas/dns_zoneDNSSRVResourceRecord"},"sshfp_record":{"$ref":"#/components/schemas/dns_zoneSSHFPResourceRecord"},"tlsa_record":{"$ref":"#/components/schemas/dns_zoneTLSAResourceRecord"},"ttl":{"type":"integer","description":"\n\nExample: ` \"3600\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 60\n  ves.io.schema.rules.uint32.lte: 2147483647\n","title":"TTL","format":"int64","x-displayname":"Time to live","x-ves-example":"3600","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"60","ves.io.schema.rules.uint32.lte":"2147483647"}},"txt_record":{"$ref":"#/components/schemas/dns_zoneDNSTXTResourceRecord"}}},"dns_zoneSHA1Digest":{"type":"object","title":"SHA1 Digest","x-displayname":"SHA1 Digest","x-ves-proto-message":"ves.io.schema.dns_zone.SHA1Digest","properties":{"digest":{"type":"string","description":" The 'digest' is the DS key and the actual contents of the DS record. \n\nExample: ` \"addf120b430021c36c232c99ef8d926aea2acd6b\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 40\n  ves.io.schema.rules.string.min_len: 40\n","title":"Digest","minLength":40,"maxLength":40,"x-displayname":"Digest","x-ves-example":"addf120b430021c36c232c99ef8d926aea2acd6b","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"40","ves.io.schema.rules.string.min_len":"40"}}}},"dns_zoneSHA1Fingerprint":{"type":"object","title":"SHA1 Fingerprint","x-displayname":"SHA1 Fingerprint","x-ves-proto-message":"ves.io.schema.dns_zone.SHA1Fingerprint","properties":{"fingerprint":{"type":"string","description":" The 'fingerprint' is the DS key and the actual contents of the DS record. \n\nExample: ` \"addf120b430021c36c232c99ef8d926aea2acd6b\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 40\n  ves.io.schema.rules.string.min_len: 40\n","title":"Fingerprint","minLength":40,"maxLength":40,"x-displayname":"Fingerprint","x-ves-example":"addf120b430021c36c232c99ef8d926aea2acd6b","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"40","ves.io.schema.rules.string.min_len":"40"}}}},"dns_zoneSHA256Digest":{"type":"object","title":"SHA256 Digest","x-displayname":"SHA256 Digest","x-ves-proto-message":"ves.io.schema.dns_zone.SHA256Digest","properties":{"digest":{"type":"string","description":" The 'digest' is the DS key and the actual contents of the DS record. \n\nExample: ` \"ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 64\n","title":"Digest","minLength":64,"maxLength":64,"x-displayname":"Digest","x-ves-example":"ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"64"}}}},"dns_zoneSHA256Fingerprint":{"type":"object","title":"SHA256 Fingerprint","x-displayname":"SHA256 Fingerprint","x-ves-proto-message":"ves.io.schema.dns_zone.SHA256Fingerprint","properties":{"fingerprint":{"type":"string","description":" The 'fingerprint' is the DS key and the actual contents of the DS record. \n\nExample: ` \"ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 64\n","title":"Fingerprint","minLength":64,"maxLength":64,"x-displayname":"Fingerprint","x-ves-example":"ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"64"}}}},"dns_zoneSHA384Digest":{"type":"object","title":"SHA384 Digest","x-displayname":"SHA384 Digest","x-ves-proto-message":"ves.io.schema.dns_zone.SHA384Digest","properties":{"digest":{"type":"string","description":" The 'digest' is the DS key and the actual contents of the DS record. \n\nExample: ` \"b4a9b28d142d91968ca232b95dfca771ee66f99924148b85026dfa686f6288d0edbfa71c98a798fda71e130f48e8f0f8\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 96\n  ves.io.schema.rules.string.min_len: 96\n","title":"Digest","minLength":96,"maxLength":96,"x-displayname":"Digest","x-ves-example":"b4a9b28d142d91968ca232b95dfca771ee66f99924148b85026dfa686f6288d0edbfa71c98a798fda71e130f48e8f0f8","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"96","ves.io.schema.rules.string.min_len":"96"}}}},"dns_zoneSRVService":{"type":"object","title":"SRVService","x-displayname":"SRVService","x-ves-proto-message":"ves.io.schema.dns_zone.SRVService","properties":{"port":{"type":"integer","description":" Port on which the service can be found\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Port","format":"int64","x-displayname":"Port","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}},"priority":{"type":"integer","description":" Priority of the target. A lower number indicates a higher preference.\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}},"target":{"type":"string","description":" Hostname of the machine providing the service\n\nExample: ` \"my.example.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^[.]$|^([a-zA-Z0-9]{1}[a-zA-Z0-9_-]{0,62})(\\\\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*?(\\\\.[a-zA-Z]{1}[a-zA-Z0-9]{0,62})\\\\.?$\n","title":"Target","x-displayname":"Target","x-ves-example":"my.example.com","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^[.]$|^([a-zA-Z0-9]{1}[a-zA-Z0-9_-]{0,62})(\\\\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*?(\\\\.[a-zA-Z]{1}[a-zA-Z0-9]{0,62})\\\\.?$"}},"weight":{"type":"integer","description":" Weight of the target. A higher number indicates a higher preference.\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"Weight","format":"int64","x-displayname":"Weight","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"65535"}}}},"dns_zoneSSHFPAlgorithm":{"type":"string","description":"SSHFP algorithm value must be compatible with the specified algorithm.\n\n - UNSPECIFIEDALGORITHM: UNSPECIFIEDALGORITHM\n\n - RSA: RSA\n\n - DSA: DSA\n\n - ECDSA: ECDSA\n\n - Ed25519: Ed25519\n\n - Ed448: Ed448\n","title":"SSHFP Algorithm","enum":["UNSPECIFIEDALGORITHM","RSA","DSA","ECDSA","Ed25519","Ed448"],"default":"UNSPECIFIEDALGORITHM","x-displayname":"SSHFP Algorithm","x-ves-proto-enum":"ves.io.schema.dns_zone.SSHFPAlgorithm"},"dns_zoneSSHFPFingerprintType":{"type":"string","description":"x-displayName: \"SSHFP Fingerprint Type\"\nSSHFP Fingerprint Type must be compatible with the specified values.\n\n - INVALIDFINGERPRINTTYPE: INVALIDFINGERPRINTTYPE\n\nx-displayName: \"Invalid Fingerprint Type\"\n - SHA1ALGORITHM: SHA1ALGORITHM\n\nx-displayName: \"SHA1\"\n - SHA256ALGORITHM: SHA256ALGORITHM\n\nx-displayName: \"SHA256\"","title":"SSHFP Fingerprint Type","enum":["INVALIDFINGERPRINTTYPE","SHA1ALGORITHM","SHA256ALGORITHM"],"default":"INVALIDFINGERPRINTTYPE"},"dns_zoneSSHFPRecordValue":{"type":"object","title":"SSHFPRecordValue","x-displayname":"SSHFPRecordValue","x-ves-oneof-field-fingerprint_type":"[\"sha1_fingerprint\",\"sha256_fingerprint\"]","x-ves-proto-message":"ves.io.schema.dns_zone.SSHFPRecordValue","properties":{"algorithm":{"$ref":"#/components/schemas/dns_zoneSSHFPAlgorithm"},"sha1_fingerprint":{"$ref":"#/components/schemas/dns_zoneSHA1Fingerprint"},"sha256_fingerprint":{"$ref":"#/components/schemas/dns_zoneSHA256Fingerprint"}}},"dns_zoneSSHFPResourceRecord":{"type":"object","description":"DNS SSHFP Record","title":"SSHFPResourceRecord","x-displayname":"DNS SSHFP Record","x-ves-proto-message":"ves.io.schema.dns_zone.SSHFPResourceRecord","properties":{"name":{"type":"string","description":" SSHFP Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"values\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"SSHFP Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneSSHFPRecordValue"},"x-displayname":"SSHFP Value","x-ves-example":"values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"dns_zoneTLSARecordCSelector":{"type":"string","description":"\n - FullCertificate: Full Certificate\n\n - UseSubjectPublicKey: Use Subject Public Key\n","title":"TLSA Record Selector","enum":["FullCertificate","UseSubjectPublicKey"],"default":"FullCertificate","x-displayname":"TLSA Record Selector","x-ves-proto-enum":"ves.io.schema.dns_zone.TLSARecordCSelector"},"dns_zoneTLSARecordCertificateUsage":{"type":"string","description":"\n - CertificateAuthorityConstraint: Certificate Authority Constraint\n\n - ServiceCertificateConstraint: Service Certificate Constraint\n\n - TrustAnchorAssertion: Trust Anchor Assertion\n\n - DomainIssuedCertificate: Domain Issued Certificate\n","title":"TLSA Record Certificate Usage","enum":["CertificateAuthorityConstraint","ServiceCertificateConstraint","TrustAnchorAssertion","DomainIssuedCertificate"],"default":"CertificateAuthorityConstraint","x-displayname":"TLSA Record Certificate Usage","x-ves-proto-enum":"ves.io.schema.dns_zone.TLSARecordCertificateUsage"},"dns_zoneTLSARecordMatchingType":{"type":"string","description":"\n - NoHash: No Hash\n\n - SHA256: SHA-256\n\n - SHA512: SHA-512\n","title":"TLSA Record Matching Type","enum":["NoHash","SHA256","SHA512"],"default":"NoHash","x-displayname":"TLSA Record Matching Type","x-ves-proto-enum":"ves.io.schema.dns_zone.TLSARecordMatchingType"},"dns_zoneTLSARecordValue":{"type":"object","title":"TLSARecordValue","x-displayname":"TLSARecordValue","x-ves-proto-message":"ves.io.schema.dns_zone.TLSARecordValue","properties":{"certificate_association_data":{"type":"string","description":" The actual data to be matched given the settings of the other fields.\n\nExample: ` \"Certificate Association Data\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.hex: true\n  ves.io.schema.rules.string.max_len: 4096\n  ves.io.schema.rules.string.min_len: 1\n","title":"Certificate Association Data","minLength":1,"maxLength":4096,"x-displayname":"Certificate Association Data","x-ves-example":"Certificate Association Data","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.hex":"true","ves.io.schema.rules.string.max_len":"4096","ves.io.schema.rules.string.min_len":"1"}},"certificate_usage":{"$ref":"#/components/schemas/dns_zoneTLSARecordCertificateUsage"},"matching_type":{"$ref":"#/components/schemas/dns_zoneTLSARecordMatchingType"},"selector":{"$ref":"#/components/schemas/dns_zoneTLSARecordCSelector"}}},"dns_zoneTLSAResourceRecord":{"type":"object","description":"DNS TLSA Record","title":"TLSAResourceRecord","x-displayname":"DNS TLSA Record","x-ves-proto-message":"ves.io.schema.dns_zone.TLSAResourceRecord","properties":{"name":{"type":"string","description":" TLSA Record name, please provide only the specific subdomain or record name without the base domain.\n\nExample: ` \"www or mail or * or ww* or *ab\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}\n","title":"Record Name","x-displayname":"Record Name (Excluding Domain name)","x-ves-example":"www or mail or * or ww* or *ab","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}"}},"values":{"type":"array","description":"\nExample: ` \"values\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"TLSA Value","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/dns_zoneTLSARecordValue"},"x-displayname":"TLSA Value","x-ves-example":"values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1"}}}},"rrsetCreateRequest":{"type":"object","title":"CreateRequest","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.dns_zone.rrset.CreateRequest","properties":{"dns_zone_name":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ([0-9a-z]([.a-z0-9-]*[a-z0-9])?)\n","title":"dns_zone_name","x-displayname":"dns zone name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"}},"group_name":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.pattern: ([a-z]([-a-z0-9_]*[a-z0-9])?)\n","title":"group_name","minLength":1,"x-displayname":"group name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.pattern":"([a-z]([-a-z0-9_]*[a-z0-9])?)"}},"rrset":{"$ref":"#/components/schemas/dns_zoneRRSet"}}},"rrsetReplaceRequest":{"type":"object","title":"ReplaceRequest","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.dns_zone.rrset.ReplaceRequest","properties":{"dns_zone_name":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ([0-9a-z]([.a-z0-9-]*[a-z0-9])?)\n","title":"dns_zone_name","x-displayname":"dns zone name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"([0-9a-z]([.a-z0-9-]*[a-z0-9])?)"}},"group_name":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.pattern: ([a-z]([-a-z0-9_]*[a-z0-9])?)\n","title":"group_name","minLength":1,"x-displayname":"group name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.pattern":"([a-z]([-a-z0-9_]*[a-z0-9])?)"}},"record_name":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"record_name","x-displayname":"record name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"rrset":{"$ref":"#/components/schemas/dns_zoneRRSet"},"type":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"A\\\",\\\"AAAA\\\",\\\"ALIAS\\\",\\\"CAA\\\",\\\"CNAME\\\",\\\"MX\\\",\\\"NS\\\",\\\"PTR\\\",\\\"SRV\\\",\\\"TXT\\\",\\\"DNSLB\\\",\\\"NAPTR\\\",\\\"AFSDB\\\",\\\"EUI48\\\",\\\"EUI64\\\",\\\"DS\\\",\\\"CDS\\\",\\\"LOC\\\",\\\"SSHFP\\\",\\\"TLSA\\\",\\\"CERT\\\"]\n","title":"type","x-displayname":"type","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"A\\\",\\\"AAAA\\\",\\\"ALIAS\\\",\\\"CAA\\\",\\\"CNAME\\\",\\\"MX\\\",\\\"NS\\\",\\\"PTR\\\",\\\"SRV\\\",\\\"TXT\\\",\\\"DNSLB\\\",\\\"NAPTR\\\",\\\"AFSDB\\\",\\\"EUI48\\\",\\\"EUI64\\\",\\\"DS\\\",\\\"CDS\\\",\\\"LOC\\\",\\\"SSHFP\\\",\\\"TLSA\\\",\\\"CERT\\\"]"}}}},"rrsetResponse":{"type":"object","title":"Response","x-displayname":"Response","x-ves-proto-message":"ves.io.schema.dns_zone.rrset.Response","properties":{"dns_zone_name":{"type":"string","title":"dns_zone_name","x-displayname":"dns zone name"},"group_name":{"type":"string","title":"group_name","x-displayname":"group name"},"namespace":{"type":"string","title":"namespace","x-displayname":"namespace"},"record_name":{"type":"string","title":"record_name","x-displayname":"record name"},"rrset":{"$ref":"#/components/schemas/dns_zoneRRSet"},"type":{"type":"string","title":"type","x-displayname":"type"}}},"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"}}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0106.public.ves.io.schema.dns_zone.subscription.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.dns_zone.subscription","description":"Use this API to subscribe to F5XC DNS Management","version":""},"paths":{"/api/config/dns/namespaces/system/dns_management/addon/subscribe":{"post":{"summary":"Subscribe to DNS Management","description":"Subscribe to DNS Management","operationId":"ves.io.schema.dns_zone.subscription.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-subscription-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.subscription.CustomAPI.Subscribe"},"x-displayname":"F5XC DNS Management Subscription API","x-ves-proto-service":"ves.io.schema.dns_zone.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/dns/namespaces/system/dns_management/addon/unsubscribe":{"post":{"summary":"Unsubscribe to DNS Management","description":"Unsubscribe to DNS Management","operationId":"ves.io.schema.dns_zone.subscription.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-dns_zone-subscription-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.dns_zone.subscription.CustomAPI.Unsubscribe"},"x-displayname":"F5XC DNS Management Subscription API","x-ves-proto-service":"ves.io.schema.dns_zone.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5XC DNS Management Subscription API","x-ves-proto-package":"ves.io.schema.dns_zone.subscription","components":{"schemas":{"subscriptionSubscribeRequest":{"type":"object","description":"Request to subscribe to DNS Management","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.dns_zone.subscription.SubscribeRequest"},"subscriptionSubscribeResponse":{"type":"object","description":"Response of subscribe to DNS Management","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.dns_zone.subscription.SubscribeResponse"},"subscriptionUnsubscribeRequest":{"type":"object","description":"Request to unsubscribe to DNS Management","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.dns_zone.subscription.UnsubscribeRequest"},"subscriptionUnsubscribeResponse":{"type":"object","description":"Response of unsubscribe to DNS Management","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.dns_zone.subscription.UnsubscribeResponse"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0107.public.ves.io.schema.malware_protection.subscription.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.malware_protection.subscription","description":"Use this API to subscribe to F5XC Malware Protection","version":""},"paths":{"/api/config/namespaces/system/malware_protection/addon/subscribe":{"post":{"summary":"Subscribe to Malware Protection","description":"Subscribe to Malware Protection","operationId":"ves.io.schema.malware_protection.subscription.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-malware_protection-subscription-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.malware_protection.subscription.CustomAPI.Subscribe"},"x-displayname":"F5XC Malware Protection Subscription API","x-ves-proto-service":"ves.io.schema.malware_protection.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/system/malware_protection/addon/unsubscribe":{"post":{"summary":"Unsubscribe to Malware Protection","description":"Unsubscribe to Malware Protection","operationId":"ves.io.schema.malware_protection.subscription.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-malware_protection-subscription-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.malware_protection.subscription.CustomAPI.Unsubscribe"},"x-displayname":"F5XC Malware Protection Subscription API","x-ves-proto-service":"ves.io.schema.malware_protection.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5XC Malware Protection Subscription API","x-ves-proto-package":"ves.io.schema.malware_protection.subscription","components":{"schemas":{"subscriptionSubscribeRequest":{"type":"object","description":"Request to subscribe to Malware Protection","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.malware_protection.subscription.SubscribeRequest"},"subscriptionSubscribeResponse":{"type":"object","description":"Response of subscribe to Malware Protection","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.malware_protection.subscription.SubscribeResponse"},"subscriptionUnsubscribeRequest":{"type":"object","description":"Request to unsubscribe to Malware Protection","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.malware_protection.subscription.UnsubscribeRequest"},"subscriptionUnsubscribeResponse":{"type":"object","description":"Response of unsubscribe to Malware Protection","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.malware_protection.subscription.UnsubscribeResponse"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.secret_management","description":"F5XC Secret Management service serves APIs for information required for offline secret encryption such as getting the public key and getting the secret policy document.","version":""},"paths":{"/api/secret_management/get_public_key":{"get":{"summary":"Public Key","description":"GetPublicKey API returns public part of the volterra secret management key that needs to be given to volterra secret management tool to do secret encryption.","operationId":"ves.io.schema.secret_management.CustomAPI.GetPublicKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secret_managementGetPublicKeyResponse"}}}},"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":"key_version","description":"x-example: \"0\"\nThe version of public key","in":"query","required":false,"x-displayname":"Key Version","schema":{"type":"integer","format":"int64"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-secret_management-customapi-getpublickey"},"x-ves-proto-rpc":"ves.io.schema.secret_management.CustomAPI.GetPublicKey"},"x-displayname":"F5XC Secret Management","x-ves-proto-service":"ves.io.schema.secret_management.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/{namespace}/secret_policys/{name}/get_policy_document":{"get":{"summary":"Policy Document","description":"GetPolicyDocument API returns secret policy document for the given policy that contains information about all the rules in the policy and policy_id.\nThis document can be given to volterra secret management tool to do secret encryption.","operationId":"ves.io.schema.secret_management.CustomAPI.GetPolicyDocument","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secret_managementGetPolicyDocumentResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-required\nx-example: \"system\"\nNamespace of the secret policy","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-required\nx-example: \"site-secret-policy\"\nName of the secret policy","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-secret_management-customapi-getpolicydocument"},"x-ves-proto-rpc":"ves.io.schema.secret_management.CustomAPI.GetPolicyDocument"},"x-displayname":"F5XC Secret Management","x-ves-proto-service":"ves.io.schema.secret_management.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5XC Secret Management","x-ves-proto-package":"ves.io.schema.secret_management","components":{"schemas":{"policyMatcherType":{"type":"object","description":"A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.","title":"MatcherType","x-displayname":"Matcher","x-ves-proto-message":"ves.io.schema.policy.MatcherType","properties":{"exact_values":{"type":"array","description":" A list of exact values to match the input against.\n\nExample: ` \"['new york', 'london', 'sydney', 'tokyo', 'cairo']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"exact values","maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Exact Values","x-ves-example":"['new york', 'london', 'sydney', 'tokyo', 'cairo']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"regex_values":{"type":"array","description":" A list of regular expressions to match the input against.\n\nExample: ` \"['^new .*$', 'san f.*', '.* del .*']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.items.string.regex: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"regex values","maxItems":16,"items":{"type":"string","maxLength":256},"x-displayname":"Regex Values","x-ves-example":"['^new .*$', 'san f.*', '.* del .*']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.items.string.regex":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"transformers":{"type":"array","description":" An ordered list of transformers (starting from index 0) to be applied to the path before matching.\n\nExample: ` \"[BASE64_DECODE, LOWER_CASE]`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 9\n  ves.io.schema.rules.repeated.unique: true\n","title":"transformers","maxItems":9,"items":{"$ref":"#/components/schemas/policyTransformer"},"x-displayname":"Transformers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"9","ves.io.schema.rules.repeated.unique":"true"}}}},"policyRuleAction":{"type":"string","description":"The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds\nforward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to the originator. If\nit matches a rule with a NEXT_POLICY_SET action, evaluation of the current policy set terminates and evaluation of the next policy set in the chain begins.\n\n - DENY: DENY\n\nDeny the request.\n - ALLOW: ALLOW\n\nAllow the request to proceed.\n - NEXT_POLICY_SET: NEXT_POLICY_SET\n\nTerminate evaluation of the current policy set and begin evaluating the next policy set in the chain. Note that the evaluation of any remaining policies\nin the current policy set is skipped.\n - NEXT_POLICY: NEXT_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the next policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n - LAST_POLICY: LAST_POLICY\n\nTerminate evaluation of the current policy and begin evaluating the last policy in the policy set. Note that the evaluation of any remaining rules in the\ncurrent policy is skipped.\n - GOTO_POLICY: GOTO_POLICY\n\nTerminate evaluation of the current policy and begin evaluating a specific policy in the policy set. The policy is specified using the goto_policy field in\nthe rule and must be after the current policy in the policy set.","title":"Rule Action","enum":["DENY","ALLOW","NEXT_POLICY"],"default":"DENY","x-displayname":"Rule Action","x-ves-proto-enum":"ves.io.schema.policy.RuleAction"},"policyRuleCombiningAlgorithm":{"type":"string","description":"The rule combining algorithm for a policy determines how the list of rules in the policy is evaluated.\nIf any of the rules is configured with a App Firewall action, the rule combining algorithm must be configured to be FIRST_MATCH.\n\n- FIRST_MATCH Rules are evaluated sequentially till a matching rule is identified\n- ALLOW_OVERRIDES Rules with an ALLOW action are evaluated prior to rules with a DENY action\n- DENY_OVERRIDES Rules with a DENY action are evaluated prior to rules with an ALLOW action\n\n - FIRST_MATCH: First Match\n\nRules are evaluated sequentially till a matching rule is identified\n - DENY_OVERRIDES: Deny Overrides\n\nRules with a DENY action are evaluated prior to rules with an ALLOW action\n - ALLOW_OVERRIDES: Allow Overrides\n\nRules with an ALLOW action are evaluated prior to rules with a DENY action","title":"RuleCombiningAlgorithm","enum":["FIRST_MATCH","DENY_OVERRIDES","ALLOW_OVERRIDES"],"default":"FIRST_MATCH","x-displayname":"Rule Combining Algorithm","x-ves-proto-enum":"ves.io.schema.policy.RuleCombiningAlgorithm"},"policyTransformer":{"type":"string","description":"Transformers to be applied on the part of the request before matching.\n\n - TRANSFORMER_NONE: transformer none\n\nNo transformers enabled\n - LOWER_CASE: lower case\n\nConvert string to lower case\n - UPPER_CASE: upper case\n\nConvert string to upper case\n - BASE64_DECODE: base64 decode\n\nDecode string assuming base64 encoding\n - NORMALIZE_PATH: normalize path\n\nNormalize URL path so that /a/b/../c will be transformed to /a/c\n - REMOVE_WHITESPACE: remove whitespace\n\nRemove whitespaces\n - URL_DECODE: URL decode\n\nDecode string assuming URL encoding as per rfc1738\n - TRIM_LEFT: trim left\n\nRemove whitespace from the left side of the input string\n - TRIM_RIGHT: trim right\n\nRemove whitespace from the right side of the input string\n - TRIM: trim\n\nRemove whitespace from the both sides of the input string","title":"Transformer","enum":["LOWER_CASE","UPPER_CASE","BASE64_DECODE","NORMALIZE_PATH","REMOVE_WHITESPACE","URL_DECODE","TRIM_LEFT","TRIM_RIGHT","TRIM"],"default":"TRANSFORMER_NONE","x-displayname":"Transformer","x-ves-proto-enum":"ves.io.schema.policy.Transformer"},"schemaLabelMatcherType":{"type":"object","description":"x-displayName: \"Label Matcher\"\nA label matcher specifies a list of label keys whose values need to match for\nsource/client and destination/server. Note that the actual label values are not\nspecified and do not matter. This allows an ability to scope grouping by the\nlabel key name.","title":"LabelMatcherType","properties":{"keys":{"type":"array","description":"x-displayName: \"Keys\"\nx-example: \"['environment', 'location', 'deployment']\"\nThe list of label key names that have to match","title":"keys","items":{"type":"string"}}}},"schemaLabelSelectorType":{"type":"object","description":"This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expresssions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nexpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax>         ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement>             ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction>   ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion>     ::= <inclusion> | <exclusion>\n<exclusion>               ::= \"notin\"\n<inclusion>               ::= \"in\"\n<value-set>               ::= \"(\" <values> \")\"\n<values>                  ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE","title":"LabelSelectorType","x-displayname":"Label Selector","x-ves-proto-message":"ves.io.schema.LabelSelectorType","properties":{"expressions":{"type":"array","description":" expressions contains the kubernetes style label expression for selections.\n\nExample: ` \"region in (us-west1, us-west2),tier in (staging)\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.k8s_label_selector: true\n  ves.io.schema.rules.repeated.items.string.max_len: 4096\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"expressions","maxItems":1,"items":{"type":"string","minLength":1,"maxLength":4096},"x-displayname":"Selector Expression","x-ves-example":"region in (us-west1, us-west2),tier in (staging)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.k8s_label_selector":"true","ves.io.schema.rules.repeated.items.string.max_len":"4096","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemasecret_policy_ruleGlobalSpecType":{"type":"object","description":"A secret_policy_rule object consists of an unordered list of predicates and an action.\nThe predicates are evaluated against a set of input fields that are extracted from client certificate.\nA rule is considered to match if all predicates in the rule evaluate to true for that request.\nAny predicates that are not specified in a rule are implicitly considered to be true.\nIf a rule is matched, the action specified for the rule is enforced for that request.\n\nA secret_policy_rule can be part of exactly one secret_policy and must belong to the same namespace as the secret policy.","title":"Secret Policy Rule Specifications","x-displayname":"Global Specifications","x-ves-oneof-field-client_choice":"[\"client_name\",\"client_name_matcher\",\"client_selector\"]","x-ves-proto-message":"ves.io.schema.secret_policy_rule.GlobalSpecType","properties":{"action":{"$ref":"#/components/schemas/policyRuleAction"},"client_name":{"type":"string","description":"Exclusive with [client_name_matcher client_selector]\n The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate.\n This predicate evaluates to true if client name matches the configured name\n\nExample: ` \"ver.re01.int.ves.io\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"client name","maxLength":256,"x-displayname":"Client Name","x-ves-example":"ver.re01.int.ves.io","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256"}},"client_name_matcher":{"$ref":"#/components/schemas/policyMatcherType"},"client_selector":{"$ref":"#/components/schemas/schemaLabelSelectorType"}}},"secret_managementGetPolicyDocumentResponse":{"type":"object","description":"Policy Document contains the information about the secret policy and all the secret policy rules for the policy.\nThis document can be given to volterra secret management tool to do secret encryption.","title":"GetPolicyDocumentResponse","x-displayname":"Policy Document","x-ves-proto-message":"ves.io.schema.secret_management.GetPolicyDocumentResponse","properties":{"data":{"$ref":"#/components/schemas/secret_managementPolicyData"}}},"secret_managementGetPublicKeyResponse":{"type":"object","description":"F5XC Secret Management uses asymmetric cryptography for securing secrets.\nEach tenant will be assigned a <public,private> keypair for secret management at registration time.\nWhile private part of the key never leaves volterra secret management, public part of this asymmetric key is used for secret encryption.\nget_public_key_response is the response to the get_public_key API and holds the public key for secret encryption.","title":"GetPublicKeyResponse","x-displayname":"Public Key","x-ves-proto-message":"ves.io.schema.secret_management.GetPublicKeyResponse","properties":{"data":{"$ref":"#/components/schemas/secret_managementKeyData"}}},"secret_managementKeyData":{"type":"object","description":"F5XC Secret Management uses asymmetric cryptography for securing secrets.\nEach tenant will be assigned a <public,private> keypair for secret management at registration time.\nWhile private part of the key never leaves volterra secret management, public part of this asymmetric key is used for secret encryption.\nkey_data holds the public key for secret encryption.","title":"KeyData","x-displayname":"Public Key","x-ves-proto-message":"ves.io.schema.secret_management.KeyData","properties":{"key_version":{"type":"integer","description":"\n\nExample: ` \"1\"`","title":"key_version","format":"int64","x-displayname":"Version of the key","x-ves-example":"1"},"modulus_base64":{"type":"string","description":" Modulus as Base64 encoded string\n\nExample: ` \"value\"`","title":"modulus_base64","x-displayname":"Modulus","x-ves-example":"value"},"public_exponent_base64":{"type":"string","description":" Public Exponent as Base64 encoded string\n\nExample: ` \"value\"`","title":"public_exponent_base64","x-displayname":"Public Exponent","x-ves-example":"value"},"tenant":{"type":"string","description":" Tenant of the public key\n\nExample: ` \"ves-io\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"ves-io"}}},"secret_managementPolicyData":{"type":"object","description":"policy_data contains the information about the secret policy and all the secret policy rules for the policy.","title":"PolicyData","x-displayname":"Policy Data","x-ves-proto-message":"ves.io.schema.secret_management.PolicyData","properties":{"name":{"type":"string","description":" Name of the policy\n\nExample: ` \"volterra-secret-policy\"`","title":"name","x-displayname":"Name","x-ves-example":"volterra-secret-policy"},"namespace":{"type":"string","description":" Namespace of the policy\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"policy_id":{"type":"string","description":" PolicyID for the policy. PolicyID is an integer ID which uniquely identifies the policy in given tenant.\n\nExample: ` \"101\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint64.gte: 0\n  ves.io.schema.rules.uint64.lte: 2147483647\n","title":"policy_id","format":"uint64","x-displayname":"PolicyID","x-ves-example":"101","x-ves-validation-rules":{"ves.io.schema.rules.uint64.gte":"0","ves.io.schema.rules.uint64.lte":"2147483647"}},"policy_info":{"$ref":"#/components/schemas/secret_managementPolicyInfoType"},"tenant":{"type":"string","description":" Tenant for the policy\n\nExample: ` \"ves-io\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"ves-io"}}},"secret_managementPolicyInfoType":{"type":"object","description":"policy_information contains the shape and specifications of the secret policy.","title":"PolicyInfoType","x-displayname":"Policy Information","x-ves-proto-message":"ves.io.schema.secret_management.PolicyInfoType","properties":{"algo":{"$ref":"#/components/schemas/policyRuleCombiningAlgorithm"},"rules":{"type":"array","description":" A list of references to secret_policy_rule objects.\n The order of evaluation of the rules depends on the rule combining algorithm.","title":"Rules","items":{"$ref":"#/components/schemas/schemasecret_policy_ruleGlobalSpecType"},"x-displayname":"Secret Policy Rules"}}}}}}