@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.network_firewall","description":"Network Firewall is applicable when referred to by a Fleet. The Network Firewall will be applied to all\nsites that are member of the referring Fleet.\n\nIt is applied on all virtual networks that are valid on this site that get instantiated due to fleet object.\nNetwork Firewall defines following,\n- network_policy_set - L3/L4 policies to be applied in all sites that are member of the fleet\n- forward_proxy_policy_set - L7 firewall to be applied in all sites that are member of the fleet\n- fast_acl_set - List of Fast ACL set to be applied in all sites that are member of the fleet.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/network_firewalls":{"post":{"summary":"Create Network Firewall","description":"network firewall is created by users in system namespace","operationId":"ves.io.schema.network_firewall.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_firewallCreateResponse"}}}},"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/network_firewallCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_firewall-api-create"},"x-ves-proto-rpc":"ves.io.schema.network_firewall.API.Create"},"x-displayname":"Network Firewall","x-ves-proto-service":"ves.io.schema.network_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/network_firewalls/{metadata.name}":{"put":{"summary":"Replace Network Firewall","description":"Replace network firewall  will replace the contains of given object","operationId":"ves.io.schema.network_firewall.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_firewallReplaceResponse"}}}},"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/network_firewallReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_firewall-api-replace"},"x-ves-proto-rpc":"ves.io.schema.network_firewall.API.Replace"},"x-displayname":"Network Firewall","x-ves-proto-service":"ves.io.schema.network_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/network_firewalls":{"get":{"summary":"List Network Firewall","description":"List the set of network_firewall in a namespace","operationId":"ves.io.schema.network_firewall.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_firewallListResponse"}}}},"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 network_firewall","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-network_firewall-api-list"},"x-ves-proto-rpc":"ves.io.schema.network_firewall.API.List"},"x-displayname":"Network Firewall","x-ves-proto-service":"ves.io.schema.network_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/network_firewalls/{name}":{"get":{"summary":"Get Network Firewall","description":"Get network firewall in system namespace","operationId":"ves.io.schema.network_firewall.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_firewallGetResponse"}}}},"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-network_firewall-api-get"},"x-ves-proto-rpc":"ves.io.schema.network_firewall.API.Get"},"delete":{"summary":"Delete Network Firewall","description":"Delete the specified network_firewall","operationId":"ves.io.schema.network_firewall.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/network_firewallDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_firewall-api-delete"},"x-ves-proto-rpc":"ves.io.schema.network_firewall.API.Delete"},"x-displayname":"Network Firewall","x-ves-proto-service":"ves.io.schema.network_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Network Firewall","x-ves-proto-package":"ves.io.schema.network_firewall","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"network_firewallActiveEnhancedFirewallPoliciesType":{"type":"object","description":"List of Enhanced Firewall Policies\nThese policies use session-based rules and provide all options available under firewall policies\nwith an additional option for service insertion.","title":"Active Enhanced Firewall Policies Type","x-displayname":"Active Enhanced Network Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveEnhancedFirewallPoliciesType","properties":{"enhanced_firewall_policies":{"type":"array","description":" Ordered List of Enhanced Firewall Policies active\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Enhanced Firewall Policy","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Enhanced Firewall Policy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"network_firewallActiveFastACLsType":{"type":"object","description":"List of Fast ACL(s).","title":"Active Fast ACL Type","x-displayname":"Active Fast ACL(s)","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveFastACLsType","properties":{"fast_acls":{"type":"array","description":" Ordered List of Fast ACL(s) active for this network firewall\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Fast ACL","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Fast ACL(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"network_firewallActiveForwardProxyPoliciesType":{"type":"object","description":"Ordered List of Forward Proxy Policies active","title":"Active Forward Proxy Policies Type","x-displayname":"Active Forward Proxy Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveForwardProxyPoliciesType","properties":{"forward_proxy_policies":{"type":"array","description":" Ordered List of Forward Proxy Policies active\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Forward Proxy Policies","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Forward Proxy Policies","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"network_firewallActiveNetworkPoliciesType":{"type":"object","description":"List of firewall policy views.","title":"Active Firewall Policies Type","x-displayname":"Active Firewall Policies Type","x-ves-proto-message":"ves.io.schema.network_firewall.ActiveNetworkPoliciesType","properties":{"network_policies":{"type":"array","description":" Ordered List of Firewall Policies active for this network firewall\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Firewall Policy","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Firewall Policy","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"network_firewallCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of network_firewall","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.network_firewall.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/network_firewallCreateSpecType"}}},"network_firewallCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.network_firewall.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/network_firewallGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"network_firewallCreateSpecType":{"type":"object","description":"network firewall is created by users in system namespace","title":"Create network firewall","x-displayname":"Create Network Firewall","x-ves-oneof-field-fast_acl_choice":"[\"active_fast_acls\",\"disable_fast_acl\"]","x-ves-oneof-field-forward_proxy_policy_choice":"[\"active_forward_proxy_policies\",\"disable_forward_proxy_policy\"]","x-ves-oneof-field-network_policy_choice":"[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"disable_network_policy\"]","x-ves-proto-message":"ves.io.schema.network_firewall.CreateSpecType","properties":{"active_enhanced_firewall_policies":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_fast_acls":{"$ref":"#/components/schemas/network_firewallActiveFastACLsType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"active_network_policies":{"$ref":"#/components/schemas/network_firewallActiveNetworkPoliciesType"},"disable_fast_acl":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_forward_proxy_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"network_firewallDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a network_firewall","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.network_firewall.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"}}},"network_firewallGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read network_firewall","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.network_firewall.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/network_firewallCreateRequest"},"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/network_firewallReplaceRequest"},"spec":{"$ref":"#/components/schemas/network_firewallGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/network_firewallStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"network_firewallGetResponseFormatCode":{"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"},"network_firewallGetSpecType":{"type":"object","description":"Get network firewall in system namespace","title":"Get network firewall","x-displayname":"Get Network Firewall","x-ves-oneof-field-fast_acl_choice":"[\"active_fast_acls\",\"disable_fast_acl\"]","x-ves-oneof-field-forward_proxy_policy_choice":"[\"active_forward_proxy_policies\",\"disable_forward_proxy_policy\"]","x-ves-oneof-field-network_policy_choice":"[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"disable_network_policy\"]","x-ves-proto-message":"ves.io.schema.network_firewall.GetSpecType","properties":{"active_enhanced_firewall_policies":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_fast_acls":{"$ref":"#/components/schemas/network_firewallActiveFastACLsType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"active_network_policies":{"$ref":"#/components/schemas/network_firewallActiveNetworkPoliciesType"},"disable_fast_acl":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_forward_proxy_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"network_firewallListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of network_firewall","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.network_firewall.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/network_firewallListResponseItem"},"x-displayname":"Items"}}},"network_firewallListResponseItem":{"type":"object","description":"By default a summary of network_firewall 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 network_firewall","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.network_firewall.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this network_firewall","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this network_firewall","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates network_firewall is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/network_firewallGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this network_firewall","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this network_firewall\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/network_firewallStatusObject"},"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 network_firewall\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"network_firewallNetworkFirewallStatus":{"type":"object","description":"Network Firewall status provides the installed status of network firewall","title":"Network firewall status","x-displayname":"Network Firewall Status","x-ves-proto-message":"ves.io.schema.network_firewall.NetworkFirewallStatus","properties":{"installed":{"type":"boolean","description":" Installed status of network firewall","title":"installed","format":"boolean","x-displayname":"Installed"}}},"network_firewallReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a network_firewall","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.network_firewall.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/network_firewallReplaceSpecType"}}},"network_firewallReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.network_firewall.ReplaceResponse"},"network_firewallReplaceSpecType":{"type":"object","description":"Replace network firewall  will replace the contains of given object","title":"Replace network firewall","x-displayname":"Replace Network Firewall","x-ves-oneof-field-fast_acl_choice":"[\"active_fast_acls\",\"disable_fast_acl\"]","x-ves-oneof-field-forward_proxy_policy_choice":"[\"active_forward_proxy_policies\",\"disable_forward_proxy_policy\"]","x-ves-oneof-field-network_policy_choice":"[\"active_enhanced_firewall_policies\",\"active_network_policies\",\"disable_network_policy\"]","x-ves-proto-message":"ves.io.schema.network_firewall.ReplaceSpecType","properties":{"active_enhanced_firewall_policies":{"$ref":"#/components/schemas/network_firewallActiveEnhancedFirewallPoliciesType"},"active_fast_acls":{"$ref":"#/components/schemas/network_firewallActiveFastACLsType"},"active_forward_proxy_policies":{"$ref":"#/components/schemas/network_firewallActiveForwardProxyPoliciesType"},"active_network_policies":{"$ref":"#/components/schemas/network_firewallActiveNetworkPoliciesType"},"disable_fast_acl":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_forward_proxy_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_network_policy":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"network_firewallStatusObject":{"type":"object","description":"Shape of the  network firewall status","title":"Most recently observed status of object","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.network_firewall.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Refernce to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"status":{"$ref":"#/components/schemas/network_firewallNetworkFirewallStatus"}}},"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"}}},"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"}}},"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.0171.public.ves.io.schema.network_interface.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.network_interface","description":"Network Interface object represents the configuration of a network device in a fleet of\nF5XC Customer Edge sites. The following properties can be configured in this object:\n\n   IP address allocation scheme of the network interface (dhcp or static). Virtual Network of this network interface, Whether to run a DHCP server on this interface\n\n      Subnet to use for allocation\n\n      Default gateway\n\n      DNS server\n\n Interfaces belonging to site local inside and site local outside networks have to be configured as part of\n bootstrap configuration. This configuration can be done in two ways:\n\n     during site registration and is bundled as part of certified hardware image.\n\n     configured locally on the CE via Sia application\n\n Interfaces corresponding to these local interfaces can be configured in the global configuration. Label\n assignments for the local interfaces can be done in the global network interface configuration. Also, DHCP\n can be still be configured on site local inside network interface configuration, so that dynamic address is\n obtained and used.\n\n When DHCP address assignment (server) is enabled in the Network interface, external clients can get their addresses\n assigned from the configured subnet. The local interface can also get a dynamic address from the same pool if DHCP\n client is enabled in the network interface. Gateway and DNS servers for such clients can be external addresses or\n addresses internally allocated from the same subnet or may be disabled.\n\n Note that DHCP client and server configuration are independent. A Network interface may have DHCP client configured\n and DHCP server disabled, if an external DHCP server is used.\n\n Currently, DHCP client should always be enabled, setting static address on a network interface is not supported.\n\n If this Network interface is for primary network device (site local), then it has to be configured only as\n DHCP assigned address. This interface will be used to reach volterra cloud for registration. Virtual network\n of this interface has to be site local network. If there are multiple interfaces and multiple virtual\n networks, then site local interface has to be in the outside network.\n\n If network has Network interface with DHCP address assignment configured, then default gateway and DNS server\n for this network will be taken from DHCP response. Having multiple interfaces in a network giving default route\n can cause bad routing decisions. In case of site local network, DNS and default gateway response from primary\n interface will be used.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/network_interfaces":{"post":{"summary":"Create Network Interface","description":"Network interface represents configuration of a network device.\nIt is created by users in system namespace.","operationId":"ves.io.schema.network_interface.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_interfaceCreateResponse"}}}},"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/network_interfaceCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_interface-api-create"},"x-ves-proto-rpc":"ves.io.schema.network_interface.API.Create"},"x-displayname":"Network Interface","x-ves-proto-service":"ves.io.schema.network_interface.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}":{"put":{"summary":"Replace Network Interface","description":"Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.","operationId":"ves.io.schema.network_interface.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_interfaceReplaceResponse"}}}},"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/network_interfaceReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_interface-api-replace"},"x-ves-proto-rpc":"ves.io.schema.network_interface.API.Replace"},"x-displayname":"Network Interface","x-ves-proto-service":"ves.io.schema.network_interface.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/network_interfaces":{"get":{"summary":"List Network Interface","description":"List the set of network_interface in a namespace","operationId":"ves.io.schema.network_interface.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_interfaceListResponse"}}}},"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 network_interface","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-network_interface-api-list"},"x-ves-proto-rpc":"ves.io.schema.network_interface.API.List"},"x-displayname":"Network Interface","x-ves-proto-service":"ves.io.schema.network_interface.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/network_interfaces/{name}":{"get":{"summary":"Get Network Interface","description":"Get network interface from system namespace","operationId":"ves.io.schema.network_interface.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/network_interfaceGetResponse"}}}},"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-network_interface-api-get"},"x-ves-proto-rpc":"ves.io.schema.network_interface.API.Get"},"delete":{"summary":"Delete Network Interface","description":"Delete the specified network_interface","operationId":"ves.io.schema.network_interface.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/network_interfaceDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-network_interface-api-delete"},"x-ves-proto-rpc":"ves.io.schema.network_interface.API.Delete"},"x-displayname":"Network Interface","x-ves-proto-service":"ves.io.schema.network_interface.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Network Interface","x-ves-proto-package":"ves.io.schema.network_interface","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"network_interfaceCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of network_interface","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.network_interface.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/network_interfaceCreateSpecType"}}},"network_interfaceCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.network_interface.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/network_interfaceGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"network_interfaceCreateSpecType":{"type":"object","description":"Network interface represents configuration of a network device.\nIt is created by users in system namespace.","title":"Create network interface","x-displayname":"Create Network Interface","x-ves-oneof-field-interface_choice":"[\"dedicated_interface\",\"dedicated_management_interface\",\"ethernet_interface\",\"layer2_interface\",\"tunnel_interface\"]","x-ves-proto-message":"ves.io.schema.network_interface.CreateSpecType","properties":{"dedicated_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedInterfaceType"},"dedicated_management_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedManagementInterfaceType"},"ethernet_interface":{"$ref":"#/components/schemas/network_interfaceEthernetInterfaceType"},"layer2_interface":{"$ref":"#/components/schemas/network_interfaceLayer2InterfaceType"},"tunnel_interface":{"$ref":"#/components/schemas/network_interfaceTunnelInterfaceType"}}},"network_interfaceDHCPIPV6NetworkType":{"type":"object","description":"DHCP IPV6 network type configuration","title":"DHCPIPV6NetworkType","x-displayname":"DHCPIPV6NetworkType","x-ves-displayorder":"1,5,4","x-ves-oneof-field-network_prefix_choice":"[\"network_prefix\"]","x-ves-proto-message":"ves.io.schema.network_interface.DHCPIPV6NetworkType","properties":{"network_prefix":{"type":"string","description":"Exclusive with []\n Network Prefix to be used for IPV6 address auto configuration\n\nExample: ` \"2001::0/64\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6_prefix: true\n","title":"Network Prefix","x-displayname":"Network Prefix","x-ves-example":"2001::0/64","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6_prefix":"true"}},"pool_settings":{"$ref":"#/components/schemas/network_interfaceDHCPPoolSettingType"},"pools":{"type":"array","description":" List of non overlapping ip address ranges.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"DHCP pools","maxItems":16,"items":{"$ref":"#/components/schemas/network_interfaceDHCPIPV6PoolType"},"x-displayname":"DHCP Pools","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}}}},"network_interfaceDHCPIPV6PoolType":{"type":"object","description":"DHCP IPV6 pool is a range of IP addresses (start ip and end ip).","title":"DHCP IPV6 Range","x-displayname":"DHCP IPV6 Range","x-ves-proto-message":"ves.io.schema.network_interface.DHCPIPV6PoolType","properties":{"end_ip":{"type":"string","description":" Ending IPV6 address of the pool range.\n In case of address allocator, offset is derived based on network prefix.\n\nExample: ` \"2001::200\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"End IP","x-displayname":"Ending IPV6","x-ves-example":"2001::200","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"start_ip":{"type":"string","description":" Starting IPV6 address of the pool range.\n In case of address allocator, offset is derived based on network prefix.\n 2001::1 with prefix length of 64, start offset is 5\n\nExample: ` \"2001::1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Start IPV6","x-displayname":"Starting IPV6","x-ves-example":"2001::1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"network_interfaceDHCPIPV6StatefulServer":{"type":"object","title":"DHCPIPV6StatefulServer","x-displayname":"DHCPIPV6 Stateful Server","x-ves-oneof-field-interfaces_addressing_choice":"[\"automatic_from_end\",\"automatic_from_start\",\"interface_ip_map\"]","x-ves-proto-message":"ves.io.schema.network_interface.DHCPIPV6StatefulServer","properties":{"automatic_from_end":{"$ref":"#/components/schemas/ioschemaEmpty"},"automatic_from_start":{"$ref":"#/components/schemas/ioschemaEmpty"},"dhcp_networks":{"type":"array","description":" List of networks from which DHCP server can allocate ip addresses\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"DHCP IPV6 Networks","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/network_interfaceDHCPIPV6NetworkType"},"x-displayname":"DHCP IPV6 Networks","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"fixed_ip_map":{"type":"object","description":" Fixed MAC address to ipv6 assignments, Key: Mac address, Value: IPV6 Address\n Assign fixed IPv6 addresses based on the MAC Address of the DHCP Client.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.mac: true\n  ves.io.schema.rules.map.max_pairs: 128\n  ves.io.schema.rules.map.unique_values: true\n  ves.io.schema.rules.map.values.string.ipv6: true\n","title":"Fixed IPV6 Assignments","x-displayname":"Fixed MAC Address to IPV6 Assignments","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.mac":"true","ves.io.schema.rules.map.max_pairs":"128","ves.io.schema.rules.map.unique_values":"true","ves.io.schema.rules.map.values.string.ipv6":"true"}},"interface_ip_map":{"$ref":"#/components/schemas/network_interfaceDHCPInterfaceIPV6Type"}}},"network_interfaceDHCPInterfaceIPType":{"type":"object","description":"Specify static IPv4 addresses per node.","title":"Interface IPv4 Assignments","x-displayname":"Interface IPv4 Assignments","x-ves-proto-message":"ves.io.schema.network_interface.DHCPInterfaceIPType","properties":{"interface_ip_map":{"type":"object","description":" Specify static IPv4 addresses per site:node.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 64\n  ves.io.schema.rules.map.values.string.ipv4: true\n","title":"Site:Node to IP mapping","x-displayname":"Site:Node to IPv4 Address Mapping","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"128","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"64","ves.io.schema.rules.map.values.string.ipv4":"true"}}}},"network_interfaceDHCPInterfaceIPV6Type":{"type":"object","description":"Map of Interface IPV6 assignments per node","title":"Interface IPV6 Assignments","x-displayname":"Interface IPV6 Assignments","x-ves-proto-message":"ves.io.schema.network_interface.DHCPInterfaceIPV6Type","properties":{"interface_ip_map":{"type":"object","description":" Map of Site:Node to IPV6 address.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 64\n  ves.io.schema.rules.map.values.string.ipv6: true\n","title":"Site:Node to IPV6 mapping","x-displayname":"Site:Node to IPV6 Mapping","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"128","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"64","ves.io.schema.rules.map.values.string.ipv6":"true"}}}},"network_interfaceDHCPNetworkType":{"type":"object","description":"DHCP network configuration","title":"DHCP Network","x-displayname":"DHCP Network","x-ves-displayorder":"1,12,4,5,9","x-ves-oneof-field-dns_choice":"[\"dns_address\",\"same_as_dgw\"]","x-ves-oneof-field-gateway_choice":"[\"dgw_address\",\"first_address\",\"last_address\"]","x-ves-oneof-field-network_prefix_choice":"[\"network_prefix\"]","x-ves-proto-message":"ves.io.schema.network_interface.DHCPNetworkType","properties":{"dgw_address":{"type":"string","description":"Exclusive with [first_address last_address]\n Enter a IPv4 address from the network prefix to be used as the default gateway.\n\nExample: ` \"10.1.1.10\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Configured Address","x-displayname":"Static IPv4 Configuration","x-ves-example":"10.1.1.10","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"dns_address":{"type":"string","description":"Exclusive with [same_as_dgw]\n Enter a IPv4 address from the network prefix to be used as the DNS server.\n\nExample: ` \"10.1.1.11\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Configured Address","x-displayname":"Static IPv4 Configuration","x-ves-example":"10.1.1.11","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"first_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"last_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"network_prefix":{"type":"string","description":"Exclusive with []\n Set the network prefix for the site. ex: 10.1.1.0/24\n\nExample: ` \"10.1.1.0/24\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4_prefix: true\n","title":"Network Prefix","x-displayname":"Network Prefix","x-ves-example":"10.1.1.0/24","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4_prefix":"true"}},"pool_settings":{"$ref":"#/components/schemas/network_interfaceDHCPPoolSettingType"},"pools":{"type":"array","description":" List of non overlapping ip address ranges.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"DHCP pools","maxItems":16,"items":{"$ref":"#/components/schemas/network_interfaceDHCPPoolType"},"x-displayname":"DHCP Pools","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"same_as_dgw":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"network_interfaceDHCPPoolSettingType":{"type":"string","description":"Identifies the how to pick the network for Interface.\n\nAddress ranges in DHCP pool list are used for IP Address allocation\nAddress ranges in DHCP pool list are excluded from IP Address allocation","title":"DHCP POOL SETTING","enum":["INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","EXCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS"],"default":"INCLUDE_IP_ADDRESSES_FROM_DHCP_POOLS","x-displayname":"Interface Network Type","x-ves-proto-enum":"ves.io.schema.network_interface.DHCPPoolSettingType"},"network_interfaceDHCPPoolType":{"type":"object","description":"DHCP pool is a range of IP addresses (start ip and end ip).","title":"DHCP IP Range","x-displayname":"DHCP IP Range","x-ves-proto-message":"ves.io.schema.network_interface.DHCPPoolType","properties":{"end_ip":{"type":"string","description":" Ending IP of the pool range.\n In case of address allocator, offset is derived based on network prefix.\n 10.1.1.200 with prefix length of 24, end offset is 0.0.0.200\n\nExample: ` \"10.1.1.200\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"End IP","x-displayname":"Ending IP","x-ves-example":"10.1.1.200","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}},"start_ip":{"type":"string","description":" Starting IP of the pool range.\n In case of address allocator, offset is derived based on network prefix.\n 10.1.1.5 with prefix length of 24, start offset is 0.0.0.5\n\nExample: ` \"10.1.1.5\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Start IP","x-displayname":"Starting IP","x-ves-example":"10.1.1.5","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"network_interfaceDHCPServerParametersType":{"type":"object","title":"DHCPServerParametersType","x-displayname":"DHCPServerParametersType","x-ves-oneof-field-interfaces_addressing_choice":"[\"automatic_from_end\",\"automatic_from_start\",\"interface_ip_map\"]","x-ves-proto-message":"ves.io.schema.network_interface.DHCPServerParametersType","properties":{"automatic_from_end":{"$ref":"#/components/schemas/ioschemaEmpty"},"automatic_from_start":{"$ref":"#/components/schemas/ioschemaEmpty"},"dhcp_networks":{"type":"array","description":" List of networks from which DHCP Server can allocate IPv4 Addresses\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"DHCP Networks","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/network_interfaceDHCPNetworkType"},"x-displayname":"DHCP Networks","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"fixed_ip_map":{"type":"object","description":" Assign fixed IPv4 addresses based on the MAC Address of the DHCP Client.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.mac: true\n  ves.io.schema.rules.map.max_pairs: 128\n  ves.io.schema.rules.map.unique_values: true\n  ves.io.schema.rules.map.values.string.ipv4: true\n","title":"Fixed IP Assignments","x-displayname":"Fixed MAC Address to IPv4 Assignments","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.mac":"true","ves.io.schema.rules.map.max_pairs":"128","ves.io.schema.rules.map.unique_values":"true","ves.io.schema.rules.map.values.string.ipv4":"true"}},"interface_ip_map":{"$ref":"#/components/schemas/network_interfaceDHCPInterfaceIPType"}}},"network_interfaceDedicatedInterfaceType":{"type":"object","description":"Dedicated Interface Configuration","title":"Dedicated Interface","x-displayname":"Dedicated Interface","x-ves-oneof-field-monitoring_choice":"[\"monitor\",\"monitor_disabled\"]","x-ves-oneof-field-node_choice":"[\"cluster\",\"node\"]","x-ves-oneof-field-primary_choice":"[\"is_primary\",\"not_primary\"]","x-ves-proto-message":"ves.io.schema.network_interface.DedicatedInterfaceType","properties":{"cluster":{"$ref":"#/components/schemas/ioschemaEmpty"},"device":{"type":"string","description":" Name of the device for which interface is configured. Use wwan0 for 4G/LTE.\n\nExample: ` \"eth0\"`\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: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Interface Device","x-ves-example":"eth0","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":"1"}},"is_primary":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitor":{"$ref":"#/components/schemas/network_interfaceLinkQualityMonitorConfig"},"monitor_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtu":{"type":"integer","description":" Maximum packet size (Maximum Transfer Unit) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"1450\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","title":"Maximum Packet Size (MTU)","format":"int64","x-displayname":"Maximum Packet Size (MTU)","x-ves-example":"1450","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"node":{"type":"string","description":"Exclusive with [cluster]\n Configuration will apply to a device on the given node of the site.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node","minLength":1,"maxLength":64,"x-displayname":"Specific Node","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"1"}},"not_primary":{"$ref":"#/components/schemas/ioschemaEmpty"},"priority":{"type":"integer","description":" Priority of the network interface when multiple network interfaces are present in outside network\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"42","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}}}},"network_interfaceDedicatedManagementInterfaceType":{"type":"object","description":"Dedicated Interface Configuration","title":"Dedicated Management Interface","x-displayname":"Dedicated Management Interface","x-ves-oneof-field-node_choice":"[\"cluster\",\"node\"]","x-ves-proto-message":"ves.io.schema.network_interface.DedicatedManagementInterfaceType","properties":{"cluster":{"$ref":"#/components/schemas/ioschemaEmpty"},"device":{"type":"string","description":" Name of the device for which interface is configured\n\nExample: ` \"eth0\"`\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: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Interface Device","x-ves-example":"eth0","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":"1"}},"mtu":{"type":"integer","description":" Maximum packet size (Maximum Transfer Unit) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"1450\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","title":"Maximum Packet Size (MTU)","format":"int64","x-displayname":"Maximum Packet Size (MTU)","x-ves-example":"1450","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"node":{"type":"string","description":"Exclusive with [cluster]\n Configuration will apply to a device on the given node of the site.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node","minLength":1,"maxLength":64,"x-displayname":"Specific Node","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"1"}}}},"network_interfaceDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a network_interface","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.network_interface.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"}}},"network_interfaceEthernetInterfaceType":{"type":"object","description":"Ethernet Interface Configuration","title":"Ethernet Interface","x-displayname":"Ethernet Interface","x-ves-oneof-field-address_choice":"[\"dhcp_client\",\"dhcp_server\",\"static_ip\"]","x-ves-oneof-field-ipv6_address_choice":"[\"ipv6_auto_config\",\"no_ipv6_address\",\"static_ipv6_address\"]","x-ves-oneof-field-monitoring_choice":"[\"monitor\",\"monitor_disabled\"]","x-ves-oneof-field-network_choice":"[\"segment_network\",\"site_local_inside_network\",\"site_local_network\",\"storage_network\"]","x-ves-oneof-field-node_choice":"[\"cluster\",\"node\"]","x-ves-oneof-field-primary_choice":"[\"is_primary\",\"not_primary\"]","x-ves-oneof-field-vlan_choice":"[\"untagged\",\"vlan_id\"]","x-ves-proto-message":"ves.io.schema.network_interface.EthernetInterfaceType","properties":{"cluster":{"$ref":"#/components/schemas/ioschemaEmpty"},"device":{"type":"string","description":" Interface configuration for the ethernet device\n\nExample: ` \"eth0\"`\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: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Ethernet Device","x-ves-example":"eth0","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":"1"}},"dhcp_client":{"$ref":"#/components/schemas/ioschemaEmpty"},"dhcp_server":{"$ref":"#/components/schemas/network_interfaceDHCPServerParametersType"},"ipv6_auto_config":{"$ref":"#/components/schemas/network_interfaceIPV6AutoConfigType"},"is_primary":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitor":{"$ref":"#/components/schemas/network_interfaceLinkQualityMonitorConfig"},"monitor_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtu":{"type":"integer","description":" Maximum packet size (Maximum Transfer Unit) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"1450\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","title":"Maximum Packet Size (MTU)","format":"int64","x-displayname":"Maximum Packet Size (MTU)","x-ves-example":"1450","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"no_ipv6_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"node":{"type":"string","description":"Exclusive with [cluster]\n Configuration will apply to a device on the given node.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node","minLength":1,"maxLength":64,"x-displayname":"Specific Node","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"1"}},"not_primary":{"$ref":"#/components/schemas/ioschemaEmpty"},"priority":{"type":"integer","description":" Priority of the network interface when multiple network interfaces are present in outside network\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"42","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}},"site_local_inside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIPParametersType"},"static_ipv6_address":{"$ref":"#/components/schemas/network_interfaceStaticIPParametersType"},"storage_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"untagged":{"$ref":"#/components/schemas/ioschemaEmpty"},"vlan_id":{"type":"integer","description":"Exclusive with [untagged]\n Configure a VLAN tagged ethernet interface\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 4095\n","title":"VLAN Id","format":"int64","x-displayname":"VLAN Id","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"4095"}}}},"network_interfaceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read network_interface","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.network_interface.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/network_interfaceCreateRequest"},"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/network_interfaceReplaceRequest"},"spec":{"$ref":"#/components/schemas/network_interfaceGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/network_interfaceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"network_interfaceGetResponseFormatCode":{"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"},"network_interfaceGetSpecType":{"type":"object","description":"Get network interface from system namespace","title":"Get network interface","x-displayname":"Get Network Interface","x-ves-oneof-field-interface_choice":"[\"dedicated_interface\",\"dedicated_management_interface\",\"ethernet_interface\",\"layer2_interface\",\"legacy_interface\",\"tunnel_interface\"]","x-ves-oneof-field-monitoring_choice":"[\"monitor\",\"monitor_disabled\"]","x-ves-proto-message":"ves.io.schema.network_interface.GetSpecType","properties":{"DHCP_server":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDHCPServer"},"DNS_server":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDNS"},"address_allocator":{"type":"array","description":" Reference to an address allocator for the network interface. When set, the allocator is used to\n allocate a subnet for the interface and an address from the subnet is set on the interface.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Address Allocator","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"dedicated_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedInterfaceType"},"dedicated_management_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedManagementInterfaceType"},"default_gateway":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDFGW"},"device_name":{"type":"string","description":" Name of the physical network interface device  which this network interface represents.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"Device Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"dhcp_address":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDHCP"},"ethernet_interface":{"$ref":"#/components/schemas/network_interfaceEthernetInterfaceType"},"interface_ip_map":{"type":"object","description":" Map of Site:Node to IP address offset. Key:Node, Value:Map\n Value of 10.1.1.5 with network prefix 24, offset is 0.0.0.5\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 64\n  ves.io.schema.rules.map.values.string.ipv4: true\n","x-displayname":"Site:Node to IP Mapping","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"128","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"64","ves.io.schema.rules.map.values.string.ipv4":"true"}},"is_primary":{"type":"boolean","description":" This interface is primary interface","format":"boolean","x-displayname":"Primary Interface"},"layer2_interface":{"$ref":"#/components/schemas/network_interfaceLayer2InterfaceType"},"legacy_interface":{"$ref":"#/components/schemas/network_interfaceLegacyInterfaceType"},"monitor":{"$ref":"#/components/schemas/network_interfaceLinkQualityMonitorConfig"},"monitor_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtu":{"type":"integer","description":" Maximum Transfer Unit (Max packet length) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","format":"int64","x-displayname":"MTU","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"priority":{"type":"integer","description":" Priority of the network interface when multiple network interfaces are present in the fleet object\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","format":"int64","x-displayname":"Priority","x-ves-example":"42","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}},"static_addresses":{"type":"array","description":" If DHCP server is enabled, configures the subnet to be used for IP allocation.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":16,"items":{"$ref":"#/components/schemas/schemaIpv4SubnetType"},"x-displayname":"Static IP","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"tunnel":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceTunnel"},"tunnel_interface":{"$ref":"#/components/schemas/network_interfaceTunnelInterfaceType"},"type":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceType"},"virtual_network":{"type":"array","description":" Virtual-network for the interface\n This is optional and can contain at most one entry\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Network","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"vlan_tag":{"type":"integer","description":" Vlan tag of the interface, valid only if VLAN tagging is enabled\n when vlan_tagging is enabled, value must be between 1 - 4094\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 4094\n","format":"int64","x-displayname":"VLAN Tag","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"4094"}},"vlan_tagging":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceVLANTagging"}}},"network_interfaceIPV6AutoConfigRouterType":{"type":"object","title":"IPV6AutoConfigRouterType","x-displayname":"IPV6AutoConfigRouterType","x-ves-oneof-field-address_choice":"[\"network_prefix\",\"stateful\"]","x-ves-proto-message":"ves.io.schema.network_interface.IPV6AutoConfigRouterType","properties":{"dns_config":{"$ref":"#/components/schemas/network_interfaceIPV6DnsConfig"},"network_prefix":{"type":"string","description":"Exclusive with [stateful]\n Nework prefix that is used as Prefix information\n Allowed only /64 prefix length as per RFC 4862\n\nExample: ` \"2001::0/64\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6_prefix: true\n  ves.io.schema.rules.string.pattern: .*::/64$\n","title":"Prefix Info","x-displayname":"Network Prefix","x-ves-example":"2001::0/64","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6_prefix":"true","ves.io.schema.rules.string.pattern":".*::/64$"}},"stateful":{"$ref":"#/components/schemas/network_interfaceDHCPIPV6StatefulServer"}}},"network_interfaceIPV6AutoConfigType":{"type":"object","title":"IPV6AutoConfigType","x-displayname":"IPV6AutoConfigType","x-ves-oneof-field-autoconfig_choice":"[\"host\",\"router\"]","x-ves-proto-message":"ves.io.schema.network_interface.IPV6AutoConfigType","properties":{"host":{"$ref":"#/components/schemas/ioschemaEmpty"},"router":{"$ref":"#/components/schemas/network_interfaceIPV6AutoConfigRouterType"}}},"network_interfaceIPV6DnsConfig":{"type":"object","title":"IPV6DnsConfig","x-displayname":"IPV6DnsConfig","x-ves-oneof-field-dns_choice":"[\"configured_list\",\"local_dns\"]","x-ves-proto-message":"ves.io.schema.network_interface.IPV6DnsConfig","properties":{"configured_list":{"$ref":"#/components/schemas/network_interfaceIPV6DnsList"},"local_dns":{"$ref":"#/components/schemas/network_interfaceIPV6LocalDnsAddress"}}},"network_interfaceIPV6DnsList":{"type":"object","title":"IPV6DnsList","x-displayname":"IPV6DnsList","x-ves-proto-message":"ves.io.schema.network_interface.IPV6DnsList","properties":{"dns_list":{"type":"array","description":" List of IPV6 Addresses acting as Dns servers\n\nExample: ` \"2001::11\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.ipv6: true\n","title":"Dns List","minItems":1,"maxItems":4,"items":{"type":"string"},"x-displayname":"Dns List","x-ves-example":"2001::11","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.ipv6":"true"}}}},"network_interfaceIPV6LocalDnsAddress":{"type":"object","title":"IPV6LocalDnsAddress","x-displayname":"IPV6LocalDnsAddress","x-ves-oneof-field-local_dns_choice":"[\"configured_address\",\"first_address\",\"last_address\"]","x-ves-proto-message":"ves.io.schema.network_interface.IPV6LocalDnsAddress","properties":{"configured_address":{"type":"string","description":"Exclusive with [first_address last_address]\n Configured address from the network prefix is chosen as dns server\n\nExample: ` \"2001::10\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"Configured Address","x-displayname":"Configured Address","x-ves-example":"2001::10","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}},"first_address":{"$ref":"#/components/schemas/ioschemaEmpty"},"last_address":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"network_interfaceLayer2InterfaceType":{"type":"object","description":"Layer2 Interface Configuration","title":"Layer2 interface","x-displayname":"Layer2 Interface","x-ves-oneof-field-layer2_interface_choice":"[\"l2sriov_interface\",\"l2vlan_interface\",\"l2vlan_slo_interface\"]","x-ves-proto-message":"ves.io.schema.network_interface.Layer2InterfaceType","properties":{"l2sriov_interface":{"$ref":"#/components/schemas/network_interfaceLayer2SriovInterfaceType"},"l2vlan_interface":{"$ref":"#/components/schemas/network_interfaceLayer2VlanInterfaceType"},"l2vlan_slo_interface":{"$ref":"#/components/schemas/network_interfaceLayer2SloVlanInterfaceType"}}},"network_interfaceLayer2SloVlanInterfaceType":{"type":"object","description":"Layer2 Site Local Outside VLAN Interface Configuration","title":"VLAN on Site Local Outside Interface","x-displayname":"VLAN on Site Local Outside Interface","x-ves-proto-message":"ves.io.schema.network_interface.Layer2SloVlanInterfaceType","properties":{"vlan_id":{"type":"integer","description":" VLAN Id\n\nExample: ` \"10\"`\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: 4095\n","title":"VLAN Id","format":"int64","x-displayname":"VLAN Id","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":"1","ves.io.schema.rules.uint32.lte":"4095"}}}},"network_interfaceLayer2SriovInterfaceType":{"type":"object","description":"Layer2 SR-IOV Interface Configuration","title":"Layer2 SR-IOV interface","x-displayname":"Layer2 SR-IOV Interface","x-ves-oneof-field-vlan_choice":"[\"untagged\",\"vlan_id\"]","x-ves-proto-message":"ves.io.schema.network_interface.Layer2SriovInterfaceType","properties":{"device":{"type":"string","description":" Physical ethernet interface\n\nExample: ` \"eth0\"`\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: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Ethernet Device","x-ves-example":"eth0","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":"1"}},"untagged":{"$ref":"#/components/schemas/ioschemaEmpty"},"vlan_id":{"type":"integer","description":"Exclusive with [untagged]\n Configure a VLAN tagged interface\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 4095\n","title":"VLAN Id","format":"int64","x-displayname":"VLAN Id","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"4095"}}}},"network_interfaceLayer2VlanInterfaceType":{"type":"object","description":"Layer2 VLAN Interface Configuration","title":"Layer2 VLAN interface","x-displayname":"Layer2 VLAN Interface","x-ves-proto-message":"ves.io.schema.network_interface.Layer2VlanInterfaceType","properties":{"device":{"type":"string","description":" Physical ethernet interface\n\nExample: ` \"eth0\"`\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: 1\n","title":"Device","minLength":1,"maxLength":64,"x-displayname":"Ethernet Device","x-ves-example":"eth0","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":"1"}},"vlan_id":{"type":"integer","description":" VLAN Id\n\nExample: ` \"10\"`\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: 4095\n","title":"VLAN Id","format":"int64","x-displayname":"VLAN Id","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":"1","ves.io.schema.rules.uint32.lte":"4095"}}}},"network_interfaceLegacyInterfaceType":{"type":"object","description":"Legacy Interface Configuration","title":"Legacy Configuration","x-displayname":"Legacy Configuration","x-ves-oneof-field-monitoring_choice":"[\"monitor\",\"monitor_disabled\"]","x-ves-proto-message":"ves.io.schema.network_interface.LegacyInterfaceType","properties":{"DHCP_server":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDHCPServer"},"DNS_server":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDNS"},"address_allocator":{"type":"array","description":" Reference to an address allocator for the network interface. When set, the allocator is used to\n allocate a subnet for the interface and an address from the subnet is set on the interface.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"Address Allocator","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Address Allocator","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"default_gateway":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDFGW"},"device_name":{"type":"string","description":" Name of the physical network interface device  which this network interface represents.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Device Name","x-displayname":"Device Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"dhcp_address":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDHCP"},"monitor":{"$ref":"#/components/schemas/network_interfaceLinkQualityMonitorConfig"},"monitor_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtu":{"type":"integer","description":" Maximum Transfer Unit (Max packet length) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","title":"Mtu","format":"int64","x-displayname":"MTU","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"priority":{"type":"integer","description":" Priority of the network interface when multiple network interfaces are present in the fleet object\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"42","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}},"static_addresses":{"type":"array","description":" If DHCP server is enabled, configures the subnet to be used for IP allocation.","title":"Static IP","items":{"$ref":"#/components/schemas/schemaIpv4SubnetType"},"x-displayname":"Static IP"},"tunnel":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceTunnel"},"type":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceType"},"virtual_network":{"type":"array","description":" Virtual-network for the interface\n This is optional and can contain at most one entry\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"Virtual Network","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Network","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"vlan_tag":{"type":"integer","description":" Vlan tag of the interface, valid only if VLAN tagging is enabled\n when vlan_tagging is enabled, value must be between 1 - 4094\n\nExample: ` \"0\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 4094\n","title":"Vlan Tag","format":"int64","x-displayname":"VLAN Tag","x-ves-example":"0","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"4094"}},"vlan_tagging":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceVLANTagging"}}},"network_interfaceLinkQualityMonitorConfig":{"type":"object","description":"Link Quality Monitoring configuration for a network interface.","title":"Link Quality Monitoring Configuration","x-displayname":"Link Quality Monitoring Configuration","x-ves-proto-message":"ves.io.schema.network_interface.LinkQualityMonitorConfig"},"network_interfaceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of network_interface","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.network_interface.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/network_interfaceListResponseItem"},"x-displayname":"Items"}}},"network_interfaceListResponseItem":{"type":"object","description":"By default a summary of network_interface 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 network_interface","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.network_interface.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this network_interface","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this network_interface","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates network_interface is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/network_interfaceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this network_interface","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this network_interface\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/network_interfaceStatusObject"},"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 network_interface\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"network_interfaceNetworkInterfaceDFGW":{"type":"object","description":"Controls how the Default Gateway of the Network interface is derived","title":"Network Interface Default Gateway","x-displayname":"Default Gateway","x-ves-proto-message":"ves.io.schema.network_interface.NetworkInterfaceDFGW","properties":{"default_gateway_address":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"default_gateway_mode":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceGatewayMode"}}},"network_interfaceNetworkInterfaceDHCP":{"type":"string","description":"Controls whether or not DHCP client is enabled on the interface\n\nDHCP client is disabled\nDHCP client is enabled","title":"Network Interface DHCP Client","enum":["NETWORK_INTERFACE_DHCP_DISABLE","NETWORK_INTERFACE_DHCP_ENABLE"],"default":"NETWORK_INTERFACE_DHCP_DISABLE","x-displayname":"DHCP Client","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceDHCP"},"network_interfaceNetworkInterfaceDHCPServer":{"type":"string","description":"Controls whether or not DHCP server runs on the interface\n\nDHCP server is disabled\nDHCP server is enabled\nEnhanced DHCP server is enabled","title":"Network Interface DHCP Server","enum":["NETWORK_INTERFACE_DHCP_SERVER_DISABLE","NETWORK_INTERFACE_DHCP_SERVER_ENABLE","NETWORK_INTERFACE_ENHANCED_DHCP_SERVER_ENABLE"],"default":"NETWORK_INTERFACE_DHCP_SERVER_DISABLE","x-displayname":"DHCP Server","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceDHCPServer"},"network_interfaceNetworkInterfaceDNS":{"type":"object","description":"Controls how the DNS Server of the Network interface is derived","title":"Network Interface DNS server","x-displayname":"DNS Server","x-ves-proto-message":"ves.io.schema.network_interface.NetworkInterfaceDNS","properties":{"dns_mode":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceDNSMode"},"dns_server":{"type":"array","description":" Address of DNS server when mode is \"use-configured\"","title":"DNS Server","items":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"x-displayname":"DNS Server"}}},"network_interfaceNetworkInterfaceDNSMode":{"type":"string","description":"Controls the mode of obtaining DNS address for the interface\n\nDNS is disabled\nDNS is allocated by the system\nUse the specified DNS","title":"Network Interface DNS Mode","enum":["NETWORK_INTERFACE_DNS_DISABLE","NETWORK_INTERFACE_DNS_AUTO_ALLOCATE","NETWORK_INTERFACE_DNS_USE_CONFIGURED"],"default":"NETWORK_INTERFACE_DNS_DISABLE","x-displayname":"DNS Mode","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceDNSMode"},"network_interfaceNetworkInterfaceGatewayMode":{"type":"string","description":"Controls the mode of obtaining gateway address for the interface\n\nGateway is disabled\nGateway is allocated by the system\nUse the specified gateway","title":"Network Interface Gateway Mode","enum":["NETWORK_INTERFACE_GATEWAY_DISABLE","NETWORK_INTERFACE_GATEWAY_AUTO_ALLOCATE","NETWORK_INTERFACE_GATEWAY_USE_CONFIGURED"],"default":"NETWORK_INTERFACE_GATEWAY_DISABLE","x-displayname":"Gateway Mode","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceGatewayMode"},"network_interfaceNetworkInterfaceStatus":{"type":"object","description":"Current Status of the Network interface","title":"Network Interface Status","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.network_interface.NetworkInterfaceStatus","properties":{"up_down":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceUpDown"}}},"network_interfaceNetworkInterfaceTunnel":{"type":"object","description":"Tunnel attached to this interface, enables encapsulation on interface","title":"Network Interface Tunnel","x-displayname":"Tunnel","x-ves-proto-message":"ves.io.schema.network_interface.NetworkInterfaceTunnel","properties":{"tunnel":{"type":"array","description":" Tunnel which is attached to this interface\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"Tunnel","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Tunnel","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"network_interfaceNetworkInterfaceType":{"type":"string","description":"Identifies the type of the interface.\n\nNetwork interface is an Ethernet interface\nNetwork interface is a VLAN interface\nNetwork interface is a bond interface running LACP\nNetwork interface is a tunnel interface\nNetwork interface is a loopback device\nNetwork interface is a layer2 interface","title":"Network Interface Type","enum":["NETWORK_INTERFACE_ETHERNET","NETWORK_INTERFACE_VLAN_INTERFACE","NETWORK_INTERFACE_LACP_INTERFACE","NETWORK_INTERFACE_TUNNEL_INTERFACE","NETWORK_INTERFACE_LOOPBACK_INTERFACE","NETWORK_INTERFACE_LAYER2_INTERFACE"],"default":"NETWORK_INTERFACE_ETHERNET","x-displayname":"Network Interface Type","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceType"},"network_interfaceNetworkInterfaceUpDown":{"type":"string","description":"Shows the interface link state\n\nInterface is admistratively down\nInterface is operationally down\nInterface is operationally up","title":"Interface State","enum":["NETWORK_INTERFACE_ADMINISTRATIVELY_DOWN","NETWORK_INTERFACE_OPERATIONALY_DOWN","NETWORK_INTERFACE_OPERATIONALY_UP"],"default":"NETWORK_INTERFACE_ADMINISTRATIVELY_DOWN","x-displayname":"Interface State","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceUpDown"},"network_interfaceNetworkInterfaceVLANTagging":{"type":"string","description":"Controls whether or not VLAN tagging is enabled on the interface\n\nVlan tagging is disabled\nVlan tagging is enabled","title":"Network Interface VLAN Tagging","enum":["NETWORK_INTERFACE_VLAN_TAGGING_DISABLE","NETWORK_INTERFACE_VLAN_TAGGING_ENABLE"],"default":"NETWORK_INTERFACE_VLAN_TAGGING_DISABLE","x-displayname":"Vlan Tagging","x-ves-proto-enum":"ves.io.schema.network_interface.NetworkInterfaceVLANTagging"},"network_interfaceReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a network_interface","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.network_interface.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/network_interfaceReplaceSpecType"}}},"network_interfaceReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.network_interface.ReplaceResponse"},"network_interfaceReplaceSpecType":{"type":"object","description":"Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.","title":"Replace network interface","x-displayname":"Replace Network Interface","x-ves-oneof-field-interface_choice":"[\"dedicated_interface\",\"dedicated_management_interface\",\"ethernet_interface\",\"layer2_interface\",\"legacy_interface\",\"tunnel_interface\"]","x-ves-proto-message":"ves.io.schema.network_interface.ReplaceSpecType","properties":{"dedicated_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedInterfaceType"},"dedicated_management_interface":{"$ref":"#/components/schemas/network_interfaceDedicatedManagementInterfaceType"},"ethernet_interface":{"$ref":"#/components/schemas/network_interfaceEthernetInterfaceType"},"layer2_interface":{"$ref":"#/components/schemas/network_interfaceLayer2InterfaceType"},"legacy_interface":{"$ref":"#/components/schemas/network_interfaceLegacyInterfaceType"},"tunnel_interface":{"$ref":"#/components/schemas/network_interfaceTunnelInterfaceType"}}},"network_interfaceStaticIPParametersType":{"type":"object","description":"Configure Static IP parameters","title":"Static IP Parameters","x-displayname":"Static IP Parameters","x-ves-oneof-field-network_prefix_choice":"[\"cluster_static_ip\",\"node_static_ip\"]","x-ves-proto-message":"ves.io.schema.network_interface.StaticIPParametersType","properties":{"cluster_static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIpParametersClusterType"},"node_static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIpParametersNodeType"}}},"network_interfaceStaticIpParametersClusterType":{"type":"object","description":"Configure Static IP parameters  for cluster","title":"Static IP Parameters","x-displayname":"Cluster: Static IP Parameters","x-ves-proto-message":"ves.io.schema.network_interface.StaticIpParametersClusterType","properties":{"interface_ip_map":{"type":"object","description":" Map of Node to Static ip configuration value, Key:Node, Value:IP Address\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 128\n","title":"Site:Node to IP mapping","x-displayname":"Node to IP Mapping","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"128","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"128"}}}},"network_interfaceStaticIpParametersFleetType":{"type":"object","description":"x-displayName: \"Fleet: Static IP Parameters\"\nConfigure Static IP parameters","title":"Static IP Parameters","properties":{"default_gw":{"type":"string","description":"x-displayName: \"Default Gateway\"\nx-example: \"192.168.20.1\"\nIP address offset of the default gateway, prefix len is used to calculate offset","title":"Default Gateway"},"dns_server":{"type":"string","description":"x-displayName: \"DNS Server\"\nx-example: \"192.168.20.1\"\nIP address offset of the DNS server, prefix len is used to calculate offset","title":"DNS Server"},"network_prefix_allocator":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"network_interfaceStaticIpParametersNodeType":{"type":"object","description":"Configure Static IP parameters for a node","title":"Static IP Parameters","x-displayname":"Node: Static IP Parameters","x-ves-proto-message":"ves.io.schema.network_interface.StaticIpParametersNodeType","properties":{"default_gw":{"type":"string","description":" IP address of the default gateway.\n\nExample: ` \"192.168.20.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip: true\n","title":"Default Gateway","x-displayname":"Default Gateway","x-ves-example":"192.168.20.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ip":"true"}},"ip_address":{"type":"string","description":" IP address of the interface and prefix length\n\nExample: ` \"192.168.20.1/24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ip_prefix: true\n","title":"Default Gateway","x-displayname":"IP address/Prefix Length","x-ves-example":"192.168.20.1/24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ip_prefix":"true"}}}},"network_interfaceStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Network Interface Status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.network_interface.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various components of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Reference to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"status":{"$ref":"#/components/schemas/network_interfaceNetworkInterfaceStatus"}}},"network_interfaceTunnelInterfaceType":{"type":"object","description":"Tunnel Interface Configuration","title":"Tunnel Interface","x-displayname":"Tunnel Interface","x-ves-oneof-field-network_choice":"[\"site_local_inside_network\",\"site_local_network\"]","x-ves-oneof-field-node_choice":"[\"node\"]","x-ves-proto-message":"ves.io.schema.network_interface.TunnelInterfaceType","properties":{"mtu":{"type":"integer","description":" Maximum packet size (Maximum Transfer Unit) of the interface\n When configured, mtu must be between 512 and 16384\n\nExample: ` \"1450\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,512-16384\n","title":"Maximum Packet Size (MTU)","format":"int64","x-displayname":"Maximum Packet Size (MTU)","x-ves-example":"1450","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,512-16384"}},"node":{"type":"string","description":"Exclusive with []\n Configuration will apply to a given device on the given node.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.min_len: 1\n","title":"Node","minLength":1,"maxLength":64,"x-displayname":"Specific Node","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.min_len":"1"}},"priority":{"type":"integer","description":" Priority of the network interface when multiple network interfaces are present in outside network\n Greater the value, higher the priority\n\nExample: ` \"42\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 255\n","title":"Priority","format":"int64","x-displayname":"Priority","x-ves-example":"42","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"255"}},"site_local_inside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_ip":{"$ref":"#/components/schemas/network_interfaceStaticIPParametersType"},"tunnel":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"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"}}},"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"}}}},"schemaIpv4SubnetType":{"type":"object","description":"IPv4 subnets specified as prefix and prefix-length. Prefix length must be <= 32","title":"IPv4 Subnet","x-displayname":"IPv4 Subnet","x-ves-proto-message":"ves.io.schema.Ipv4SubnetType","properties":{"plen":{"type":"integer","description":" Prefix-length of the IPv4 subnet. Must be <= 32\n\nExample: ` \"24\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 32\n","title":"Prefix Length","format":"int64","x-displayname":"Prefix Length","x-ves-example":"24","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"32"}},"prefix":{"type":"string","description":" Prefix part of the IPv4 subnet in string form with dot-decimal notation\n\nExample: ` \"192.168.1.0\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"Prefix","x-displayname":"Prefix","x-ves-example":"192.168.1.0","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"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"}}},"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"}}}}}}}