@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0051.public.ves.io.schema.tenant_management.child_tenant.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.tenant_management.child_tenant","description":"\nChild Tenant","version":""},"paths":{"/api/web/namespaces/system/partner-management/child_tenants":{"get":{"summary":"List of Child Tenants","description":"Get list of child tenants user has access to based on assigned membership.\nThis is an optimized list generated based on the requesting user's current group assignments\nthat will allow access to child tenant.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomAPI.ListChildTenants","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/child_tenantListChildTenantsResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"name","description":"x-example: \"value\"\nFilter child tenant list using name of child tenant.","in":"query","required":false,"x-displayname":"Name","schema":{"type":"string"}},{"name":"ctm","description":"x-example: \"value\"\nName of the Child Tenant Manager.\nIf this field set, child tenant list will be filtered by given CTM","in":"query","required":false,"x-displayname":"CTM","schema":{"type":"string"}},{"name":"page_start","description":"x-example: \"c5776a8e-bcae-4392-98d3-3556f4b9df1b\"\nPageStart will hold the UUID of the first item in the requested page.\nResponse will contain items upto count specified in PageLimit starting from  PageStart.\nIf this is empty then first page will be served.","in":"query","required":false,"x-displayname":"PageStart","schema":{"type":"string"}},{"name":"page_limit","description":"x-example: \"100\"\nPageLimit will hold the limit of items required per query.\nDefault value is set as 100","in":"query","required":false,"x-displayname":"PageLimit","schema":{"type":"integer","format":"int32"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customapi-listchildtenants"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomAPI.ListChildTenants"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/child_tenants/migrate":{"post":{"summary":"Migrate Child Tenants","description":"Migrate ACTIVE child tenants from existing CTM(s) to a specified new CTM","operationId":"ves.io.schema.tenant_management.child_tenant.CustomAPI.MigrateChildTenants","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/child_tenantMigrateChildTenantsResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/child_tenantMigrateChildTenantsReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customapi-migratechildtenants"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomAPI.MigrateChildTenants"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports":{"get":{"summary":"List all support tickets created in child tenant","description":"Return list of all support tickets for a child tenant","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.ListChildTenantSupportTickets","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementListSupportTicketResponse"}}}},"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-listchildtenantsupporttickets"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.ListChildTenantSupportTickets"},"post":{"summary":"Create customer support ticket in child tenant","description":"Creates a new customer support ticket in our customer support provider system.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemacustomer_supportCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemacustomer_supportCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-create"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Create"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}":{"get":{"summary":"Get customer support ticket in child tenant","description":"Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementGetByTpIdResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-get"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Get"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/close":{"post":{"summary":"Close a customer support ticket in child tenant","description":"Closes selected customer support ticket (if not already closed). You can always attempt to reopen if needed to be.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Close","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_supportCloseResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tenant_managementSupportTicketRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-close"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Close"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment":{"post":{"summary":"Add comment to a customer support ticket in child tenant","description":"Adds additional comment to a specified customer support ticket. The comment may include an attachment.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Comment","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_supportCommentResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenant_managementCommentRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-comment"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Comment"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/escalate":{"post":{"summary":"Escalate a ticket in child tenant","description":"Escalates a selected ticket. Only certain customers (depending on their contract) are allowed to escalate tickets.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Escalate","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_supportEscalationResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tenant_managementSupportTicketRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-escalate"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Escalate"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/priority":{"post":{"summary":"Change priority of a ticket in child tenant","description":"Changes priority of a selected ticket. Not possible if ticket's already closed.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Priority","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_supportPriorityResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schematenant_managementPriorityRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-priority"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Priority"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/partner-management/customer_supports/{tp_id}/reopen":{"post":{"summary":"Reopen a closed customer support ticket in child tenant","description":"Reopens a selected closed customer support ticket.","operationId":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Reopen","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_supportReopenResponse"}}}},"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":"tp_id","description":"Third party ID\n\nx-example: \"123\"\nID assigned to this ticket by our support provider.","in":"path","required":true,"x-displayname":"Third Party ID","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/tenant_managementSupportTicketRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-customersupportcustomapi-reopen"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI.Reopen"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.CustomerSupportCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{metadata.namespace}/child_tenants":{"post":{"summary":"Child Tenant","description":"Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.","operationId":"ves.io.schema.tenant_management.child_tenant.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementchild_tenantCreateResponse"}}}},"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/tenant_managementchild_tenantCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-api-create"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.API.Create"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{metadata.namespace}/child_tenants/{metadata.name}":{"put":{"summary":"Replace Child Tenant","description":"Replaces attributes of a child_tenant configuration","operationId":"ves.io.schema.tenant_management.child_tenant.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/child_tenantReplaceResponse"}}}},"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/child_tenantReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-api-replace"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.API.Replace"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{namespace}/child_tenants":{"get":{"summary":"List Child Tenant","description":"List the set of child_tenant in a namespace","operationId":"ves.io.schema.tenant_management.child_tenant.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementchild_tenantListResponse"}}}},"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 child_tenant","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-tenant_management-child_tenant-api-list"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.API.List"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{namespace}/child_tenants/{name}":{"get":{"summary":"Get Child Tenant","description":"Get child_tenant reads a given object from storage backend for metadata.namespace.","operationId":"ves.io.schema.tenant_management.child_tenant.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementchild_tenantGetResponse"}}}},"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-tenant_management-child_tenant-api-get"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.API.Get"},"delete":{"summary":"Delete Child Tenant","description":"Delete the specified child_tenant","operationId":"ves.io.schema.tenant_management.child_tenant.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/child_tenantDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-tenant_management-child_tenant-api-delete"},"x-ves-proto-rpc":"ves.io.schema.tenant_management.child_tenant.API.Delete"},"x-displayname":"Child Tenant","x-ves-proto-service":"ves.io.schema.tenant_management.child_tenant.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Child Tenant","x-ves-proto-package":"ves.io.schema.tenant_management.child_tenant","components":{"requestBodies":{"tenant_managementSupportTicketRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tenant_managementSupportTicketRequest"}}},"required":true}},"schemas":{"child_tenantCustomerInfo":{"type":"object","description":"Optional details for the new child tenant","title":"customer_info","x-displayname":"Customer Info","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.CustomerInfo","properties":{"additional_info":{"type":"string","description":" Use this field for any additional information about the new child tenant\n\nExample: ` \"This is used for testing purpose\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"additional_info","maxLength":1024,"x-displayname":"Additional Info","x-ves-example":"This is used for testing purpose","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"email":{"type":"string","description":"\n\nExample: ` \"abc@f5.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.email: true\n","title":"email","x-displayname":"Email","x-ves-example":"abc@f5.com","x-ves-validation-rules":{"ves.io.schema.rules.string.email":"true"}},"first_name":{"type":"string","description":"\n\nExample: ` \"john\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"first_name","maxLength":128,"x-displayname":"First Name","x-ves-example":"john","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"last_name":{"type":"string","description":"\n\nExample: ` \"david\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"last_name","maxLength":128,"x-displayname":"Last Name","x-ves-example":"david","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}}}},"child_tenantDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a child_tenant","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.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"}}},"child_tenantListChildTenantsResp":{"type":"object","description":"Response to get list of child tenant access.","title":"ListMSPChildTenantsResp","x-displayname":"List Child Tenants Response","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.ListChildTenantsResp","properties":{"access_config":{"type":"array","description":" Allowed access configuration details for the tenant.","title":"access_config","items":{"$ref":"#/components/schemas/tenant_managementAccessInfo"},"x-displayname":"Access Config"},"next_page":{"type":"string","description":" NextPage contains the UUID of the first item of the next page.\n This value can be passed back as the PageStart in the next request.\n If this empty means current one is the last page.","title":"next_page","x-displayname":"NextPage"},"total_count":{"type":"integer","description":" TotalCount holds total count of access config.","title":"total_count","format":"int32","x-displayname":"TotalCount"},"total_filtered_count":{"type":"integer","description":" TotalFilteredCount holds total count of access config after filtering.","title":"total_filtered_count","format":"int32","x-displayname":"TotalFilteredCount"}}},"child_tenantMigrateChildTenantsReq":{"type":"object","description":"Request to migrate child tenants to a specified new child tenant manager","title":"MigrateChildTenantsReq","x-displayname":"Migrate child tenants request","x-ves-oneof-field-migratechildtenantsreqchoice":"[\"ct_list_to_target_ctm\"]","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.MigrateChildTenantsReq","properties":{"ct_list_to_target_ctm":{"$ref":"#/components/schemas/tenant_managementCTListToCTM"}}},"child_tenantMigrateChildTenantsResp":{"type":"object","description":"Response of migrating child tenants to a specified CTM.","title":"MigrateChildTenantsResp","x-displayname":"Migrate child tenants response","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.MigrateChildTenantsResp","properties":{"child_tenant_manager":{"type":"string","description":" Name of the child tenant manager to which all the child tenants are migrating to.","title":"Child tenant manager","x-displayname":"Child tenant manager"},"errors":{"type":"array","description":" Errors(if any) while migrating child tenants","title":"Errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"migrate_initiated_for_ct_count":{"type":"integer","description":" This specifies the total number of child tenants for which migration has been initiated to a specified CTM","title":"Migrate initiated for child tenants count","format":"int32","x-displayname":"Migrate initiated for child tenants count"},"total_ct_count":{"type":"integer","description":" This specifies total number of child tenants requested to be migrated to a specified CTM","title":"Total child tenant count","format":"int32","x-displayname":"Total child tenant count requested for migration"}}},"child_tenantReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a child_tenant","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/tenant_managementchild_tenantReplaceSpecType"}}},"child_tenantReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.ReplaceResponse"},"contactContactType":{"type":"string","description":"Determines the contact type\n\nIndicates snail mail address (used for correspondence)\nIndicates billing address (this address will appear on invoices)\nIndicates contact used for a payment method (this address is used when charging a payment method)","title":"Contact Type","enum":["MAILING","BILLING","PAYMENT"],"default":"MAILING","x-displayname":"Contact Type","x-ves-proto-enum":"ves.io.schema.contact.ContactType"},"customer_supportAttachmentType":{"type":"object","description":"Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself,\nthey represent a handle in the third party, so the contact can be retrieved omn demand.","title":"Attachment","x-displayname":"Attachment","x-ves-proto-message":"ves.io.schema.customer_support.AttachmentType","properties":{"attachment":{"type":"string","description":" Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.\n\nExample: ` \"dGVzdCBhdHRhY2htZW50\"`","title":"Binary attachment","format":"byte","x-displayname":"Attachment data","x-ves-example":"dGVzdCBhdHRhY2htZW50"},"content_type":{"type":"string","description":" Mime content type of the attachment. Helps the UI to properly display the data.\n\nExample: ` \"application/pdf\"`","title":"Content type","x-displayname":"Content type","x-ves-example":"application/pdf"},"filename":{"type":"string","description":" Filename of the attachment as provided by the caller.\n\nExample: ` \"attachment.pdf\"`","title":"Filename of the attachment","x-displayname":"Filename","x-ves-example":"attachment.pdf"},"tp_id":{"type":"string","description":" Optional ID as assigned by the 3rd party actually storing the data.\n\nExample: ` \"1234\"`","title":"3rd party ID","x-displayname":"3rd party ID","x-ves-example":"1234"}}},"customer_supportCloseResponse":{"type":"object","description":"Gives details of result of closing a customer support ticket.","title":"Close response","x-displayname":"Response to closing a customer support ticket","x-ves-proto-message":"ves.io.schema.customer_support.CloseResponse","properties":{"err":{"$ref":"#/components/schemas/schemacustomer_supportErrorCode"}}},"customer_supportCommentResponse":{"type":"object","description":"Gives details of result of adding a customer support ticket.","title":"Comment response","x-displayname":"Response to adding of new customer support ticket comment","x-ves-proto-message":"ves.io.schema.customer_support.CommentResponse","properties":{"err":{"$ref":"#/components/schemas/schemacustomer_supportErrorCode"}}},"customer_supportCommentType":{"type":"object","description":"Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself.\nCustomers usually download all comments on an issue which resembles a conversation on an issue.","title":"Comment","x-displayname":"Comment","x-ves-proto-message":"ves.io.schema.customer_support.CommentType","properties":{"attachment_ids":{"type":"array","description":" Third party id of any attachment related to this ticket comment\n\nExample: ` \"12345\"`","title":"Third party attachment ID","items":{"type":"string"},"x-displayname":"Attachment IDs","x-ves-example":"12345"},"attachments_info":{"type":"array","description":" Information about any attachments (such as screenshots, plain text files) the comment can have.","title":"Attachments information","items":{"$ref":"#/components/schemas/customer_supportAttachmentType"},"x-displayname":"Attachments details"},"author_email":{"type":"string","description":" Email of the author of the comment\n\nExample: ` \"john.smith@volterra.io\"`","title":"Email","x-displayname":"Email","x-ves-example":"john.smith@volterra.io"},"author_name":{"type":"string","description":" Author of the comment (as a name)\n\nExample: ` \"John Smith\"`","title":"Author","x-displayname":"Author","x-ves-example":"John Smith"},"created_at":{"type":"string","description":" Comment creation time\n\nExample: ` \"01-01-1970T00:00:00Z\"`","title":"Creation timestamp","format":"date-time","x-displayname":"At","x-ves-example":"01-01-1970T00:00:00Z"},"html":{"type":"string","description":" Comment body as HTML\n\nExample: ` \"<p>Looking good</p>\"`","title":"HTML text","x-displayname":"Comment","x-ves-example":"<p>Looking good</p>"},"plain_text":{"type":"string","description":" Comment body as plain text\n\nExample: ` \"Looking good\"`","title":"Plain text","x-displayname":"Comment","x-ves-example":"Looking good"}}},"customer_supportEscalationResponse":{"type":"object","description":"Any error that may occurred during escalating of a ticket","title":"Escalation response","x-displayname":"Response to escalation request","x-ves-proto-message":"ves.io.schema.customer_support.EscalationResponse","properties":{"err":{"$ref":"#/components/schemas/schemacustomer_supportErrorCode"}}},"customer_supportPriorityResponse":{"type":"object","description":"Gives details of result of changing priority a customer support ticket.","title":"Change priority response","x-displayname":"Response to changing of priority of a customer support ticket","x-ves-proto-message":"ves.io.schema.customer_support.PriorityResponse","properties":{"err":{"$ref":"#/components/schemas/schemacustomer_supportErrorCode"}}},"customer_supportReopenResponse":{"type":"object","description":"Gives details of result of reopening a customer support ticket.","title":"Reopen response","x-displayname":"Response to reopening a customer support ticket","x-ves-proto-message":"ves.io.schema.customer_support.ReopenResponse","properties":{"err":{"$ref":"#/components/schemas/schemacustomer_supportErrorCode"}}},"customer_supportSupportService":{"type":"string","description":"Indicates the list of support service\n\nUnknown Support Service\nAccount Protection Support Service\nAdministration Support Service\nApplication Traffic Insight Support Service\nAudit Logs & Alerts Support Service\nAuthentication Intelligence Support Service\nBilling Support Service\nClient Side Defense Support Service\nCloud & Edge Sites Support Service\ndeprecated: use SS_MULTI_CLOUD_NETWORK_CONNECT instead\nDDOS & Transit Support Service\nDeprecated: use SS_ROUTED_DDOS instead\nDistributed Apps Support Service\nDNS Management Support Service\nLoadBalancers Support Service\ndeprecated: use SS_MULTI_CLOUD_APP_CONNECT instead\nShared Configuration Support Service\nWeb App & API Protection Support Service\nOther Support Service\nBot Defense Support Service\nContent delivery network Support Service\nObservability Support Service\nDelegated Access Support Service\nNetworking & security across clouds, edge and on-premises\nConnect apps across clouds, edge and on-premises using Load Balancers\nBIG-IP Access Policy Manager (APM)\nData Intelligence Support Service\nNGINX One Support Service\nWeb App Scanning Support Service\nRouted DDoS Support Service\nMobile App Shield protects mobile apps from reverse engineering, tampering and malware","title":"SupportService","enum":["SS_UNKNOWN","SS_ACCOUNT_PROTECTION","SS_ADMINISTRATION","SS_APPLICATION_TRAFFIC_INSIGHT","SS_AUDIT_LOGS_AND_ALERTS","SS_AUTHENTICATION_INTELLIGENCE","SS_BILLING","SS_CLIENT_SIDE_DEFENSE","SS_CLOUD_AND_EDGE_SITES","SS_DDOS_AND_TRANSIT_SERVICES","SS_DISTRIBUTED_APPS","SS_DNS_MANAGEMENT","SS_LOAD_BALANCERS","SS_SHARED_CONFIGURATION","SS_WEB_APP_AND_API_PROTECTION","SS_OTHER","SS_BOT_DEFENSE","SS_CDN","SS_OBSERVABILITY","SS_DELEGATED_ACCESS","SS_MULTI_CLOUD_NETWORK_CONNECT","SS_MULTI_CLOUD_APP_CONNECT","SS_BIG_IP_APM","SS_DATA_INTELLIGENCE","SS_NGINX_ONE","SS_WEB_APP_SCANNING","SS_ROUTED_DDOS","SS_MOBILE_APP_SHIELD"],"default":"SS_UNKNOWN","x-displayname":"Support Service","x-ves-proto-enum":"ves.io.schema.customer_support.SupportService"},"customer_supportSupportTicketPriority":{"type":"string","description":"Support ticket priority helps understand importance of the ticket and focus\nmore on more critical issues.\n\nUnknown/empty priority\nNormal priority issue\nHigh priority issue\nUrgent priority issue","title":"SupportTicketPriority","enum":["PRIORITY_UNKNOWN","PRIORITY_NORMAL","PRIORITY_HIGH","PRIORITY_URGENT"],"default":"PRIORITY_UNKNOWN","x-displayname":"Priority","x-ves-proto-enum":"ves.io.schema.customer_support.SupportTicketPriority"},"customer_supportSupportTicketStatus":{"type":"string","description":"State of the ticket so the customers know if the problem is being looked into\n\nUnknown or empty support ticket status\nIndicates a new ticket, waiting to be assigned to an agent\nIndicates an open issues, actively being looked into\nIndicates a pending issue, an open issue not actively being looked into\nIndicates on issue that on-hold, waiting for more information\nIndicates a solved issue, waiting for customer's confirmation\nIndicates a closed issue, resolved and customer approved\nIndicates a failed ticket, a failed ticket didn't make it into Zendesk and a customer should create new one instead","title":"SupportTicketStatus","enum":["STATUS_UNKNOWN","STATUS_NEW","STATUS_OPEN","STATUS_PENDING","STATUS_ONHOLD","STATUS_SOLVED","STATUS_CLOSED","STATUS_FAILED"],"default":"STATUS_UNKNOWN","x-displayname":"Support Ticket Status","x-ves-proto-enum":"ves.io.schema.customer_support.SupportTicketStatus"},"customer_supportSupportTicketType":{"type":"string","description":"Several types of issues are supported, such as problems, questions.\n\nUnknown or empty ticket type\nIndicates a problem (e.g. misconfiguration)\nIndicates a task (a request to do something)\nIndicates a question (billing, services related)\nIndicates an incident (something is not working)\nIndicates a technical support ticket\nIndicates an account support ticket\nIndicates an Incident support ticket","title":"SupportTicketType","enum":["TYPE_UNKNOWN","TYPE_PROBLEM","TYPE_TASK","TYPE_QUESTION","TYPE_INCIDENT","TYPE_TECHNICAL_SUPPORT","TYPE_ACCOUNT_SUPPORT","TYPE_INCIDENT_SUPPORT"],"default":"TYPE_UNKNOWN","x-displayname":"Support Ticket","x-ves-proto-enum":"ves.io.schema.customer_support.SupportTicketType"},"customer_supportSupportTopic":{"type":"string","description":"Support Topic indicates the list of topics for service tickets\n\nUnknown/empty priority\nACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST\nACCOUNT_SUPPORT_TOPIC_ACCOUNT\nACCOUNT_SUPPORT_TOPIC_BILLING\nACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE\nACCOUNT_SUPPORT_TOPIC_PUBLIC_IP\nACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE\nACCOUNT_SUPPORT_TOPIC_RMA\nACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION\nACCOUNT_SUPPORT_TOPIC_OTHERS\nTECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES\nTECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE\nTECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION\nTECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION\nTECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING\nTECHNICAL_SUPPORT_TOPIC_OTHERS\nINCIDENT_SUPPORT_TOPIC_LATENCY\nINCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION\nINCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE\nINCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE\nINCIDENT_SUPPORT_TOPIC_OTHERS\nTASK_TOPIC_PLAN_TRANSITION\nPROBLEM_TOPIC_SUPPORT_ALERT\nQUESTION_TOPIC_INFRASTRUCTURE\nTECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION","title":"SupportTopic","enum":["TOPIC_UNKNOWN","ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST","ACCOUNT_SUPPORT_TOPIC_ACCOUNT","ACCOUNT_SUPPORT_TOPIC_BILLING","ACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE","ACCOUNT_SUPPORT_TOPIC_PUBLIC_IP","ACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE","ACCOUNT_SUPPORT_TOPIC_RMA","ACCOUNT_SUPPORT_TOPIC_TAX_EXEMPT_VERIFICATION","ACCOUNT_SUPPORT_TOPIC_OTHERS","TECHNICAL_SUPPORT_TOPIC_CONFIGURATION_CHANGES","TECHNICAL_SUPPORT_TOPIC_ERROR_MESSAGE","TECHNICAL_SUPPORT_TOPIC_NEW_CONFIGURATION","TECHNICAL_SUPPORT_TOPIC_PRODUCT_QUESTION","TECHNICAL_SUPPORT_TOPIC_TROUBLESHOOTING","TECHNICAL_SUPPORT_TOPIC_OTHERS","INCIDENT_SUPPORT_TOPIC_LATENCY","INCIDENT_SUPPORT_TOPIC_PERFORMANCE_DEGRADATION","INCIDENT_SUPPORT_TOPIC_PARTIAL_OUTAGE","INCIDENT_SUPPORT_TOPIC_COMPLETE_OUTAGE","INCIDENT_SUPPORT_TOPIC_OTHERS","TASK_TOPIC_PLAN_TRANSITION","PROBLEM_TOPIC_SUPPORT_ALERT","QUESTION_TOPIC_INFRASTRUCTURE","TECHNICAL_SUPPORT_TOPIC_DELEGATED_DOMAIN_MIGRATION"],"default":"TOPIC_UNKNOWN","x-displayname":"Support Topic","x-ves-proto-enum":"ves.io.schema.customer_support.SupportTopic"},"ioschemaErrorCode":{"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"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaCRMInfo":{"type":"object","description":"CRM Information","title":"CRM Information","x-displayname":"CRM Information","x-ves-proto-message":"ves.io.schema.CRMInfo"},"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\\\"]"}}}},"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/ioschemaErrorCode"},"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"}}},"schemacontactGlobalSpecType":{"type":"object","description":"Instance of one single contact that can be used to communicate with customers.\nDepending on contact type we use these details to send general communication (regular, physical mail) or invoices.","title":"Contact","x-displayname":"Contact","x-ves-proto-message":"ves.io.schema.contact.GlobalSpecType","properties":{"address1":{"type":"string","description":"\n\nExample: ` \"1234 Main road\"`","title":"address1","x-displayname":"Address Line 1","x-ves-example":"1234 Main road"},"address2":{"type":"string","description":"\n\nExample: ` \"P.O BOX 56\"`","title":"address2","x-displayname":"Address Line 2","x-ves-example":"P.O BOX 56"},"city":{"type":"string","description":"\n\nExample: ` \"Sunnyvale\"`","title":"city","x-displayname":"City","x-ves-example":"Sunnyvale"},"contact_type":{"$ref":"#/components/schemas/contactContactType"},"country":{"type":"string","description":"\n\nExample: ` \"US\"`","title":"country","x-displayname":"Country","x-ves-example":"US"},"county":{"type":"string","description":"\n\nExample: ` \"Santa Clara\"`","title":"county","x-displayname":"County","x-ves-example":"Santa Clara"},"phone_number":{"type":"string","description":"\n\nExample: ` \"+11234567890\"`","title":"phone_number","x-displayname":"Phone Number","x-ves-example":"+11234567890"},"state":{"type":"string","description":"\n\nExample: ` \"California\"`","title":"state","x-displayname":"State","x-ves-example":"California"},"state_code":{"type":"string","description":"\n\nExample: ` \"CA\"`","title":"state code","x-displayname":"State Code","x-ves-example":"CA"},"zip_code":{"type":"string","description":"\n\nExample: ` \"95054\"`","title":"zip_code","x-displayname":"ZIP code","x-ves-example":"95054"}}},"schemacustomer_supportCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of customer_support","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.customer_support.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemacustomer_supportCreateSpecType"}}},"schemacustomer_supportCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.customer_support.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemacustomer_supportGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"schemacustomer_supportCreateSpecType":{"type":"object","description":"Creates a new customer support ticket in our customer support provider system.","title":"Create issue specification","x-displayname":"Create Customer Support","x-ves-proto-message":"ves.io.schema.customer_support.CreateSpecType","properties":{"category":{"type":"string","description":" ticket area further narrows down the ticket - infrastructure, application,\n dashboards can be examples.\n\n\nExample: ` \"infrastructure\"`","title":"Deprecated","x-displayname":"Category","x-ves-deprecated":"Replaced by 'topic'","x-ves-example":"infrastructure"},"comments":{"type":"array","description":" Comments are all public comments on an issue. They're usually conversation between the support personnel and the customer.\n\nExample: ` [\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]`","items":{"$ref":"#/components/schemas/customer_supportCommentType"},"x-displayname":"Comments"},"description":{"type":"string","description":" customer's description of the issue (free text)\n\nExample: ` \"Hello support,  I cannot login to my account. Can you please look into it. Thank you, John\"`","x-displayname":"Description","x-ves-example":"Hello support,  I cannot login to my account. Can you please look into it. Thank you, John"},"ongoing":{"type":"boolean","description":" Ongoing is a flag that indicates whether the issue is ongoing or not.","format":"boolean","x-displayname":"Ongoing"},"priority":{"$ref":"#/components/schemas/customer_supportSupportTicketPriority"},"product_data":{"type":"string","description":" Product data is a free text field that can be used to describe the issue in more detail.\n\nExample: ` \"Happening in the loreimpsum namespace and impacts most of our sites\"`","x-displayname":"Product Data","x-ves-example":"Happening in the loreimpsum namespace and impacts most of our sites"},"relates_to":{"type":"array","description":" Optional reference to any original ticket in case the ticket being created is a followup.","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Ticket which this one relates to"},"service":{"$ref":"#/components/schemas/customer_supportSupportService"},"status":{"$ref":"#/components/schemas/customer_supportSupportTicketStatus"},"subject":{"type":"string","description":" subject of the ticket\n\nExample: ` \"Problem logging into account\"`","x-displayname":"Subject","x-ves-example":"Problem logging into account"},"timeline":{"type":"string","description":" Timeline is a free text field that can be used to describe the issue in more detail.\n\nExample: ` \"Both LBs have been down since noon on Jan 5, 2022.\"`","x-displayname":"Timeline","x-ves-example":"Both LBs have been down since noon on Jan 5, 2022."},"topic":{"$ref":"#/components/schemas/customer_supportSupportTopic"},"tp_id":{"type":"string","description":" ID assigned to this ticket by our support provider.\n\nExample: ` \"123\"`","x-displayname":"Third Party ID","x-ves-example":"123"},"type":{"$ref":"#/components/schemas/customer_supportSupportTicketType"}}},"schemacustomer_supportErrorCode":{"type":"string","description":"ErrorCode is used to know the specific reason for customer support operation failures\n\n - EUNKNOWN: an unknown error occurred\n - EOK: Successful operation\n - E_NOT_CLOSED: Customer support ticket not closed\n - E_NOT_OPEN: Customer support ticket not open\n - E_NOT_ELIGIBLE: Customer is not eligible for this operation (i.e. when escalating a ticket then this indicates customer not being enterprise)\n - E_NOT_NOT_FOUND: Support ticket couldn't be found.","title":"error code","enum":["EUNKNOWN","EOK","E_NOT_CLOSED","E_NOT_OPEN","E_NOT_ELIGIBLE","E_NOT_NOT_FOUND"],"default":"EUNKNOWN","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.customer_support.ErrorCode"},"schemacustomer_supportGetSpecType":{"type":"object","description":"Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.","title":"Get issue specification","x-displayname":"Get Customer Support","x-ves-proto-message":"ves.io.schema.customer_support.GetSpecType","properties":{"author_name":{"type":"string","description":" Author of the comment (as a name)\n\nExample: ` \"John Smith\"`","x-displayname":"Author","x-ves-example":"John Smith"},"category":{"type":"string","description":" ticket area further narrows down the ticket - infrastructure, application,\n dashboards can be examples.\n\n\nExample: ` \"infrastructure\"`","title":"Deprecated","x-displayname":"Category","x-ves-deprecated":"Replaced by 'topic'","x-ves-example":"infrastructure"},"comments":{"type":"array","description":" Comments are all public comments on an issue. They're usually conversation between the support personnel and the customer.\n\nExample: ` [\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]`","items":{"$ref":"#/components/schemas/customer_supportCommentType"},"x-displayname":"Comments"},"created_at":{"type":"string","description":" Created at timestamp\n\nExample: ` \"01-01-1970T00:00:00Z\"`","format":"date-time","x-displayname":"Created at","x-ves-example":"01-01-1970T00:00:00Z"},"custom_fields":{"type":"array","description":" any custom fields (read only). custom fields have to be defined first before they're used.\n custom fields have no direct impact on the issue but help to better categorize issues.\n\nExample: ` \"custom-field-id:custom-field-value\"`","items":{"type":"string"},"x-displayname":"Custom Fields","x-ves-example":"custom-field-id:custom-field-value"},"description":{"type":"string","description":" customer's description of the issue (free text)\n\nExample: ` \"Hello support,  I cannot login to my account. Can you please look into it. Thank you, John\"`","x-displayname":"Description","x-ves-example":"Hello support,  I cannot login to my account. Can you please look into it. Thank you, John"},"escalated":{"type":"boolean","description":" Indicates escalated ticket - i.e. a ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.\n only existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated","format":"boolean","x-displayname":"Escalated"},"followups":{"type":"array","description":" Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket.\n Used in situations when the original ticket has been closed but the issue occurred again or a new problem occurred in relation to this closed ticket.","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Followup tickets"},"ongoing":{"type":"boolean","description":" Ongoing is a flag that indicates whether the issue is ongoing or not.","format":"boolean","x-displayname":"Ongoing"},"priority":{"$ref":"#/components/schemas/customer_supportSupportTicketPriority"},"product_data":{"type":"string","description":" Product data is a free text field that can be used to describe the issue in more detail.\n\nExample: ` \"Happening in the loreimpsum namespace and impacts most of our sites\"`","x-displayname":"Product Data","x-ves-example":"Happening in the loreimpsum namespace and impacts most of our sites"},"relates_to":{"type":"array","description":" Optional reference to any original ticket in case the ticket being created is a followup.","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Ticket which this one relates to"},"service":{"$ref":"#/components/schemas/customer_supportSupportService"},"status":{"$ref":"#/components/schemas/customer_supportSupportTicketStatus"},"subject":{"type":"string","description":" subject of the ticket\n\nExample: ` \"Problem logging into account\"`","x-displayname":"Subject","x-ves-example":"Problem logging into account"},"tags":{"type":"array","description":" tags help to further categorize issues (read-only field)\n\nExample: ` \"UAM,UI\"`","items":{"type":"string"},"x-displayname":"Tags","x-ves-example":"UAM,UI"},"timeline":{"type":"string","description":" Timeline is a free text field that can be used to describe the issue in more detail.\n\nExample: ` \"Both LBs have been down since noon on Jan 5, 2022.\"`","x-displayname":"Timeline","x-ves-example":"Both LBs have been down since noon on Jan 5, 2022."},"topic":{"$ref":"#/components/schemas/customer_supportSupportTopic"},"tp_id":{"type":"string","description":" ID assigned to this ticket by our support provider.\n\nExample: ` \"123\"`","x-displayname":"Third Party ID","x-ves-example":"123"},"type":{"$ref":"#/components/schemas/customer_supportSupportTicketType"},"update_at":{"type":"string","description":" Date of the last modification\n\nExample: ` \"01-01-1970T00:00:00Z\"`","format":"date-time","x-displayname":"Updated at","x-ves-example":"01-01-1970T00:00:00Z"},"user":{"type":"array","description":" logged in user (read-only)\n\nExample: ` \"user@email.com\"`","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"User","x-ves-example":"user@email.com"},"via":{"type":"object","description":" via describes the way of a ticket reaching us (read-only)\n\nExample: ` \"['channel':'web', 'source''{}']\"`","x-displayname":"Via","x-ves-example":"['channel':'web', 'source': '{}']"}}},"schemacustomer_supportListResponseItem":{"type":"object","description":"By default a summary of customer_support 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 customer_support","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.customer_support.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this customer_support","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this customer_support","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates customer_support is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemacustomer_supportGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this customer_support","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this customer_support\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/schemacustomer_supportStatusObject"},"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 customer_support\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"schemacustomer_supportStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Customer support status","x-displayname":"Customer support object","x-ves-proto-message":"ves.io.schema.customer_support.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"schematenant_managementCommentRequest":{"type":"object","description":"Adds a new comment to an existing customer support ticket","title":"CommentRequest","x-displayname":"Customer support ticket comment request","x-ves-proto-message":"ves.io.schema.tenant_management.CommentRequest","properties":{"attachments":{"type":"array","description":" Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.","title":"Binary attachments","items":{"$ref":"#/components/schemas/customer_supportAttachmentType"},"x-displayname":"Attachments"},"comment":{"type":"string","description":" Comment on a existing customer support ticket.\n\nExample: ` \"value\"`","title":"comment","x-displayname":"Comment","x-ves-example":"value"},"tp_id":{"type":"string","description":" ID assigned to this ticket by our support provider.\n\nExample: ` \"123\"`","title":"Third party ID","x-displayname":"Third Party ID","x-ves-example":"123"}}},"schematenant_managementPriorityRequest":{"type":"object","description":"Priority of an existing customer support ticket","title":"PriorityRequest","x-displayname":"Customer support ticket priority request","x-ves-proto-message":"ves.io.schema.tenant_management.PriorityRequest","properties":{"priority":{"$ref":"#/components/schemas/customer_supportSupportTicketPriority"},"tp_id":{"type":"string","description":" ID assigned to this ticket by our support provider.\n\nExample: ` \"123\"`","title":"Third party ID","x-displayname":"Third Party ID","x-ves-example":"123"}}},"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"}}}},"tenant_managementAccessInfo":{"type":"object","description":"Access details of a managed tenant.","title":"AccessInfo","x-displayname":"Access Info","x-ves-proto-message":"ves.io.schema.tenant_management.AccessInfo","properties":{"groups":{"type":"array","description":" List of local user group association to user groups in the managed tenant.","title":"groups","items":{"$ref":"#/components/schemas/tenant_managementGroupAssignmentType"},"x-displayname":"Groups"},"link":{"$ref":"#/components/schemas/viewsLinkRefType"},"name":{"type":"string","description":" Name of the managed tenant config object. it can be used as known identifier.\n\nExample: ` \"l1-support\"`","title":"Name","x-displayname":"Name","x-ves-example":"l1-support"},"support_request_count":{"$ref":"#/components/schemas/tenant_managementSupportTicketInfo"},"tenant_status":{"$ref":"#/components/schemas/tenant_managementTenantStatus"}}},"tenant_managementAllTenantsTicketSummary":{"type":"object","x-ves-proto-message":"ves.io.schema.tenant_management.AllTenantsTicketSummary","properties":{"open_support_tickets_count":{"type":"integer","description":" Number of support tickets open in all tenants","title":"Open Support Tickets Count","format":"int32","x-displayname":"Open Support Tickets Count"}}},"tenant_managementCTListToCTM":{"type":"object","description":"Child tenants reference to child tenant manager","title":"CTListToCTM","x-displayname":"CTListToCTM","x-ves-proto-message":"ves.io.schema.tenant_management.CTListToCTM","properties":{"child_tenant_manager":{"type":"string","description":" Name of the child tenant manager where child tenants needs to be referred\n\nExample: ` \"ctm-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Child Tenant Manager","x-displayname":"Child Tenant Manager","x-ves-example":"ctm-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"child_tenants":{"type":"array","description":" List of child tenants refer to a child tenant manager\n\nExample: ` \"child-tenant-1,child-tenant-2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Child Tenants","minItems":1,"items":{"type":"string"},"x-displayname":"Child Tenants","x-ves-example":"child-tenant-1,child-tenant-2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"tenant_managementCTTicketSummary":{"type":"object","x-ves-proto-message":"ves.io.schema.tenant_management.CTTicketSummary","properties":{"open_support_tickets_count":{"type":"integer","description":" Number of support tickets open in child tenant","title":"Open Support Tickets Count","format":"int32","x-displayname":"Open Support Tickets Count"}}},"tenant_managementGetByTpIdResponse":{"type":"object","description":"This is the output message of the 'Get' RPC for customer_support in child / managed tenant","title":"GetByTpIdResponse","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.tenant_management.GetByTpIdResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemacustomer_supportGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tenant_managementGroupAssignmentType":{"type":"object","description":"Shape for specifying user group assosciation to user groups in a managed tenant.","title":"GroupAssignmentType","x-displayname":"Group to Assign","x-ves-proto-message":"ves.io.schema.tenant_management.GroupAssignmentType","properties":{"group":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"managed_tenant_groups":{"type":"array","description":" List of group names in managed tenant (MT).\n Note - To properly establish access, admin of managed tenant need to create corresponding Allowed Tenant\n configuration object with access to use same group names. Once it's setup, when user from original tenant\n access managed tenant, underlying roles from managed tenant will be applied to user.\n\nExample: ` \"user-group1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"managed_tenant_groups","maxItems":32,"items":{"type":"string","maxLength":256},"x-displayname":"Managed Tenant Groups","x-ves-example":"user-group1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}}}},"tenant_managementListSupportTicketResponse":{"type":"object","description":"This is the output message of 'ListSupportTicketResponse' RPC.","title":"ListSupportTicketResponse","x-displayname":"List Support Ticket Response","x-ves-proto-message":"ves.io.schema.tenant_management.ListSupportTicketResponse","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/schemacustomer_supportListResponseItem"},"x-displayname":"Items"}}},"tenant_managementSupportTicketInfo":{"type":"object","x-ves-oneof-field-supportticketinfochoice":"[\"all_tenants_summary\",\"ct_summary\"]","x-ves-proto-message":"ves.io.schema.tenant_management.SupportTicketInfo","properties":{"all_tenants_summary":{"$ref":"#/components/schemas/tenant_managementAllTenantsTicketSummary"},"ct_summary":{"$ref":"#/components/schemas/tenant_managementCTTicketSummary"}}},"tenant_managementSupportTicketRequest":{"type":"object","description":"Input request to fetch customer_support ticket in child / managed tenant","title":"SupportTicketRequest","x-displayname":"Support Ticket Request","x-ves-proto-message":"ves.io.schema.tenant_management.SupportTicketRequest","properties":{"tp_id":{"type":"string","description":" ID assigned to this ticket by our support provider.\n\nExample: ` \"123\"`","title":"Third party ID","x-displayname":"Third Party ID","x-ves-example":"123"}}},"tenant_managementTenantStatus":{"type":"string","description":"Status indicates status of a tenant, like active, to be deleted, disabled and so on\n\ntenant is active\ntenant is disabled\ntenant is about to be deleted\nany other status then active","title":"TenantStatus","enum":["TENANT_STATUS_ACTIVE","TENANT_STATUS_DISABLED","TENANT_STATUS_TO_BE_DELETED","TENANT_STATUS_INACTIVE"],"default":"TENANT_STATUS_ACTIVE","x-displayname":"Status","x-ves-proto-enum":"ves.io.schema.tenant_management.TenantStatus"},"tenant_managementchild_tenantCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of child_tenant","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/tenant_managementchild_tenantCreateSpecType"}}},"tenant_managementchild_tenantCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/tenant_managementchild_tenantGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tenant_managementchild_tenantCreateSpecType":{"type":"object","description":"Creates a child_tenant config instance. Name of the object is the name of the child tenant to be created.","title":"Create child tenant","x-displayname":"Child Tenant","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.CreateSpecType","properties":{"child_tenant_manager":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"company_name":{"type":"string","description":" Company name (enterprise only)\n\nExample: ` \"f5\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Company Name","x-ves-example":"f5","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"contact_detail":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"customer_info":{"$ref":"#/components/schemas/child_tenantCustomerInfo"},"domain":{"type":"string","description":" Text string that will be used for the subdomain of the new Child Tenant.\n This will be where users will directly log into the new Child Tenant. example domain.console.ves.volterra.io.\n\nExample: ` \"volterra\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 17\n  ves.io.schema.rules.string.min_len: 5\n  ves.io.schema.rules.string.not_in: [\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]\n  ves.io.schema.rules.string.ves_object_name: true\n","minLength":5,"maxLength":17,"x-displayname":"Domain","x-ves-example":"volterra","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"17","ves.io.schema.rules.string.min_len":"5","ves.io.schema.rules.string.not_in":"[\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]","ves.io.schema.rules.string.ves_object_name":"true"}},"tenant_profile":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"tenant_managementchild_tenantFSMState":{"type":"string","description":"\n - StateInitializing: StateInitializing\n\nSuccessfully received Child Tenant creation request and has started processing the tenant creation.\n - StateCreating: StateCreating\n\nChild Tenant is in initial bootstrapping process.\n - StateCreateFailed: StateCreateFailed\n\nChild Tenant initial bootstrapping failed\n - StateInactive: StateInactive\n\nChild tenant state when hierarchical access between parent and child node could not be established\n - StateActive: StateActive\n\nChild Tenant is active and ready for access.\n - StateConfiguring: StateConfiguring\n\nProcessing additional configuration for the Child Tenant.\n - StateConfiguringFailed: StateConfiguringFailed\n\nAdditional configuration for the Child Tenant has failed\n - StateDeleteInProgress: StateDeleteInProgress\n\nChild tenant deletion is in progress\n - StateDeleteFailed: StateDeleteFailed\n\nChild tenant deletion failed","title":"States","enum":["StateInitializing","StateCreating","StateCreateFailed","StateInactive","StateActive","StateConfiguring","StateConfiguringFailed","StateDeleteInProgress","StateDeleteFailed"],"default":"StateInitializing","x-displayname":"States","x-ves-proto-enum":"ves.io.schema.tenant_management.child_tenant.FSMState"},"tenant_managementchild_tenantGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read child_tenant","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/tenant_managementchild_tenantCreateRequest"},"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/child_tenantReplaceRequest"},"spec":{"$ref":"#/components/schemas/tenant_managementchild_tenantGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/tenant_managementchild_tenantStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"tenant_managementchild_tenantGetResponseFormatCode":{"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"},"tenant_managementchild_tenantGetSpecType":{"type":"object","description":"Get child_tenant reads a given object from storage backend for metadata.namespace.","title":"Get child tenant","x-displayname":"Get Child Tenant","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.GetSpecType","properties":{"child_tenant_manager":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"company_name":{"type":"string","description":" Company name (enterprise only)\n\nExample: ` \"f5\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Company Name","x-ves-example":"f5","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"contact_detail":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"crm_details":{"$ref":"#/components/schemas/schemaCRMInfo"},"customer_info":{"$ref":"#/components/schemas/child_tenantCustomerInfo"},"domain":{"type":"string","description":" Text string that will be used for the subdomain of the new Child Tenant.\n This will be where users will directly log into the new Child Tenant. example domain.console.ves.volterra.io.\n\nExample: ` \"volterra\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 17\n  ves.io.schema.rules.string.min_len: 5\n  ves.io.schema.rules.string.not_in: [\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]\n  ves.io.schema.rules.string.ves_object_name: true\n","minLength":5,"maxLength":17,"x-displayname":"Domain","x-ves-example":"volterra","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"17","ves.io.schema.rules.string.min_len":"5","ves.io.schema.rules.string.not_in":"[\\\"ves\\\",\\\"volterra\\\",\\\"f5\\\"]","ves.io.schema.rules.string.ves_object_name":"true"}},"status":{"$ref":"#/components/schemas/tenant_managementchild_tenantFSMState"},"tenant_profile":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"tenant_managementchild_tenantListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of child_tenant","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.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/tenant_managementchild_tenantListResponseItem"},"x-displayname":"Items"}}},"tenant_managementchild_tenantListResponseItem":{"type":"object","description":"By default a summary of child_tenant 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 child_tenant","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this child_tenant","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this child_tenant","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates child_tenant is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/tenant_managementchild_tenantGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this child_tenant","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this child_tenant\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/tenant_managementchild_tenantStatusObject"},"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 child_tenant\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"tenant_managementchild_tenantReplaceSpecType":{"type":"object","description":"Replaces attributes of a child_tenant configuration","title":"Replace child tenant","x-displayname":"Replace Child Tenant","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.ReplaceSpecType","properties":{"company_name":{"type":"string","description":" Company name (enterprise only)\n\nExample: ` \"f5\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","maxLength":256,"x-displayname":"Company Name","x-ves-example":"f5","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"contact_detail":{"$ref":"#/components/schemas/schemacontactGlobalSpecType"},"customer_info":{"$ref":"#/components/schemas/child_tenantCustomerInfo"}}},"tenant_managementchild_tenantStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.tenant_management.child_tenant.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions represent the normalized status values for configuration object","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" A child tenant direct reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"viewsLinkRefType":{"type":"object","description":"LinkRefType\nThis message defines a reference to hyperlink that can be accessed via web.","x-ves-proto-message":"ves.io.schema.views.LinkRefType","properties":{"href":{"type":"string","description":" Referred link's location. This can be treated as equivalent of href in html.\n\nExample: ` \"https://f5.com/link/resource_a\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.min_len: 1\n","title":"HyperlinkRef","minLength":1,"maxLength":512,"x-displayname":"Hyperlink reference","x-ves-example":"https://f5.com/link/resource_a","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.min_len":"1"}},"name":{"type":"string","description":" Name to use for displaying above link in href\n\nExample: ` \"Resource A\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Name","minLength":1,"maxLength":256,"x-displayname":"Link Name","x-ves-example":"Resource A","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}}}}}