@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0095.public.ves.io.schema.shape.data_delivery.subscription.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.data_delivery.subscription","description":"Use this API to subscribe to Data Intelligence","version":""},"paths":{"/api/data-intelligence/namespaces/system/data-intelligence/addon/subscribe":{"post":{"summary":"Subscribe to Data Intelligence","description":"Subscribe to Data Intelligence","operationId":"ves.io.schema.shape.data_delivery.subscription.CustomAPI.Subscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionSubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-subscription-customapi-subscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.subscription.CustomAPI.Subscribe"},"x-displayname":"Data Intelligence Subscription API","x-ves-proto-service":"ves.io.schema.shape.data_delivery.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/system/data-intelligence/addon/unsubscribe":{"post":{"summary":"Unsubscribe to Client-Side Defense","description":"Unsubscribe to Client-Side Defense","operationId":"ves.io.schema.shape.data_delivery.subscription.CustomAPI.Unsubscribe","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionUnsubscribeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-subscription-customapi-unsubscribe"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.subscription.CustomAPI.Unsubscribe"},"x-displayname":"Data Intelligence Subscription API","x-ves-proto-service":"ves.io.schema.shape.data_delivery.subscription.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Data Intelligence Subscription API","x-ves-proto-package":"ves.io.schema.shape.data_delivery.subscription","components":{"schemas":{"subscriptionSubscribeRequest":{"type":"object","description":"Request of subscribe to Data-Intelligence","title":"SubscribeRequest","x-displayname":"Subscribe Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.subscription.SubscribeRequest"},"subscriptionSubscribeResponse":{"type":"object","description":"Response of subscribe to Data-Intelligence","title":"SubscribeResponse","x-displayname":"Subscribe Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.subscription.SubscribeResponse"},"subscriptionUnsubscribeRequest":{"type":"object","description":"Request of unsubscribe to Data-Intelligence","title":"UnsubscribeRequest","x-displayname":"Unsubscribe Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.subscription.UnsubscribeRequest"},"subscriptionUnsubscribeResponse":{"type":"object","description":"Response of unsubscribe to Data-Intelligence","title":"UnsubscribeResponse","x-displayname":"Unsubscribe Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.subscription.UnsubscribeResponse"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.data_type","description":"A data_type is defined by a set of rules. these rules include the patterns for which that data type will be detected.\nA data type also includes information like it's related compliances weather is sensitive data and is it also pii.\nA data type is either predefined - defined in system. or custom - defined by the user.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/data_types":{"post":{"summary":"Create Data Type","description":"Create data_type creates a new object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.data_type.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_typeCreateResponse"}}}},"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/data_typeCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-data_type-api-create"},"x-ves-proto-rpc":"ves.io.schema.data_type.API.Create"},"x-displayname":"Data Type","x-ves-proto-service":"ves.io.schema.data_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/data_types/{metadata.name}":{"put":{"summary":"Replace Data Type","description":"Replace data_type replaces an existing object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.data_type.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_typeReplaceResponse"}}}},"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/data_typeReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-data_type-api-replace"},"x-ves-proto-rpc":"ves.io.schema.data_type.API.Replace"},"x-displayname":"Data Type","x-ves-proto-service":"ves.io.schema.data_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/data_types":{"get":{"summary":"List Data Type","description":"List the set of data_type in a namespace","operationId":"ves.io.schema.data_type.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_typeListResponse"}}}},"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 data_type","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-data_type-api-list"},"x-ves-proto-rpc":"ves.io.schema.data_type.API.List"},"x-displayname":"Data Type","x-ves-proto-service":"ves.io.schema.data_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/data_types/{name}":{"get":{"summary":"Get Data Type","description":"Get data_type reads a given object from storage backend for metadata.namespace.","operationId":"ves.io.schema.data_type.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_typeGetResponse"}}}},"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-data_type-api-get"},"x-ves-proto-rpc":"ves.io.schema.data_type.API.Get"},"delete":{"summary":"Delete Data Type","description":"Delete the specified data_type","operationId":"ves.io.schema.data_type.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/data_typeDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-data_type-api-delete"},"x-ves-proto-rpc":"ves.io.schema.data_type.API.Delete"},"x-displayname":"Data Type","x-ves-proto-service":"ves.io.schema.data_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Data Type","x-ves-proto-package":"ves.io.schema.data_type","components":{"schemas":{"data_typeCompliance":{"type":"string","description":"Supported compliances frameworks\n","title":"Compliance","enum":["GDPR","CCPA","PIPEDA","LGPD","DPA_UK","PDPA_SG","APPI","HIPAA","CPRA_2023","CPA_CO","SOC2","PCI_DSS","ISO_IEC_27001","ISO_IEC_27701","EPRIVACY_DIRECTIVE","GLBA","SOX"],"default":"UNSPECIFIED","x-displayname":"Compliance","x-ves-proto-enum":"ves.io.schema.data_type.Compliance"},"data_typeCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of data_type","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.data_type.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/data_typeCreateSpecType"}}},"data_typeCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.data_type.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/data_typeGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"data_typeCreateSpecType":{"type":"object","description":"Create data_type creates a new object in the storage backend for metadata.namespace.","title":"Create data type","x-displayname":"Create Data Type","x-ves-proto-message":"ves.io.schema.data_type.CreateSpecType","properties":{"compliances":{"type":"array","description":" Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Relevant Compliances","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"is_pii":{"type":"boolean","description":" Select this option to classify the custom data type as personally identifiable information (PII)","format":"boolean","x-displayname":"Mark as PII"},"is_sensitive_data":{"type":"boolean","description":" Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.","format":"boolean","x-displayname":"Mark as Sensitive Data"},"rules":{"type":"array","description":" Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response\n\nExample: ` \"Value or Regex\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/data_typeDetectionRule"},"x-displayname":"Data Type Rules","x-ves-example":"Value or Regex","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"data_typeDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a data_type","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.data_type.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"}}},"data_typeDetectionRule":{"type":"object","description":"The detection rule specifies patterns and values to detect data type by.","title":"DetectionRule","x-displayname":"Detection Rule","x-ves-oneof-field-pattern_choice":"[\"key_pattern\",\"key_value_pattern\",\"value_pattern\"]","x-ves-proto-message":"ves.io.schema.data_type.DetectionRule","properties":{"key_pattern":{"$ref":"#/components/schemas/data_typeRulePatternType"},"key_value_pattern":{"$ref":"#/components/schemas/data_typeKeyValuePattern"},"value_pattern":{"$ref":"#/components/schemas/data_typeRulePatternType"}}},"data_typeExactValues":{"type":"object","description":"List of exact values to match.","title":"ExactValues","x-displayname":"Exact Values","x-ves-proto-message":"ves.io.schema.data_type.ExactValues","properties":{"exact_values":{"type":"array","description":" List of exact values to match.\n\nExample: ` \"email, Email, EMAIL\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_bytes: 1024\n  ves.io.schema.rules.repeated.unique: true\n","title":"exact_values","items":{"type":"string","maxLength":1024},"x-displayname":"Exact Values","x-ves-example":"email, Email, EMAIL","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_bytes":"1024","ves.io.schema.rules.repeated.unique":"true"}}}},"data_typeGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read data_type","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.data_type.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/data_typeCreateRequest"},"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/schemaObjectRefType"},"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/schemaObjectRefType"},"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/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/data_typeReplaceRequest"},"spec":{"$ref":"#/components/schemas/data_typeGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/data_typeStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"data_typeGetResponseFormatCode":{"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"},"data_typeGetSpecType":{"type":"object","description":"Get data_type reads a given object from storage backend for metadata.namespace.","title":"Get Data Types","x-displayname":"Get Data Type","x-ves-proto-message":"ves.io.schema.data_type.GetSpecType","properties":{"compliances":{"type":"array","description":" Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Relevant Compliances","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"is_pii":{"type":"boolean","description":" Select this option to classify the custom data type as personally identifiable information (PII)","format":"boolean","x-displayname":"Mark as PII"},"is_sensitive_data":{"type":"boolean","description":" Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.","format":"boolean","x-displayname":"Mark as Sensitive Data"},"rules":{"type":"array","description":" Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response\n\nExample: ` \"Value or Regex\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/data_typeDetectionRule"},"x-displayname":"Data Type Rules","x-ves-example":"Value or Regex","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"type":{"$ref":"#/components/schemas/data_typeOriginType"}}},"data_typeKeyValuePattern":{"type":"object","description":"Search for specific key & value patterns in the specified sections.","title":"Key-Value Pattern","x-displayname":"Key & Value Pattern","x-ves-proto-message":"ves.io.schema.data_type.KeyValuePattern","properties":{"key_pattern":{"$ref":"#/components/schemas/data_typeRulePatternType"},"value_pattern":{"$ref":"#/components/schemas/data_typeRulePatternType"}}},"data_typeListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of data_type","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.data_type.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/data_typeListResponseItem"},"x-displayname":"Items"}}},"data_typeListResponseItem":{"type":"object","description":"By default a summary of data_type 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 data_type","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.data_type.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this data_type","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this data_type","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates data_type is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/data_typeGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this data_type","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this data_type\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/data_typeStatusObject"},"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 data_type\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"data_typeOriginType":{"type":"object","x-ves-oneof-field-type_choice":"[\"custom\",\"predefined\"]","x-ves-proto-message":"ves.io.schema.data_type.OriginType","properties":{"custom":{"$ref":"#/components/schemas/ioschemaEmpty"},"predefined":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"data_typeReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a data_type","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.data_type.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/data_typeReplaceSpecType"}}},"data_typeReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.data_type.ReplaceResponse"},"data_typeReplaceSpecType":{"type":"object","description":"Replace data_type replaces an existing object in the storage backend for metadata.namespace.","title":"Replace Data Types","x-displayname":"Replace Data Type","x-ves-proto-message":"ves.io.schema.data_type.ReplaceSpecType","properties":{"compliances":{"type":"array","description":" Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Relevant Compliances","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"is_pii":{"type":"boolean","description":" Select this option to classify the custom data type as personally identifiable information (PII)","format":"boolean","x-displayname":"Mark as PII"},"is_sensitive_data":{"type":"boolean","description":" Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.","format":"boolean","x-displayname":"Mark as Sensitive Data"},"rules":{"type":"array","description":" Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response\n\nExample: ` \"Value or Regex\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/data_typeDetectionRule"},"x-displayname":"Data Type Rules","x-ves-example":"Value or Regex","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"data_typeRulePatternType":{"type":"object","description":"test","title":"Rule Pattern Type","x-displayname":"Rule Pattern Type","x-ves-oneof-field-type_choice":"[\"exact_values\",\"regex_value\",\"substring_value\"]","x-ves-proto-message":"ves.io.schema.data_type.RulePatternType","properties":{"exact_values":{"$ref":"#/components/schemas/data_typeExactValues"},"regex_value":{"type":"string","description":"Exclusive with [exact_values substring_value]\n Search for values matching this regular expression\n\nExample: ` \"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1024\n  ves.io.schema.rules.string.regex: true\n","title":"regex value","maxLength":1024,"x-displayname":"Regex Value","x-ves-example":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1024","ves.io.schema.rules.string.regex":"true"}},"substring_value":{"type":"string","description":"Exclusive with [exact_values regex_value]\n Search for values that include this substring\n\nExample: ` \"email\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1024\n","title":"subtstring","maxLength":1024,"x-displayname":"Substring Search","x-ves-example":"email","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1024"}}}},"data_typeStatusObject":{"type":"object","title":"Most recently observed status of object","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.data_type.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"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"}}},"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"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0097.public.ves.io.schema.operate.debug.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.operate.debug","description":"Proto definitions for debugging site","version":""},"paths":{"/api/operate/namespaces/system/sites/{site}/vpm/debug/global/check-debug-info-collection":{"get":{"summary":"Check Debug Info Collection","description":"Check if the zip file of debug info from node is available","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.CheckDebugInfoCollection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugCheckDebugInfoCollectionResponse"}}}},"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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-checkdebuginfocollection"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.CheckDebugInfoCollection"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/system/sites/{site}/vpm/debug/global/diagnosis":{"get":{"summary":"Diagnosis","description":"Get VPM network information","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.DiagnosisPublic","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugDiagnosisResponse"}}}},"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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"console_user","description":"x-example: \"console-user\"\nName of the console user who runs this command","in":"query","required":false,"x-displayname":"User","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-diagnosispublic"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.DiagnosisPublic"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/system/sites/{site}/vpm/debug/global/download-debug-info-collection":{"get":{"summary":"Download Debug Info Collection","description":"Download the zip file of debug info from node if available","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.DownloadDebugInfoCollection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-downloaddebuginfocollection"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.DownloadDebugInfoCollection"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/system/sites/{site}/vpm/debug/global/health":{"get":{"summary":"Health","description":"Get VPM health information","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.HealthPublic","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugHealthResponse"}}}},"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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"console_user","description":"x-example: \"console-user\"\nName of the console user who runs this command","in":"query","required":false,"x-displayname":"User","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-healthpublic"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.HealthPublic"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/system/sites/{site}/vpm/debug/{node}/change-password":{"post":{"summary":"ChangePassword","description":"Change host user password","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.ChangePasswordPublic","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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugChangePasswordRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-changepasswordpublic"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.ChangePasswordPublic"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/system/sites/{site}/vpm/debug/{node}/start-debug-info-collection":{"get":{"summary":"Start Debug Info Collection","description":"Start collecting a zip file of debug info from node","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.StartDebugInfoCollection","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":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node\nIf using global, debug info will be collected for all nodes.","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-startdebuginfocollection"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.StartDebugInfoCollection"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/global/list-service":{"get":{"summary":"List F5XC services","description":"Get List of services managed by Volterra","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.ListVolterraServices","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugListServicesResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-listvolterraservices"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.ListVolterraServices"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/global/{vesnamespace}/status":{"get":{"summary":"Status","description":"Get Status of F5XC components","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.Status","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugStatusResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"vesnamespace","description":"VES Namespace\n\nx-example: \"ves-system\"\nName of the site's namespace. Default's to ves-system.","in":"path","required":true,"x-displayname":"VES Namespace","schema":{"type":"string"}},{"name":"cached","description":"Use cached results in Status API","in":"query","required":false,"x-displayname":"Cached","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-status"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.Status"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec":{"post":{"summary":"Exec","description":"Run supported exec command on node","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.Exec","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugExecResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/debugExecRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-exec"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.Exec"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec-log":{"get":{"summary":"Exec Log","description":"Retrieve exec history on node","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.ExecLog","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugExecLogResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}},{"name":"line_count","description":"x-example: \"200\"\nNumber of last log lines","in":"query","required":false,"x-displayname":"Line Count","schema":{"type":"integer","format":"int64"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-execlog"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.ExecLog"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/exec-user":{"post":{"summary":"ExecUser","description":"Run supported exec command on node with lower privilege","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.ExecUser","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugExecResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/debugExecRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-execuser"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.ExecUser"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/host-ping":{"post":{"summary":"Host Ping","description":"Ping intiated from host kernel","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.HostPing","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugHostPingResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugHostPingRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-hostping"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.HostPing"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/reboot":{"post":{"summary":"Reboot node","description":"Reboot specific node in site","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.Reboot","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugRebootResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugRebootRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-reboot"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.Reboot"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/{service}/log":{"get":{"summary":"Log","description":"Get logs for given service from the specific node","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.Log","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugLogResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}},{"name":"service","description":"Service Name\n\nx-example: \"vpm\"\nName of the service","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}},{"name":"last_lines","description":"x-example: \"200\"\nNumber of last log lines","in":"query","required":false,"x-displayname":"Last Lines","schema":{"type":"integer","format":"int64"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-log"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.Log"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/debug/{node}/{service}/soft-restart":{"post":{"summary":"Soft restart","description":"Soft restart reloads VER instance on the node","operationId":"ves.io.schema.operate.debug.CustomPublicAPI.SoftRestart","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugSoftRestartResponse"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"node","description":"Node Name\n\nx-example: \"master-0\"\nName of the node","in":"path","required":true,"x-displayname":"Node Name","schema":{"type":"string"}},{"name":"service","description":"Service Name\n\nx-example: \"vpm\"\nName of the service","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugSoftRestartRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-debug-custompublicapi-softrestart"},"x-ves-proto-rpc":"ves.io.schema.operate.debug.CustomPublicAPI.SoftRestart"},"x-displayname":"Debug","x-ves-proto-service":"ves.io.schema.operate.debug.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Debug","x-ves-proto-package":"ves.io.schema.operate.debug","components":{"requestBodies":{"debugExecRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/debugExecRequest"}}},"required":true}},"schemas":{"apiHttpBody":{"type":"object","description":"Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n    message GetResourceRequest {\n      // A unique request id.\n      string request_id = 1;\n\n      // The raw HTTP body is bound to this field.\n      google.api.HttpBody http_body = 2;\n    }\n\n    service ResourceService {\n      rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n      rpc UpdateResource(google.api.HttpBody) returns\n      (google.protobuf.Empty);\n    }\n\nExample with streaming methods:\n\n    service CaldavService {\n      rpc GetCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n      rpc UpdateCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n    }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.","properties":{"content_type":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."},"data":{"type":"string","description":"The HTTP request/response body as raw binary.","format":"byte"},"extensions":{"type":"array","description":"Application specific response metadata. Must be set in the first response\nfor streaming APIs.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"debugChangePasswordRequest":{"type":"object","description":"Change password request for host","title":"Change Password Request","x-displayname":"Change Password Request","x-ves-proto-message":"ves.io.schema.operate.debug.ChangePasswordRequest","properties":{"console_user":{"type":"string","description":" Name of the console user who runs this command\n\nExample: ` \"console-user\"`","title":"User","x-displayname":"User","x-ves-example":"console-user"},"current_password":{"$ref":"#/components/schemas/schemaSecretType"},"new_password":{"$ref":"#/components/schemas/schemaSecretType"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"},"username":{"type":"string","description":" The user to change password on host\n\nExample: ` \"username\"`","title":"Username","x-displayname":"Username","x-ves-example":"username"}}},"debugCheckDebugInfoCollectionResponse":{"type":"object","description":"Check debug info from site","title":"Check Debug Info Collection Response","x-displayname":"Check Debug Info Collection Response","x-ves-proto-message":"ves.io.schema.operate.debug.CheckDebugInfoCollectionResponse","properties":{"collection_start_time":{"type":"string","description":" The UTC timestamp when the collection start\n\nExample: ` \"2024-06-18T0012\"`","title":"Collect Start Time","x-displayname":"Collect Start Time","x-ves-example":"2024-06-18T0012"},"debug_in_progress":{"type":"boolean","description":" True if debug is in progress\n\nExample: ` \"true\"`","title":"Debug In Progress","format":"boolean","x-displayname":"Debug In Progress","x-ves-example":"true"},"node_name":{"type":"string","description":" Name of the debug bundle\n\nExample: ` \"node-name\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"node-name"},"validity":{"type":"string","description":" The UTC timestamp of the validity of debug bundle \n\nExample: ` \"2024-06-18T2237\"`","title":"Debug Bundle Validity","x-displayname":"Debug Bundle Validity","x-ves-example":"2024-06-18T2237"}}},"debugCurlResponseItem":{"type":"object","properties":{"status":{"type":"object","description":"x-displayName: \"Status\"\nx-example: \"map<node-name, OK>\"\nThe map of curl status with key = node name, value = OK / Error","title":"Status"}}},"debugDiagnosisRespItem":{"type":"object","properties":{"arp_result":{"type":"string","description":"x-displayName: \"ARP Result\"\nx-example: \"? (169.254.0.11) at 06:4d:57:fb:c4:07 [ether]...\"\nFull response of address resolution protocol \"arp -an\" on host","title":"ARP Result"},"dns_connectivity":{"type":"array","description":"x-displayName: \"DNS Connectivity\"\nPing DNS (from /etc/resolv.conf) to check connectivity","title":"DNS Connectivity","items":{"$ref":"#/components/schemas/debugHostPingResponse"}},"dns_query_result":{"type":"array","description":"x-displayName: \"DNS Query Result\"\nx-example: \"@192.168.0.2 https://downloads.volterra.io\\n; (1 server found)...\"\nDig DNS to resolve DNS for domains","title":"DNS Query Result","items":{"type":"string"}},"domain_curl_result":{"type":"object","description":"x-displayName: \"Domain Curl Result\"\nx-example: \"map<domain-url, curl-status>\"\nThe curl status for all required domains from all nodes","title":"Domain Curl Result"},"errors":{"type":"object","description":"x-displayName: \"Errors\"\nx-example: \"map<command, error-messages>\"\nThe map of errors with key = diagnosis command, value = all error messages for that command","title":"Errors"},"gateway_connectivity":{"$ref":"#/components/schemas/debugHostPingResponse"},"ifconfig_result":{"type":"string","description":"x-displayName: \"Interface Config\"\nx-example: \"argo-end: flags=4163\\u003cUP,BROADCAST,...\"\nFull response of interface configuration \"ifconfig -a\" on host","title":"Interface Config"},"node_name":{"type":"string","description":"x-displayName: \"Node Name\"\nx-example: \"master-0\"\nName of the node","title":"Node Name"},"nodes_connectivity":{"type":"array","description":"x-displayName: \"Nodes Connectivity\"\nPing nodes (if multiple) to check connectivity","title":"Nodes Connectivity","items":{"$ref":"#/components/schemas/debugHostPingResponse"}},"ntp_sync_status":{"type":"string","description":"x-displayName: \"NTP Sync Status\"\nx-example: \"System clock synchronized: yes...\"\nFull response from \"timedatectl status\" on host","title":"NTP Sync Status"},"registration_status":{"type":"string","description":"x-displayName: \"Registration Status\"\nx-example: \"OK\"\nIndicate whether registration is success or failed with some error","title":"Registration Status"},"resolv_conf":{"type":"string","description":"x-displayName: \"Resolv Conf\"\nx-example: \"nameserver 192.168.0.2...\"\nFull response of /etc/resolv.conf information","title":"Resolv Conf"},"route_result":{"type":"string","description":"x-displayName: \"Route Result\"\nx-example: \"Kernel IP routing table...\"\nFull response from \"route -n\" on host","title":"Route Result"}}},"debugDiagnosisResponse":{"type":"object","description":"Dignosis response info from site","title":"Diagnosis Response","x-displayname":"Diagnosis Response","x-ves-proto-message":"ves.io.schema.operate.debug.DiagnosisResponse","properties":{"curl_response":{"type":"object","description":" The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes\n\nExample: ` \"map<domain-url, curl-status>\"`","title":"Curl Responses","x-displayname":"Curl Responses","x-ves-example":"map<domain-url, curl-status>"},"registration_status":{"type":"object","description":" The subset from full diagnosis response of Registration Status from all nodes\n\nExample: ` \"map<node-name, registration-status>\"`","title":"Registration Status","x-displayname":"Registration Status","x-ves-example":"map<node-name, registration-status>"},"responses":{"type":"object","description":" The full diagnosis response of all nodes\n\nExample: ` \"map<node-name, diganosis-response-object>\"`","title":"Responses","x-displayname":"Responses","x-ves-example":"map<node-name, diganosis-response-object>"}}},"debugExecLogResponse":{"type":"object","description":"Exec Log response","title":"Exec Log Response","x-displayname":"Exec Log Response","x-ves-proto-message":"ves.io.schema.operate.debug.ExecLogResponse","properties":{"exec_log":{"type":"string","description":" Exec Log output from specific service","title":"Exec Log","x-displayname":"Exec Log"}}},"debugExecRequest":{"type":"object","description":"Request to execute cli command on a specific node in site","title":"Exec Request","x-displayname":"Exec Request","x-ves-proto-message":"ves.io.schema.operate.debug.ExecRequest","properties":{"command":{"type":"array","description":" Command to execute\n\nExample: ` [\"nslookup\", \"google.com\"]`","title":"Command","items":{"type":"string"},"x-displayname":"Command"},"console_user":{"type":"string","description":" Name of the console user who runs this command\n\nExample: ` \"console-user\"`","title":"User","x-displayname":"User","x-ves-example":"console-user"},"namespace":{"type":"string","description":" Namespace for which the request is sent (system)\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"debugExecResponse":{"type":"object","description":"Exec response","title":"Exec Response","x-displayname":"Exec Response","x-ves-proto-message":"ves.io.schema.operate.debug.ExecResponse","properties":{"output":{"type":"string","description":" Output of the requested command.\n\nExample: ` \"Non-authoritative answer:\\nName   google.com\\nAddress: 172.217.12.110\"`","title":"Command output","x-displayname":"Command output","x-ves-example":"Non-authoritative answer:\\nName:    google.com\\nAddress: 172.217.12.110"},"return_code":{"type":"integer","description":" Return code of requested command\n\nExample: ` \"0\"`","title":"Reture code","format":"int32","x-displayname":"Reture code","x-ves-example":"0"}}},"debugHealthResponse":{"type":"object","description":"Health response info from site","title":"Health Response","x-displayname":"Health Response","x-ves-proto-message":"ves.io.schema.operate.debug.HealthResponse","properties":{"fqdn":{"type":"string","description":" Node FQDN used during registration","title":"Node FQND","x-displayname":"Node FQND"},"hostname":{"type":"string","description":" Hostname of the node","title":"Hostname","x-displayname":"Hostname"},"initial_password_changed":{"type":"boolean","description":" If the factory password changed on host","title":"Factory Password Changed","format":"boolean","x-displayname":"Factory Password Changed"},"lte_support":{"type":"boolean","description":" If the box has LTE support","title":"LTE Support","format":"boolean","x-displayname":"LTE Support"},"os_info":{"$ref":"#/components/schemas/siteOsInfo"},"os_version":{"type":"string","description":" OS version on host","title":"OS Version","x-displayname":"OS Version"},"public_ip":{"type":"string","description":" Public IP gives vhost0 or other primary IP","title":"Public IP","x-displayname":"Public IP"},"roles":{"type":"array","description":" If node is worker node","title":"Roles","items":{"type":"string"},"x-displayname":"Roles"},"software_version":{"type":"string","description":" Volterra software version","title":"Software Version","x-displayname":"Software Version"},"state":{"$ref":"#/components/schemas/debugVpmState"},"version":{"type":"string","description":" VPM version running on host","title":"VPM Version","x-displayname":"VPM version"},"wifi_support":{"type":"boolean","description":" If the box has WIFI support","title":"WIFI Support","format":"boolean","x-displayname":"WIFI Support"}}},"debugHostPingRequest":{"type":"object","description":"Request to initiate ping from the site","title":"Host Ping Request","x-displayname":"Host Ping Request","x-ves-proto-message":"ves.io.schema.operate.debug.HostPingRequest","properties":{"count":{"type":"integer","description":" number of ping requests\n\nExample: ` \"3\"`","title":"Count","format":"int32","x-displayname":"Count","x-ves-example":"3"},"dest":{"type":"string","description":" Destination to ping can be IP Address or DNS name\n\nExample: ` \"google.com\"`","title":"Destination","x-displayname":"Destination","x-ves-example":"google.com"},"interval":{"type":"integer","description":" Interval is the wait time between each packet send. Default is 1s (1000ms).\n\nExample: ` \"1000\"`","title":"Interval","format":"int32","x-displayname":"Interval","x-ves-example":"1000"},"length":{"type":"integer","description":" Size of packet being sent\n\nExample: ` \"56\"`","title":"Length","format":"int32","x-displayname":"Size","x-ves-example":"56"},"namespace":{"type":"string","description":" Namespace for which the request is sent (system)\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"debugHostPingResponse":{"type":"object","description":"Response to initiated ping from the site","title":"Host Ping Response","x-displayname":"Host Ping Response","x-ves-proto-message":"ves.io.schema.operate.debug.HostPingResponse","properties":{"avg_rtt":{"type":"string","description":" AvgRtt is the average round-trip time.\n\nExample: ` \"76.599µs\"`","title":"Average RTT","x-displayname":"Average RTT","x-ves-example":"76.599µs"},"dest_ip":{"type":"string","description":" Destination IP is the address of the host being pinged.\n\nExample: ` \"8.8.8.8\"`","title":"Destination IP","x-displayname":"Destination IP","x-ves-example":"8.8.8.8"},"lost":{"type":"integer","description":" Lost is the percentage of packets lost.\n\nExample: ` \"0\"`","title":"Packets Lost","format":"int32","x-displayname":"Packets Lost","x-ves-example":"0"},"max_rtt":{"type":"string","description":" MaxRtt is the maximum round-trip time.\n\nExample: ` \"134.83µs\"`","title":"Max RTT","x-displayname":"Max RTT","x-ves-example":"134.83µs"},"min_rtt":{"type":"string","description":"MinRtt is the minimum round-trip time.\n\nExample: ` \"44.686µs\"`","title":"Min RTT","x-displayname":"Min RTT","x-ves-example":"44.686µs"},"received":{"type":"integer","description":" Received is the number of packets received.\n\nExample: ` \"5\"`","title":"Packets Received","format":"int32","x-displayname":"Packets Received","x-ves-example":"5"},"sent":{"type":"integer","description":" Sent is the number of packets sent.\n\nExample: ` \"5\"`","title":"Packets Sent","format":"int32","x-displayname":"Packets Sent","x-ves-example":"5"},"std_dev_rtt":{"type":"string","description":" StdDevRtt is the standard deviation of the round-trip times.\n\nExample: ` \"30.619µs\"`","title":"Standard Deviation RTT","x-displayname":"Standard Deviation RTT","x-ves-example":"30.619µs"}}},"debugListServicesResponse":{"type":"object","description":"List Services response","title":"List Services Response","x-displayname":"List Services Response","x-ves-proto-message":"ves.io.schema.operate.debug.ListServicesResponse","properties":{"service":{"type":"array","description":" List of services from site","title":"Services","items":{"$ref":"#/components/schemas/debugService"},"x-displayname":"Services"}}},"debugLogResponse":{"type":"object","description":"Log response","title":"Log Response","x-displayname":"Log Response","x-ves-proto-message":"ves.io.schema.operate.debug.LogResponse","properties":{"log":{"type":"string","description":" Log output from specific service","title":"Log","x-displayname":"Log"}}},"debugRebootRequest":{"type":"object","description":"Request to reboot specific node in site","title":"Reboot Request","x-displayname":"Reboot Request","x-ves-proto-message":"ves.io.schema.operate.debug.RebootRequest","properties":{"namespace":{"type":"string","description":" Namespace for which the request is sent (system)\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"debugRebootResponse":{"type":"object","description":"Reboot response","title":"Reboot Response","x-displayname":"Reboot Response","x-ves-proto-message":"ves.io.schema.operate.debug.RebootResponse"},"debugService":{"type":"object","description":"Name and formal displayed name of the service","title":"Service","x-displayname":"Service","x-ves-proto-message":"ves.io.schema.operate.debug.Service","properties":{"name":{"type":"string","description":" Formal displayed name of service\n\nExample: ` \"F5XC Platform Manager\"`","title":"Name","x-displayname":"Name","x-ves-example":"F5XC Platform Manager"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"value":{"type":"string","description":" Short name of service\n\nExample: ` \"vpm\"`","title":"Value","x-displayname":"Value","x-ves-example":"vpm"}}},"debugSoftRestartRequest":{"type":"object","description":"Request to soft restart reloads VER instance on the node","title":"Soft restart Request","x-displayname":"Soft restart Request","x-ves-proto-message":"ves.io.schema.operate.debug.SoftRestartRequest","properties":{"namespace":{"type":"string","description":" Namespace for which the request is sent (system)\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"node":{"type":"string","description":" Name of the node\n\nExample: ` \"master-0\"`","title":"Node Name","x-displayname":"Node Name","x-ves-example":"master-0"},"service":{"type":"string","description":" Name of the service\n\nExample: ` \"vpm\"`","title":"Service Name","x-displayname":"Service Name","x-ves-example":"vpm"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"debugSoftRestartResponse":{"type":"object","description":"Soft Restart response","title":"Soft Restart Response","x-displayname":"Soft Restart Response","x-ves-proto-message":"ves.io.schema.operate.debug.SoftRestartResponse"},"debugStatus":{"type":"object","description":"Status of the service","title":"Status","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.operate.debug.Status","properties":{"message":{"type":"string","description":" Human readable reason of the Status\n\nExample: ` \"containers with unready status[wingman opera]\"`","title":"Message","x-displayname":"Message","x-ves-example":"containers with unready status: [wingman opera]"},"name":{"type":"string","description":" Name of the service\n\nExample: ` \"ver\"`","title":"Name","x-displayname":"Name","x-ves-example":"ver"},"node":{"type":"string","description":" Node where service runs\n\nExample: ` \"master-0\"`","title":"Node","x-displayname":"Node","x-ves-example":"master-0"},"status":{"type":"string","description":" Status of the service\n\nExample: ` \"Ready\"`","title":"Status","x-displayname":"Status","x-ves-example":"Ready"}}},"debugStatusResponse":{"type":"object","description":"Status response","title":"Status Response","x-displayname":"Status Response","x-ves-proto-message":"ves.io.schema.operate.debug.StatusResponse","properties":{"status":{"type":"array","description":" List of status from site","title":"Status","items":{"$ref":"#/components/schemas/debugStatus"},"x-displayname":"Status"}}},"debugVpmState":{"type":"string","description":"State of Site defines in which operational state site itself is.\n\nSite is waiting for input configuration.\nSite is waiting for approval.\nSite is in provisioning state.\nSite is in provisioned.\nSite is in failed state. It failed during any stage.\nSite is in factory resetting mode","title":"VpmState","enum":["WAITING_FOR_CONFIG","WAITING_FOR_APPROVAL","PROVISIONING","PROVISIONED","FAILED","RESETTING"],"default":"WAITING_FOR_CONFIG","x-displayname":"Site State","x-ves-proto-enum":"ves.io.schema.operate.debug.VpmState"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"siteBios":{"type":"object","description":"BIOS information.","title":"Bios Data","x-displayname":"Bios Data","x-ves-proto-message":"ves.io.schema.site.Bios","properties":{"date":{"type":"string","description":" information from /sys/class/dmi/id/bios_date\n\nExample: ` \"value\"`","title":"date","x-displayname":"Date","x-ves-example":"value"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/bios_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/bios_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteBoard":{"type":"object","description":"Board information","title":"Board Details","x-displayname":"Board Details","x-ves-proto-message":"ves.io.schema.site.Board","properties":{"asset_tag":{"type":"string","description":" information from /sys/class/dmi/id/board_asset_tag\n\nExample: ` \"value\"`","title":"asset_tag","x-displayname":"Asset Tag","x-ves-example":"value"},"name":{"type":"string","description":" information from /sys/class/dmi/id/board_name\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"serial":{"type":"string","description":" information from /sys/class/dmi/id/board_serial\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/board_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/board_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteChassis":{"type":"object","description":"Chassis information.","title":"Chassis Details","x-displayname":"Chassis Details","x-ves-proto-message":"ves.io.schema.site.Chassis","properties":{"asset_tag":{"type":"string","description":" information from /sys/class/dmi/id/chassis_asset_tag\n\nExample: ` \"value\"`","title":"asset_tag","x-displayname":"Asset Tag","x-ves-example":"value"},"serial":{"type":"string","description":" information from /sys/class/dmi/id/chassis_serial\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"type":{"type":"integer","description":" information from /sys/class/dmi/id/chassis_type\n\nExample: ` \"0\"`","title":"type","format":"int64","x-displayname":"Type","x-ves-example":"0"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/chassis_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/chassis_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteCpu":{"type":"object","description":"CPU information","title":"Cpu information","x-displayname":"Cpu Information","x-ves-proto-message":"ves.io.schema.site.Cpu","properties":{"cache":{"type":"integer","description":" CPU cache size in KB\n\nExample: ` \"8192\"`","title":"cache","format":"int64","x-displayname":"Cache","x-ves-example":"8192"},"cores":{"type":"integer","description":" number of physical CPU cores\n\nExample: ` \"4\"`","title":"cores","format":"int64","x-displayname":"Cores","x-ves-example":"4"},"cpus":{"type":"integer","description":" number of physical CPUs\n\nExample: ` \"4\"`","title":"cpus","format":"int64","x-displayname":"CPUs","x-ves-example":"4"},"model":{"type":"string","description":" CPU model\n\nExample: ` \"value\"`","title":"model","x-displayname":"Model","x-ves-example":"value"},"speed":{"type":"integer","description":" CPU clock rate in MHz\n\nExample: ` \"4200\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"4200"},"threads":{"type":"integer","description":" number of logical (HT) CPU cores\n\nExample: ` \"4\"`","title":"threads","format":"int64","x-displayname":"Threads","x-ves-example":"4"},"vendor":{"type":"string","description":" CPU vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"}}},"siteGPU":{"type":"object","description":"GPU information on server","title":"GPU","x-displayname":"GPU","x-ves-proto-message":"ves.io.schema.site.GPU","properties":{"cuda_version":{"type":"string","description":" GPU Cuda Version\n\nExample: ` \"10.2\"`","title":"cudaVersion","x-displayname":"Cuda Version","x-ves-example":"10.2"},"driver_version":{"type":"string","description":" GPU Driver Version\n\nExample: ` \"440.82\"`","title":"driverVersion","x-displayname":"Driver Version","x-ves-example":"440.82"},"gpu_device":{"type":"array","description":" List of GPU devices in server","title":"GPUDevice","items":{"$ref":"#/components/schemas/siteGPUDevice"},"x-displayname":"GPU devices"}}},"siteGPUDevice":{"type":"object","title":"GPUDevice","x-displayname":"GPUDevice","x-ves-proto-message":"ves.io.schema.site.GPUDevice","properties":{"id":{"type":"string","description":" GPU ID\n\nExample: ` \"00000000:17:00.0\"`","title":"id","x-displayname":"GPU ID","x-ves-example":"00000000:17:00.0"},"processes":{"type":"string","description":" GPU Processes\n\nExample: ` \"value\"`","title":"processes","x-displayname":"Processes","x-ves-example":"value"},"product_name":{"type":"string","description":" GPU Product Name\n\nExample: ` \"Quadro P1000\"`","title":"productName","x-displayname":"Product Name","x-ves-example":"Quadro P1000"}}},"siteKernel":{"type":"object","description":"Kernel information","title":"Kernel Information","x-displayname":"Kernel","x-ves-proto-message":"ves.io.schema.site.Kernel","properties":{"architecture":{"type":"string","description":" kernel architecture\n\nExample: ` \"value\"`","title":"architecture","x-displayname":"Architecture","x-ves-example":"value"},"release":{"type":"string","description":" kernel release\n\nExample: ` \"value\"`","title":"release","x-displayname":"Release","x-ves-example":"value"},"version":{"type":"string","description":" kernel version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteLinkQuality":{"type":"string","description":"Link quality determined by VER using different probes\n\nUnknown quality\nLink quality is good\nLink quality is poor\nQuality disabled","title":"Link quality","enum":["QUALITY_UNKNOWN","QUALITY_GOOD","QUALITY_POOR","QUALITY_DISABLED"],"default":"QUALITY_UNKNOWN","x-displayname":"Link quality","x-ves-proto-enum":"ves.io.schema.site.LinkQuality"},"siteLinkType":{"type":"string","description":"Link type of interface determined operationally\n\nLink type unknown\nLink type ethernet\nWiFi link of type 802.11ac\nWiFi link of type 802.11bgn\nLink type 4G\nWiFi link\nWan link","title":"Link type","enum":["LINK_TYPE_UNKNOWN","LINK_TYPE_ETHERNET","LINK_TYPE_WIFI_802_11AC","LINK_TYPE_WIFI_802_11BGN","LINK_TYPE_4G","LINK_TYPE_WIFI","LINK_TYPE_WAN"],"default":"LINK_TYPE_UNKNOWN","x-displayname":"Link type","x-ves-proto-enum":"ves.io.schema.site.LinkType"},"siteMemory":{"type":"object","description":"Memory information.","title":"Memory Information","x-displayname":"Memory Information","x-ves-proto-message":"ves.io.schema.site.Memory","properties":{"size_mb":{"type":"integer","description":" RAM size in MB\n\nExample: ` \"value\"`","title":"size_mb","format":"int64","x-displayname":"RAM","x-ves-example":"value"},"speed":{"type":"integer","description":" RAM data rate in MT/s\n\nExample: ` \"value\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"value"},"type":{"type":"string","description":" type of memory, eg. DDR4\n\nExample: ` \"DDR4\"`","title":"type","x-displayname":"Type","x-ves-example":"DDR4"}}},"siteNetworkDevice":{"type":"object","description":"NetworkDevice information.","title":"Network Device Information","x-displayname":"Network Device Information","x-ves-proto-message":"ves.io.schema.site.NetworkDevice","properties":{"driver":{"type":"string","description":" driver of device, eg. e1000e\n\nExample: ` \"e1000e\"`","title":"driver","x-displayname":"Driver","x-ves-example":"e1000e"},"ip_address":{"type":"array","description":" ip address on interface\n\nExample: ` \"1.1.1.1\"`","title":"ip_address","items":{"type":"string"},"x-displayname":"IP Address","x-ves-example":"1.1.1.1"},"link_quality":{"$ref":"#/components/schemas/siteLinkQuality"},"link_type":{"$ref":"#/components/schemas/siteLinkType"},"mac_address":{"type":"string","description":" mac address on interface\n\nExample: ` \"value\"`","title":"mac_address","x-displayname":"MAC Address","x-ves-example":"value"},"name":{"type":"string","description":" name of device, eg. eth0\n\nExample: ` \"eth0\"`","title":"name","x-displayname":"Name","x-ves-example":"eth0"},"port":{"type":"string","description":" used port, eg. tp\n\nExample: ` \"value\"`","title":"port","x-displayname":"Port","x-ves-example":"value"},"speed":{"type":"integer","description":" device max supported speed in Mbps\n\nExample: ` \"1000\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"1000"}}},"siteOS":{"type":"object","description":"Details of Operating System","title":"OS","x-displayname":"OS","x-ves-proto-message":"ves.io.schema.site.OS","properties":{"architecture":{"type":"string","description":" Architecture of OS\n\nExample: ` \"amd64\"`","title":"architecture","x-displayname":"Architecture","x-ves-example":"amd64"},"name":{"type":"string","description":" Name of OS\n\nExample: ` \"Container Linux by CoreOS 1855.4.0 (Rhyolite)\"`","title":"name","x-displayname":"Name","x-ves-example":"Container Linux by CoreOS 1855.4.0 (Rhyolite)"},"release":{"type":"string","description":" Release of the OS\n\nExample: ` \"20.04\"`","title":"release","x-displayname":"Release","x-ves-example":"20.04"},"vendor":{"type":"string","description":" Vendor of OS\n\nExample: ` \"coreos\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"coreos"},"version":{"type":"string","description":" Version of OS\n\nExample: ` \"1855.4.0\"`","title":"version","x-displayname":"Version","x-ves-example":"1855.4.0"}}},"siteOsInfo":{"type":"object","description":"OsInfo holds information about host OS and HW","title":"OsInfo","x-displayname":"Os Info","x-ves-proto-message":"ves.io.schema.site.OsInfo","properties":{"bios":{"$ref":"#/components/schemas/siteBios"},"board":{"$ref":"#/components/schemas/siteBoard"},"chassis":{"$ref":"#/components/schemas/siteChassis"},"cpu":{"$ref":"#/components/schemas/siteCpu"},"gpu":{"$ref":"#/components/schemas/siteGPU"},"kernel":{"$ref":"#/components/schemas/siteKernel"},"memory":{"$ref":"#/components/schemas/siteMemory"},"network":{"type":"array","description":" List of network devices in server","title":"network","items":{"$ref":"#/components/schemas/siteNetworkDevice"},"x-displayname":"Network"},"numa_nodes":{"type":"integer","description":" Non-uniform memory access (NUMA) nodes count\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n","title":"NUMA Nodes Count","format":"int32","x-displayname":"NUMA nodes count","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0"}},"os":{"$ref":"#/components/schemas/siteOS"},"product":{"$ref":"#/components/schemas/siteProduct"},"storage":{"type":"array","description":" List of storage devices in server","title":"storage","items":{"$ref":"#/components/schemas/siteStorageDevice"},"x-displayname":"Storage"},"usb":{"type":"array","description":" List of USB devices in server","title":"USBDevice","items":{"$ref":"#/components/schemas/siteUSBDevice"},"x-displayname":"USB devices"}}},"siteProduct":{"type":"object","description":"Product information","title":"Product Information","x-displayname":"Product Information","x-ves-proto-message":"ves.io.schema.site.Product","properties":{"name":{"type":"string","description":" product name, eg. for aws m5a.xlarge. Info taken from /sys/class/dmi/id/product_name\n\nExample: ` \"m5a.xlarge\"`","title":"name","x-displayname":"Name","x-ves-example":"m5a.xlarge"},"serial":{"type":"string","description":" serial number, eg. for aws ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/id/product_serial\n\nExample: ` \"ec254b6d-9676-1a51-8b10-21370dbdc3e5\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"ec254b6d-9676-1a51-8b10-21370dbdc3e5"},"vendor":{"type":"string","description":" vendor name, eg. for aws Amazon EC2. Info taken from /sys/class/dmi/id/product_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" version name. Info taken from /sys/class/dmi/id/product_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteStorageDevice":{"type":"object","description":"StorageDevice information.","title":"Storage Information","x-displayname":"Storage Information","x-ves-proto-message":"ves.io.schema.site.StorageDevice","properties":{"driver":{"type":"string","description":" driver of device\n\nExample: ` \"value\"`","title":"driver","x-displayname":"Driver","x-ves-example":"value"},"model":{"type":"string","description":" model of device\n\nExample: ` \"value\"`","title":"model","x-displayname":"Model","x-ves-example":"value"},"name":{"type":"string","description":" name of device, eg. nvme0n1\n\nExample: ` \"nvme0n1\"`","title":"name","x-displayname":"Name","x-ves-example":"nvme0n1"},"serial":{"type":"string","description":" serial of device\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"size_gb":{"type":"integer","description":" device size in GB\n\nExample: ` \"value\"`","title":"size_gb","format":"int64","x-displayname":"Size(GB)","x-ves-example":"value"},"vendor":{"type":"string","description":" vendor of device\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"}}},"siteUSBDevice":{"type":"object","description":"Information about USB device","title":"USB device","x-displayname":"USB Device informaton","x-ves-proto-message":"ves.io.schema.site.USBDevice","properties":{"address":{"type":"integer","description":" Address of the device on the bus in decimal\n\nExample: ` \"4\"`","title":"address","format":"int64","x-displayname":"Address","x-ves-example":"4"},"b_device_class":{"type":"string","description":" The class of this device\n\nExample: ` \"hub\"`","title":"b_device_class","x-displayname":"Class","x-ves-example":"hub"},"b_device_protocol":{"type":"string","description":" The protocol (within the sub-class) of this device\n\nExample: ` \"0002\"`","title":"b_device_protocol","x-displayname":"Protocol","x-ves-example":"0002"},"b_device_sub_class":{"type":"string","description":" The sub-class (within the class) of this device\n\nExample: ` \"hub\"`","title":"b_device_sub_class","x-displayname":"Subclass","x-ves-example":"hub"},"b_max_packet_size":{"type":"integer","description":" Maximum size of the control transfer\n\nExample: ` \"64\"`","title":"b_max_packet_size","format":"int64","x-displayname":"Max packet size","x-ves-example":"64"},"bcd_device":{"type":"string","description":" The device version\n\nExample: ` \"5.05\"`","title":"bcd_device","x-displayname":"BCD Device","x-ves-example":"5.05"},"bcd_usb":{"type":"string","description":" USB Specification Release Number\n\nExample: ` \"2.0\"`","title":"bcd_usb","x-displayname":"BCD Spec","x-ves-example":"2.0"},"bus":{"type":"integer","description":" The bus on which the device was detected in decimal\n\nExample: ` \"1\"`","title":"bus","format":"int64","x-displayname":"Bus","x-ves-example":"1"},"description":{"type":"string","description":" Device description\n\nExample: ` \"NetVista Full Width Keyboard (IBM Corp.)\"`","title":"description","x-displayname":"Description","x-ves-example":"NetVista Full Width Keyboard (IBM Corp.)"},"i_manufacturer":{"type":"string","description":" Manufacturer name\n\nExample: ` \"Voltera\"`","title":"i_manufacturer","x-displayname":"Manufacturer","x-ves-example":"Voltera"},"i_product":{"type":"string","description":" Product name reported by device\n\nExample: ` \"xHCI Host Controller\"`","title":"i_product","x-displayname":"Device product","x-ves-example":"xHCI Host Controller"},"i_serial":{"type":"string","description":" Index of Serial Number String Descriptor\n\nExample: ` \"0000:00:14.0\"`","title":"i_serial_number","x-displayname":"iSerialNumber","x-ves-example":"0000:00:14.0"},"id_product":{"type":"string","description":" Product ID (Assigned by Manufacturer) in hex\n\nExample: ` \"0x0002\"`","title":"id_product","x-displayname":"Product ID","x-ves-example":"0x0002"},"id_vendor":{"type":"string","description":" Vendor ID (Assigned by USB Org) in hex\n\nExample: ` \"0x1d6b\"`","title":"id_vendor","x-displayname":"Vendor ID","x-ves-example":"0x1d6b"},"port":{"type":"integer","description":" Port on which the device was detected in decimal\n\nExample: ` \"3\"`","title":"port","format":"int64","x-displayname":"Port","x-ves-example":"3"},"product_name":{"type":"string","description":" Product ID translated to name (if available)\n\nExample: ` \"NetVista Full Width Keyboard\"`","title":"product_name","x-displayname":"Product name","x-ves-example":"NetVista Full Width Keyboard"},"speed":{"type":"string","description":" The negotiated operating speed for the device\n\nExample: ` \"high\"`","title":"speed","x-displayname":"Speed","x-ves-example":"high"},"usb_type":{"$ref":"#/components/schemas/siteUsbType"},"vendor_name":{"type":"string","description":" Vendor ID translated to name (if available)\n\nExample: ` \"IBM Corp.\"`","title":"vendor_name","x-displayname":"Vendor name","x-ves-example":"IBM Corp."}}},"siteUsbType":{"type":"string","description":"Type of USB device\n\nUnknown USB device type\nInternal USB present in Certified HW\nUSB device present during node registration\nUSB device that can be matched by USB rules","title":"UsbType","enum":["UNKNOWN_USB","INTERNAL","REGISTERED","CONFIGURABLE"],"default":"UNKNOWN_USB","x-displayname":"USB Type","x-ves-proto-enum":"ves.io.schema.site.UsbType"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0098.public.ves.io.schema.operate.dhcp.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.operate.dhcp","description":"Proto definitions for DHCP lease display. All leases provided to\nclients will be displayed.","version":""},"paths":{"/api/operate/namespaces/{namespace}/sites/{site}/ver/dhcp_leases":{"get":{"summary":"Show DHCP Leases","description":"Get DHCP lease information","operationId":"ves.io.schema.operate.dhcp.CustomPublicAPI.ShowDhcpLeases","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dhcpDhcpLeases"}}}},"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: \"value\"\nNamespace for which the request is sent (system)","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"Site Name\n\nx-example: \"value\"\nName of the site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-dhcp-custompublicapi-showdhcpleases"},"x-ves-proto-rpc":"ves.io.schema.operate.dhcp.CustomPublicAPI.ShowDhcpLeases"},"x-displayname":"Dhcp Leases","x-ves-proto-service":"ves.io.schema.operate.dhcp.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Dhcp Leases","x-ves-proto-package":"ves.io.schema.operate.dhcp","components":{"schemas":{"dhcpDhcpKeyValuePair":{"type":"object","description":"DHCP Option information as a (key, value) pair.","title":"DHCP Option information","x-displayname":"DHCP Option Information","x-ves-proto-message":"ves.io.schema.operate.dhcp.DhcpKeyValuePair","properties":{"key":{"type":"string","description":" Option key","title":"Key","x-displayname":"Key"},"value":{"type":"string","description":" Option value","title":"Value","x-displayname":"Value"}}},"dhcpDhcpLeaseInfo":{"type":"object","description":"Information about DHCP lease given by VER DHCP server.","title":"DHCP Lease Information","x-displayname":"DHCP Lease Information","x-ves-proto-message":"ves.io.schema.operate.dhcp.DhcpLeaseInfo","properties":{"client_id":{"type":"string","description":" Client identifier of the client\n\nExample: ` \"ff:73:6f:68:76:00:30:00:15:25:40:0b:aa:d7:0f\"`","title":"Client Identifier","x-displayname":"Client Identifier","x-ves-example":"ff:73:6f:68:76:00:30:00:15:25:40:0b:aa:d7:0f"},"description":{"type":"string","description":" Client Description","title":"Description","x-displayname":"Description"},"expiry":{"type":"string","description":" Lease expiry timestamp","title":"Expiry","format":"date-time","x-displayname":"Expiry"},"hostname":{"type":"string","description":" Host name of the client","title":"Host Name","x-displayname":"Host Name"},"interface":{"type":"string","description":" Name of the ver interface to which the client is connected","title":"Interface","x-displayname":"Interface"},"ip":{"type":"string","description":" IP address leased to the client\n\nExample: ` \"192.168.10.55\"`","title":"IP","x-displayname":"IP","x-ves-example":"192.168.10.55"},"issue_time":{"type":"string","description":" Lease issue timestamp","title":"Issue Time","format":"date-time","x-displayname":"Issue Time"},"mac":{"type":"string","description":" Mac address of the client\n\nExample: ` \"02:03:04:05:06:07\"`","title":"Mac","x-displayname":"Mac","x-ves-example":"02:03:04:05:06:07"},"options":{"type":"array","description":" DHCP option information","title":"Options","items":{"$ref":"#/components/schemas/dhcpDhcpKeyValuePair"},"x-displayname":"Options"},"subnet":{"type":"string","description":" Subnet of the client","title":"Subnet","x-displayname":"Subnet"}}},"dhcpDhcpLeases":{"type":"object","description":"Active list of DHCP leases that have been leased by VER DHCP server.","title":"DHCP Leases","x-displayname":"DHCP Leases","x-ves-proto-message":"ves.io.schema.operate.dhcp.DhcpLeases","properties":{"lease_info":{"type":"array","description":" DHCP lease information","title":"Lease Info","items":{"$ref":"#/components/schemas/dhcpDhcpLeaseInfo"},"x-displayname":"Lease Info"},"subnet_info":{"type":"array","description":" DHCP information per subnet","title":"Subnet Info","items":{"$ref":"#/components/schemas/dhcpDhcpSubnetInfo"},"x-displayname":"Subnet Info"}}},"dhcpDhcpSubnetInfo":{"type":"object","description":"Information about DHCP subnet","title":"DHCP Subnet Information","x-displayname":"DHCP Subnet Information","x-ves-proto-message":"ves.io.schema.operate.dhcp.DhcpSubnetInfo","properties":{"address_count":{"type":"integer","description":" Number of addresses in the subnet that DHCP can lease","title":"Address Count","format":"int64","x-displayname":"Address Count"},"free_address_count":{"type":"integer","description":" Number of addresses in the subnet that are free (not allocated)","title":"Free Addresses","format":"int64","x-displayname":"Free Addresses"},"interface":{"type":"string","description":" Name of the ver interface to which the subnet is assigned","title":"Interface","x-displayname":"Interface"},"subnet":{"type":"string","description":" Subnet address","title":"Subnet","x-displayname":"Subnet"}}}}}}