@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.operate.usb","description":"Proto definitions for runtime USB info on sites.","version":""},"paths":{"/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/config":{"get":{"summary":"Get USB configuration","description":"Get USB configuration from the node","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.GetConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbGetConfigResponse"}}}},"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"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-getconfig"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.GetConfig"},"post":{"summary":"Update USB configuration","description":"Update USB configuration on the node","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.UpdateConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbUpdateConfigResponse"}}}},"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/usbUsbUpdateConfigRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-updateconfig"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.UpdateConfig"},"x-displayname":"USB info","x-ves-proto-service":"ves.io.schema.operate.usb.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/list":{"get":{"summary":"List USB devices","description":"List connected USB devices","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbListResponse"}}}},"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"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-list"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.List"},"x-displayname":"USB info","x-ves-proto-service":"ves.io.schema.operate.usb.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules":{"get":{"summary":"List USB Enablement Rules","description":"List USB Enablement Rules","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.ListRules","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbListRulesResponse"}}}},"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"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-listrules"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.ListRules"},"x-displayname":"USB info","x-ves-proto-service":"ves.io.schema.operate.usb.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules/add":{"post":{"summary":"Add USB Enablement Rules","description":"Add USB Enablement Rules","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.AddRules","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbAddRulesResponse"}}}},"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/usbUsbAddRulesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-addrules"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.AddRules"},"x-displayname":"USB info","x-ves-proto-service":"ves.io.schema.operate.usb.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/operate/namespaces/{namespace}/sites/{site}/vpm/usb/{node}/rules/delete":{"post":{"summary":"Delete USB Enablement Rules","description":"Delete USB Enablement Rules","operationId":"ves.io.schema.operate.usb.CustomPublicAPI.DeleteRules","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usbUsbDeleteRulesResponse"}}}},"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/usbUsbDeleteRulesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-operate-usb-custompublicapi-deleterules"},"x-ves-proto-rpc":"ves.io.schema.operate.usb.CustomPublicAPI.DeleteRules"},"x-displayname":"USB info","x-ves-proto-service":"ves.io.schema.operate.usb.CustomPublicAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"USB info","x-ves-proto-package":"ves.io.schema.operate.usb","components":{"schemas":{"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"},"usbUsbAddRulesRequest":{"type":"object","description":"Request to add USB Enablement Rules","title":"USB Add Rules Request","x-displayname":"USB Add Rules Request","x-ves-proto-message":"ves.io.schema.operate.usb.UsbAddRulesRequest","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"},"rules":{"type":"array","description":" Add of USB Enablement Rules","title":"Rules","items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"USB Enablement Rules"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"usbUsbAddRulesResponse":{"type":"object","description":"Response to add USB Enablement Rules","title":"USB Add Rules Responsse","x-displayname":"USB Add Rules Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbAddRulesResponse","properties":{"rules":{"type":"array","description":" Added USB Enablement Rules","title":"Rules","items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"USB Enablement Rules"}}},"usbUsbConfig":{"type":"object","description":"usb config","title":"UsbConfig","x-displayname":"usb config","x-ves-proto-message":"ves.io.schema.operate.usb.UsbConfig","properties":{"usb_allow_list_enable":{"type":"boolean","description":" Enablement of USB rules list. If enabled, all new connected USB devices must be authorized.\n\nExample: ` false`","title":"usb_allow_list_enable","format":"boolean","x-displayname":"USB Allow List Enable"}}},"usbUsbDeleteRulesRequest":{"type":"object","description":"Request to delete USB Enablement Rules","title":"USB Delete Rules Request","x-displayname":"USB Delete Rules Request","x-ves-proto-message":"ves.io.schema.operate.usb.UsbDeleteRulesRequest","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"},"rules":{"type":"array","description":" Delete of USB Enablement Rules","title":"Rules","items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"USB Enablement Rules"},"site":{"type":"string","description":" Name of the site\n\nExample: ` \"value\"`","title":"Site Name","x-displayname":"Site Name","x-ves-example":"value"}}},"usbUsbDeleteRulesResponse":{"type":"object","description":"Response to delete USB Enablement Rules","title":"USB Delete Rules Responsse","x-displayname":"USB Delete Rules Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbDeleteRulesResponse","properties":{"rules":{"type":"array","description":" Deleted USB Enablement Rules","title":"Rules","items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"USB Enablement Rules"}}},"usbUsbGetConfigResponse":{"type":"object","description":"Current USB configuration.","title":"USB Get Config Response","x-displayname":"USB Get Config Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbGetConfigResponse","properties":{"config":{"$ref":"#/components/schemas/usbUsbConfig"}}},"usbUsbListResponse":{"type":"object","description":"Response to list available USB devices","title":"USB List Responsse","x-displayname":"USB List Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbListResponse","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"},"usb":{"type":"array","description":" List of USB devices in server","title":"USBDevice","items":{"$ref":"#/components/schemas/siteUSBDevice"},"x-displayname":"USB devices"}}},"usbUsbListRulesResponse":{"type":"object","description":"Response to list USB Enablement Rules","title":"USB List Rules Responsse","x-displayname":"USB List Rules Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbListRulesResponse","properties":{"rules":{"type":"array","description":" List of USB Enablement Rules","title":"Rule","items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"USB Enablement Rule"}}},"usbUsbUpdateConfigRequest":{"type":"object","description":"Updates USB configuration.","title":"USB Update Config Request","x-displayname":"USB Update Config Request","x-ves-proto-message":"ves.io.schema.operate.usb.UsbUpdateConfigRequest","properties":{"config":{"$ref":"#/components/schemas/usbUsbConfig"},"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"}}},"usbUsbUpdateConfigResponse":{"type":"object","description":"Response of Updates USB configuration.","title":"USB Update Config Response","x-displayname":"USB Update Config Response","x-ves-proto-message":"ves.io.schema.operate.usb.UsbUpdateConfigResponse"},"usb_policyRule":{"type":"object","description":"USB Enablement Rule","title":"Rule","x-displayname":"USB Enablement Rule","x-ves-proto-message":"ves.io.schema.usb_policy.Rule","properties":{"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"},"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"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.usb_policy","description":"USB policy is used to specify list of USB devices allowed to be attached to node.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/usb_policys":{"post":{"summary":"Create USB policy","description":"Creates a new USB policy object","operationId":"ves.io.schema.usb_policy.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usb_policyCreateResponse"}}}},"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/usb_policyCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usb_policy-api-create"},"x-ves-proto-rpc":"ves.io.schema.usb_policy.API.Create"},"x-displayname":"USB policy","x-ves-proto-service":"ves.io.schema.usb_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/usb_policys/{metadata.name}":{"put":{"summary":"Replace USB policy","description":"Replaces the content of an USB policy object","operationId":"ves.io.schema.usb_policy.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usb_policyReplaceResponse"}}}},"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/usb_policyReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usb_policy-api-replace"},"x-ves-proto-rpc":"ves.io.schema.usb_policy.API.Replace"},"x-displayname":"USB policy","x-ves-proto-service":"ves.io.schema.usb_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/usb_policys":{"get":{"summary":"List USB policy","description":"List the set of usb_policy in a namespace","operationId":"ves.io.schema.usb_policy.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usb_policyListResponse"}}}},"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 usb_policy","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-usb_policy-api-list"},"x-ves-proto-rpc":"ves.io.schema.usb_policy.API.List"},"x-displayname":"USB policy","x-ves-proto-service":"ves.io.schema.usb_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/usb_policys/{name}":{"get":{"summary":"Get USB policy","description":"Get the USB policy object","operationId":"ves.io.schema.usb_policy.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usb_policyGetResponse"}}}},"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-usb_policy-api-get"},"x-ves-proto-rpc":"ves.io.schema.usb_policy.API.Get"},"delete":{"summary":"Delete USB policy","description":"Delete the specified usb_policy","operationId":"ves.io.schema.usb_policy.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/usb_policyDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usb_policy-api-delete"},"x-ves-proto-rpc":"ves.io.schema.usb_policy.API.Delete"},"x-displayname":"USB policy","x-ves-proto-service":"ves.io.schema.usb_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"USB policy","x-ves-proto-package":"ves.io.schema.usb_policy","components":{"schemas":{"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"usb_policyCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of usb_policy","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.usb_policy.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/usb_policyCreateSpecType"}}},"usb_policyCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.usb_policy.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/usb_policyGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"usb_policyCreateSpecType":{"type":"object","description":"Creates a new USB policy object","title":"Create USB policy","x-displayname":"Create USB policy","x-ves-proto-message":"ves.io.schema.usb_policy.CreateSpecType","properties":{"allowed_devices":{"type":"array","description":" List of allowed USB devices\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.message.required_one_nonzero_field: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"Allowed USB devices","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.message.required_one_nonzero_field":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1"}}}},"usb_policyDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a usb_policy","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.usb_policy.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"}}},"usb_policyGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read usb_policy","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.usb_policy.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/usb_policyCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/usb_policyReplaceRequest"},"spec":{"$ref":"#/components/schemas/usb_policyGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/usb_policyStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"usb_policyGetResponseFormatCode":{"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"},"usb_policyGetSpecType":{"type":"object","description":"Get the USB policy object","title":"Get USB policy","x-displayname":"Get USB policy","x-ves-proto-message":"ves.io.schema.usb_policy.GetSpecType","properties":{"allowed_devices":{"type":"array","description":" List of allowed USB devices\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.message.required_one_nonzero_field: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"Allowed USB devices","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.message.required_one_nonzero_field":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1"}}}},"usb_policyListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of usb_policy","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.usb_policy.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/usb_policyListResponseItem"},"x-displayname":"Items"}}},"usb_policyListResponseItem":{"type":"object","description":"By default a summary of usb_policy 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 usb_policy","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.usb_policy.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this usb_policy","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this usb_policy","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates usb_policy is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/usb_policyGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this usb_policy","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this usb_policy\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/usb_policyStatusObject"},"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 usb_policy\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"usb_policyReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a usb_policy","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.usb_policy.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/usb_policyReplaceSpecType"}}},"usb_policyReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.usb_policy.ReplaceResponse"},"usb_policyReplaceSpecType":{"type":"object","description":"Replaces the content of an USB policy object","title":"Replace USB policy","x-displayname":"Replace USB policy","x-ves-proto-message":"ves.io.schema.usb_policy.ReplaceSpecType","properties":{"allowed_devices":{"type":"array","description":" List of allowed USB devices\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.message.required_one_nonzero_field: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 1\n","minItems":1,"maxItems":32,"items":{"$ref":"#/components/schemas/usb_policyRule"},"x-displayname":"Allowed USB devices","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.message.required_one_nonzero_field":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"1"}}}},"usb_policyRule":{"type":"object","description":"USB Enablement Rule","title":"Rule","x-displayname":"USB Enablement Rule","x-ves-proto-message":"ves.io.schema.usb_policy.Rule","properties":{"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"},"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"}}},"usb_policyStatusObject":{"type":"object","description":"Most recently observed status of object","title":"USB policy Status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.usb_policy.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0246.public.ves.io.schema.ui.static_component.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.ui.static_component","description":"stores information about the UI Components in key-value pair","version":""},"paths":{"/api/web/namespaces/{namespace}/static_components":{"get":{"summary":"List Ui Static Component","description":"List the set of static_component in a namespace","operationId":"ves.io.schema.ui.static_component.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/static_componentListResponse"}}}},"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 static_component","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-ui-static_component-api-list"},"x-ves-proto-rpc":"ves.io.schema.ui.static_component.API.List"},"x-displayname":"Ui Static Component","x-ves-proto-service":"ves.io.schema.ui.static_component.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{namespace}/static_components/{name}":{"get":{"summary":"Get Ui static component","description":"Get Ui static component.","operationId":"ves.io.schema.ui.static_component.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/static_componentGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-ui-static_component-api-get"},"x-ves-proto-rpc":"ves.io.schema.ui.static_component.API.Get"},"x-displayname":"Ui Static Component","x-ves-proto-service":"ves.io.schema.ui.static_component.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Ui Static Component","x-ves-proto-package":"ves.io.schema.ui.static_component","components":{"schemas":{"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"}}},"protobufNullValue":{"type":"string","description":"`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.","enum":["NULL_VALUE"],"default":"NULL_VALUE"},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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"}}},"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"}}},"static_componentGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read static_component","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.ui.static_component.GetResponse","properties":{"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/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"},"spec":{"$ref":"#/components/schemas/static_componentGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"static_componentGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"static_componentGetSpecType":{"type":"object","description":"Get Ui static component.","title":"Get Ui static component","x-displayname":"Get Ui static component","x-ves-proto-message":"ves.io.schema.ui.static_component.GetSpecType","properties":{"value":{"type":"object","description":" information of the UI component\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"static_componentListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of static_component","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.ui.static_component.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/static_componentListResponseItem"},"x-displayname":"Items"}}},"static_componentListResponseItem":{"type":"object","description":"By default a summary of static_component 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 static_component","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.ui.static_component.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this static_component","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this static_component","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates static_component is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/static_componentGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this static_component","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this static_component\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this static_component\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.upgrade_status","description":"Upgrade status custom APIs","version":""},"paths":{"/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check":{"get":{"summary":"Pre upgrade check","description":"API to check if site is ready for upgrade","operationId":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/upgrade_statusPreUpgradeCheckResponse"}}}},"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: \"shared\"\nFetch upgrade status for the given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"blogging-app\"\nFetch upgrade status for the name of site","in":"path","required":true,"x-displayname":"Site Name","schema":{"type":"string"}},{"name":"sw_version","description":"x-example: \"crt-20241107-1123\"\nSoftware version to upgrade to","in":"query","required":false,"x-displayname":"SW Version to upgrade to","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-upgrade_status-upgradestatuscustomapi-preupgradecheck"},"x-ves-proto-rpc":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck"},"x-displayname":"Upgrade Status","x-ves-proto-service":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/maurice/namespaces/{namespace}/sites/{name}/upgrade_status":{"get":{"summary":"Get Upgrade Status","description":"API to get upgrade status of a site","operationId":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/upgrade_statusGetUpgradeStatusResponse"}}}},"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: \"shared\"\nFetch upgrade status for the given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"blogging-app\"\nFetch upgrade status for the name of 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-upgrade_status-upgradestatuscustomapi-getupgradestatus"},"x-ves-proto-rpc":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus"},"x-displayname":"Upgrade Status","x-ves-proto-service":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/maurice/upgradable_sw_versions":{"get":{"summary":"Get Upgradable SW Versions","description":"API to get list of sw versions that can be upgraded to","operationId":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/upgrade_statusGetUpgradableSWVersionsResponse"}}}},"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":"current_os_version","description":"x-example: \"9.2023.23\"\nFetch upgradable sw versions for site","in":"query","required":false,"x-displayname":"Current OS Version","schema":{"type":"string"}},{"name":"current_sw_version","description":"x-example: \"crt-20241107-1123\"\nFetch upgradable sw versions for site","in":"query","required":false,"x-displayname":"Current SW Version","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-upgrade_status-upgradestatuscustomapi-getupgradableswversions"},"x-ves-proto-rpc":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions"},"x-displayname":"Upgrade Status","x-ves-proto-service":"ves.io.schema.upgrade_status.UpgradeStatusCustomApi","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Upgrade Status","x-ves-proto-package":"ves.io.schema.upgrade_status","components":{"schemas":{"schemaupgrade_statusGlobalSpecType":{"type":"object","title":"Shape of the status specification","x-displayname":"Global Specification","x-ves-proto-message":"ves.io.schema.upgrade_status.GlobalSpecType","properties":{"sw_upgrade_progress":{"$ref":"#/components/schemas/upgrade_statusSWUpgradeProgress"}}},"upgrade_statusApplicationObj":{"type":"object","description":"ApplicationObj shows the upgrade status of each object in a application in either site/node level upgrades","title":"ApplicationObj","x-displayname":"Application Object","x-ves-proto-message":"ves.io.schema.upgrade_status.ApplicationObj","properties":{"conditions":{"type":"array","title":"x-displayName: \"Conditions\"\nname of object","items":{"$ref":"#/components/schemas/upgrade_statusCondition"}},"debug":{"type":"string","title":"x-displayName: \"Name\"\ndebug? TODO: What is this, reference maurice deployment status object"},"deploy_strategy":{"type":"string","title":"x-displayName: \"Deploy Strategy\"\nDeployment strategy of object"},"kind":{"type":"string","title":"x-displayName: \"Kind\"\nKubernetes object kind"},"name":{"type":"string","title":"x-displayName: \"Name\"\nname of object"}}},"upgrade_statusChecklist":{"type":"object","x-ves-proto-message":"ves.io.schema.upgrade_status.Checklist","properties":{"item":{"type":"string","description":" Description of the checklist item\n\nExample: ` \"Node Failures\"`","title":"item","x-displayname":"Item","x-ves-example":"Node Failures"},"reason":{"type":"string","description":" reason for error\n\nExample: ` \"Could not reach one of the nodes.\"`","title":"reason","x-displayname":"Reason","x-ves-example":"Could not reach one of the nodes."},"status":{"$ref":"#/components/schemas/upgrade_statusChecklistStatus"}}},"upgrade_statusChecklistStatus":{"type":"string","description":"Upgrade check is unknown, likely backend issue where it cannot be determined.\nUpgrade check has passed.\nUpgrade check has failed.\nUpgrade check reports warning, but permissible.","enum":["CHECKLIST_UNKNOWN","CHECKLIST_PASSED","CHECKLIST_FAILED","CHECKLIST_WARNING"],"default":"CHECKLIST_UNKNOWN","x-displayname":"","x-ves-proto-enum":"ves.io.schema.upgrade_status.ChecklistStatus"},"upgrade_statusCondition":{"type":"object","description":"Condition of object in each phase of installation","title":"Condition","x-displayname":"Condition","x-ves-proto-message":"ves.io.schema.upgrade_status.Condition","properties":{"message":{"type":"string","description":"Message of action."},"result":{"type":"string","description":"Result of action, i.e. success etc."},"type":{"type":"string","title":"x-displayName: \"Type\"\nType of action to was applied with object, i.e. load, apply, running, status"}}},"upgrade_statusGetUpgradableSWVersionsResponse":{"type":"object","description":"Response to get the list of upgradable sw versions","title":"GetUpgradableSWVersionsResponse","x-displayname":"Get upgradable sw versions reponse","x-ves-proto-message":"ves.io.schema.upgrade_status.GetUpgradableSWVersionsResponse","properties":{"sw_versions":{"type":"array","description":" Fetch upgradable sw versions for site\n\nExample: ` \"[\\\"crt-20241107-1123\\\"]\"`","title":"sw_versions","items":{"type":"string"},"x-displayname":"SW Versions","x-ves-example":"[\\\"crt-20241107-1123\\\"]"}}},"upgrade_statusGetUpgradeStatusResponse":{"type":"object","description":"Response to get the upgrade status","title":"GetUpgradeStatusResponse","x-displayname":"Get upgrade status response","x-ves-proto-message":"ves.io.schema.upgrade_status.GetUpgradeStatusResponse","properties":{"upgrade_status":{"$ref":"#/components/schemas/schemaupgrade_statusGlobalSpecType"}}},"upgrade_statusImageDownload":{"type":"object","description":"ImageDownload shows each the entire image download stage.","title":"ImageDownload","x-displayname":"Image Download Stage","x-ves-proto-message":"ves.io.schema.upgrade_status.ImageDownload","properties":{"results":{"type":"array","description":"Results of each node in OS Setup.","items":{"$ref":"#/components/schemas/upgrade_statusInstallResult"}},"start_timestamp":{"type":"string","description":"Start timestamp of Image download.","format":"date-time"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusInstallResult":{"type":"object","description":"InstallResult shows the result each application/process.","title":"Install Result","x-displayname":"Install Result","x-ves-proto-message":"ves.io.schema.upgrade_status.InstallResult","properties":{"message":{"type":"string","description":"Message of this stage."},"name":{"type":"string","title":"x-displayName: \"Name\"\nName of this application/process"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"},"type":{"type":"string","title":"x-displayName: \"Type\"\nType of upgrade"}}},"upgrade_statusNodeLevelUpgrade":{"type":"object","description":"Node level upgrade shows the upgrades that are happening on a site level as opposed to site level.","title":"Node Level Upgrade","x-displayname":"Node Level Upgrade Stage","x-ves-proto-message":"ves.io.schema.upgrade_status.NodeLevelUpgrade","properties":{"results":{"type":"array","title":"x-displayName: \"Results\"\nResults for each stage in site level upgrades","items":{"$ref":"#/components/schemas/upgrade_statusNodeUpgradeResult"}},"start_timestamp":{"type":"string","description":"Start timestamp of Image download.","format":"date-time"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusNodeUpgradeResult":{"type":"object","x-ves-proto-message":"ves.io.schema.upgrade_status.NodeUpgradeResult","properties":{"name":{"type":"string","description":"Name of node."},"progress":{"$ref":"#/components/schemas/upgrade_statusUpgradeProgressCount"},"results":{"type":"array","title":"x-displayName: \"Results\"\nResults for each node in node level upgrades","items":{"$ref":"#/components/schemas/upgrade_statusStageUpgradeResults"}},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusOSNodeResult":{"type":"object","description":"OSNodeResult shows the result of OS upgrade for each node","title":"OSNodeResult","x-displayname":"OS Node Result","x-ves-proto-message":"ves.io.schema.upgrade_status.OSNodeResult","properties":{"name":{"type":"string","description":"Name of node."},"results":{"type":"array","description":"Result of each component in each node.","items":{"$ref":"#/components/schemas/upgrade_statusInstallResult"}},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusOSSetup":{"type":"object","description":"OSSetup shows the OS Setup stage.","title":"OSSetup","x-displayname":"OS Setup Stage","x-ves-proto-message":"ves.io.schema.upgrade_status.OSSetup","properties":{"results":{"type":"array","description":"Results of each node in OS Setup.","items":{"$ref":"#/components/schemas/upgrade_statusOSNodeResult"}},"start_timestamp":{"type":"string","description":"Start timestamp of OS setup.","format":"date-time"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusPreUpgradeCheckResponse":{"type":"object","description":"Result of pre upgrade checks","title":"GetUpgradableSWVersionsResponse","x-displayname":"Pre upgrade check response","x-ves-proto-message":"ves.io.schema.upgrade_status.PreUpgradeCheckResponse","properties":{"checklist":{"type":"array","description":" Checklist containing the items for pre upgrade check","title":"checklist","items":{"$ref":"#/components/schemas/upgrade_statusChecklist"},"x-displayname":"Checklist"}}},"upgrade_statusSWUpgradeProgress":{"type":"object","description":"SWStatus stores information about CE Site upgrade status","title":"SW Upgrade status information","x-displayname":"Software Upgrade Status Information","x-ves-proto-message":"ves.io.schema.upgrade_status.SWUpgradeProgress","properties":{"failure_reason":{"type":"string","description":"Reason for failure."},"image_download":{"$ref":"#/components/schemas/upgrade_statusImageDownload"},"node_level_upgrade":{"$ref":"#/components/schemas/upgrade_statusNodeLevelUpgrade"},"os_setup":{"$ref":"#/components/schemas/upgrade_statusOSSetup"},"retries":{"type":"integer","description":"Number of retries that has been issued.","format":"int32"},"site":{"type":"string","description":"Site for this upgrade status, assigned after status is assigned to site."},"site_level_upgrade":{"$ref":"#/components/schemas/upgrade_statusSiteLevelUpgrade"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"},"validation":{"$ref":"#/components/schemas/upgrade_statusValidation"},"version":{"type":"string","description":"Version that software is upgrading to."}}},"upgrade_statusSiteLevelUpgrade":{"type":"object","description":"Site level upgrade shows the upgrades that are happening on a site level as opposed to node level.","title":"Site Level Upgrade","x-displayname":"Site Level Upgrade Stage","x-ves-proto-message":"ves.io.schema.upgrade_status.SiteLevelUpgrade","properties":{"progress":{"$ref":"#/components/schemas/upgrade_statusUpgradeProgressCount"},"results":{"type":"array","title":"x-displayName: \"Results\"\nResults for each stage in site level upgrades","items":{"$ref":"#/components/schemas/upgrade_statusStageUpgradeResults"}},"start_timestamp":{"type":"string","description":"Start timestamp of Image download.","format":"date-time"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusStageApplication":{"type":"object","description":"StageApplication shows the upgrade status of each application in either site/node level upgrades","title":"StageApplication","x-displayname":"Stage Application","x-ves-proto-message":"ves.io.schema.upgrade_status.StageApplication","properties":{"name":{"type":"string","description":"Name of stage."},"objects":{"type":"array","title":"x-displayName: \"objects\"\nStatus of application objects in each application","items":{"$ref":"#/components/schemas/upgrade_statusApplicationObj"}},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusStageUpgradeResults":{"type":"object","description":"SiteLevelStageUpgradeResults shows the upgrade status of each stage and applications within the stage","title":"SiteLevelStageUpgradeResults","x-displayname":"Site Level Stage Upgrade Results","x-ves-proto-message":"ves.io.schema.upgrade_status.StageUpgradeResults","properties":{"applications":{"type":"array","title":"x-displayName: \"Applications\"\nStatus of application objects in each application","items":{"$ref":"#/components/schemas/upgrade_statusStageApplication"}},"name":{"type":"string","description":"Name of stage."},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}},"upgrade_statusStatus":{"type":"string","description":"Displays upgrade status for each section of the upgrade.\n\nUpgrade is scheduled but not started\nUpgrade is scheduled but not started\nUpgrade is in progress\nUpgrade has completed\nUpgrade has failed.\nUpgrade for this stage is skipped.","title":"Upgrade status types","enum":["UNKNOWN","SCHEDULED","IN_PROGRESS","COMPLETED","FAILED","SKIPPED"],"default":"UNKNOWN","x-displayname":"Upgrade Status","x-ves-proto-enum":"ves.io.schema.upgrade_status.Status"},"upgrade_statusUpgradeProgressCount":{"type":"object","description":"UpgradeProgressCount counts the total and completed apps that have been upgraded.","title":"UpgradeProgressCount","x-displayname":"Upgrade progress count","x-ves-proto-message":"ves.io.schema.upgrade_status.UpgradeProgressCount","properties":{"completed":{"type":"integer","description":"Number of apps that have been upgraded within a level.","format":"int32"},"total":{"type":"integer","description":"Total number of apps to upgrade.","format":"int32"}}},"upgrade_statusValidation":{"type":"object","description":"Validation represents the last stage in the upgrade phase, checking if everything has been upgraded properly.","title":"Validation","x-displayname":"Validation stage","x-ves-proto-message":"ves.io.schema.upgrade_status.Validation","properties":{"results":{"type":"array","description":"String of messages from validation stage.","items":{"type":"string"}},"start_timestamp":{"type":"string","description":"Start timestamp of Image download.","format":"date-time"},"status":{"$ref":"#/components/schemas/upgrade_statusStatus"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.virtual_appliance","description":"Upgrade status custom APIs","version":""},"paths":{"/api/maurice/software_os_version":{"post":{"summary":"Get OS based on SW_VERSION","description":"API to get os IMAGE based on the software version","operationId":"ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi.GetImage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/virtual_applianceGetImageResponse"}}}},"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/virtual_applianceGetImageRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-virtual_appliance-softwareversionosimagecustomapi-getimage"},"x-ves-proto-rpc":"ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi.GetImage"},"x-displayname":"Upgrade Status","x-ves-proto-service":"ves.io.schema.virtual_appliance.SoftwareVersionOsImageCustomApi","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Upgrade Status","x-ves-proto-package":"ves.io.schema.virtual_appliance","components":{"schemas":{"virtual_applianceGetImageRequest":{"type":"object","description":"Request containing the sw_version","title":"GetImageOsRequest","x-displayname":"Software Version to OS Image Mapping","x-ves-proto-message":"ves.io.schema.virtual_appliance.GetImageRequest","properties":{"uids":{"type":"array","description":"\nExample: ` [\"d27938ba-967e-40a7-9709-57b8627f9f75\", \"e87138ce-124e-44b8-ac9c-e764c1711a33\"]`\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  ves.io.schema.rules.string.pattern: ^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$\n","minItems":1,"maxItems":100,"items":{"type":"string"},"x-displayname":"UIDs","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","ves.io.schema.rules.string.pattern":"^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"}}}},"virtual_applianceGetImageResponse":{"type":"object","description":"Response containing the OS image mapping data for the requested software versions\nResponse type: maps a unique identifier (UID) to image information.","title":"GetImageOsResponse","x-displayname":"Software Version to OS Image Mapping","x-ves-proto-message":"ves.io.schema.virtual_appliance.GetImageResponse","properties":{"images":{"type":"object","description":"Map of UID to image info."}}},"virtual_applianceImageInfo":{"type":"object","description":"x-displayName: \"ImageInfo\"\nResponse containing Imagename,ImageLink,Md5 Sum","title":"ImageInfo","properties":{"copy_image_name":{"type":"string","description":"Name of the image."},"download_image_link":{"type":"string","description":"Direct link to the os image."},"error_description":{"type":"string","title":"error string if any"},"image_md5_sum":{"type":"string","description":"MD5 checksum of the image file."}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.usage","description":"Resource usage and pricing custom APIs","version":""},"paths":{"/api/web/namespaces/{namespace}/current_usage":{"post":{"summary":"List current usage details","description":"List current usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.","operationId":"ves.io.schema.usage.CustomCalculatedUsageAPI.ListCurrentUsage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListCurrentUsageResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace to be considered","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListCurrentUsageReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usage-customcalculatedusageapi-listcurrentusage"},"x-ves-proto-rpc":"ves.io.schema.usage.CustomCalculatedUsageAPI.ListCurrentUsage"},"x-displayname":"Usage","x-ves-proto-service":"ves.io.schema.usage.CustomCalculatedUsageAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/hourly_usage_details":{"post":{"summary":"List hourly usage details","description":"List the usage divided by hour. The usage is hourly aggregated, from the start of utc hour\nto the end of utc hour. It is used to see the detailed breakdown of the usage received from ListUsageDetails","operationId":"ves.io.schema.usage.CustomAggregatedUsageAPI.ListHourlyUsageDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListHourlyUsageDetailsResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace","in":"path","required":true,"x-displayname":"namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListHourlyUsageDetailsReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usage-customaggregatedusageapi-listhourlyusagedetails"},"x-ves-proto-rpc":"ves.io.schema.usage.CustomAggregatedUsageAPI.ListHourlyUsageDetails"},"x-displayname":"Usage","x-ves-proto-service":"ves.io.schema.usage.CustomAggregatedUsageAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/monthly_usage":{"post":{"summary":"List monthly usage details","description":"List monthly usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.","operationId":"ves.io.schema.usage.CustomCalculatedUsageAPI.ListMonthlyUsage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListMonthlyUsageResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace to be considered","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListMonthlyUsageReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usage-customcalculatedusageapi-listmonthlyusage"},"x-ves-proto-rpc":"ves.io.schema.usage.CustomCalculatedUsageAPI.ListMonthlyUsage"},"x-displayname":"Usage","x-ves-proto-service":"ves.io.schema.usage.CustomCalculatedUsageAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/usage_details":{"post":{"summary":"List usage details","description":"List usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.","operationId":"ves.io.schema.usage.CustomAggregatedUsageAPI.ListUsageDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListUsageDetailsResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace to be considered","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usageListUsageDetailsReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-usage-customaggregatedusageapi-listusagedetails"},"x-ves-proto-rpc":"ves.io.schema.usage.CustomAggregatedUsageAPI.ListUsageDetails"},"x-displayname":"Usage","x-ves-proto-service":"ves.io.schema.usage.CustomAggregatedUsageAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Usage","x-ves-proto-package":"ves.io.schema.usage","components":{"schemas":{"schemausageStatusType":{"type":"string","description":"All possible usage line statuses\n\n - STATUS_UNKNOWN: No value defined\n - STATUS_NO_DATA: No data\n - STATUS_NOT_MEASURED: No measured\n - STATUS_ACTIVE: Active","title":"Status type","enum":["STATUS_UNKNOWN","STATUS_NO_DATA","STATUS_NOT_MEASURED","STATUS_ACTIVE"],"default":"STATUS_UNKNOWN","x-displayname":"Status type","x-ves-proto-enum":"ves.io.schema.usage.StatusType"},"usageCalculatedUsageItem":{"type":"object","description":"One line of usage, including pricing details","title":"CalculatedUsageItem","x-displayname":"Usage item","x-ves-proto-message":"ves.io.schema.usage.CalculatedUsageItem","properties":{"amount":{"type":"string","description":" Cost as hundredths of currency\n\nExample: ` \"1234\"`","title":"Amount","format":"int64","x-displayname":"Amount","x-ves-example":"1234"},"currency_code":{"type":"string","description":" ISO currency code\n\nExample: ` \"USD\"`","title":"Currency code","x-displayname":"Currency code","x-ves-example":"USD"},"end_timestamp":{"type":"string","description":" End of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp end","format":"date-time","x-displayname":"End","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"fixed":{"type":"boolean","description":" Means that this data came not from usage (reserved flag for support/discount/onboarding fees)","title":"Fixed","format":"boolean","x-displayname":"Fixes"},"metric_labels":{"type":"array","description":" id of the corresponding aggregated_usage metric labels from which this calculated usage item is assembled\n\nExample: ` \"['container-usage-large', 'container-usage-medium']\"`","title":"Metric labels","items":{"type":"string"},"x-displayname":"Metric labels","x-ves-example":"['container-usage-large', 'container-usage-medium']"},"quantity":{"type":"number","description":" Quantity incurred\n\nExample: ` \"100\"`","title":"Quantity","format":"double","x-displayname":"Quantity","x-ves-example":"100"},"quantity_billable":{"type":"string","description":" quantity which is used to calculate the amount. Rounded from quantity as the following:\n * after converting quantity from unit_code to unit_code of this addon_id, if the value < 1, then\n quantity_billable is rounded to 1\n * after converting quantity from unit_code to unit_code of this addon_id, if the value > 1, then\n  quantity_billable is rounded down to the nearest value.\n\nExample: ` 115`","title":"Quantity billable","format":"int64","x-displayname":"Quantity billable"},"start_timestamp":{"type":"string","description":" Beginning of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"status":{"$ref":"#/components/schemas/schemausageStatusType"},"unit_name":{"type":"string","description":" Name of the quantity unit\n\nExample: ` \"MB\"`","title":"Unit name","x-displayname":"Unit name","x-ves-example":"MB"},"unit_name_billable":{"type":"string","description":" Unit name a quantity_billable is provided in\n\nExample: ` GB`","title":"Unit name billable","x-displayname":"Unit name billable"},"usage_type":{"type":"string","description":" Type of the resource\n\nExample: ` \"ADN App Mgmt - VoltStack Large Containers\"`","title":"Usage type","x-displayname":"Usage type","x-ves-example":"ADN App Mgmt - VoltStack Large Containers"}}},"usageCoupon":{"type":"object","description":"Coupon details, discount type, amount and name","title":"Coupon","x-displayname":"Coupon","x-ves-proto-message":"ves.io.schema.usage.Coupon","properties":{"discount_amount":{"type":"integer","description":" [x-required]\n If discount_type is fixed_amount, discount_amount is in cents\n If discount_type is percentage, discount_amount is in percentages of 0.01% precision (12.35% equals to 1235)\n\nExample: ` \"1234\"`\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Discount amount","format":"int32","x-displayname":"Discount amount","x-ves-example":"1234","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"discount_type":{"$ref":"#/components/schemas/usageDiscountType"},"title":{"type":"string","description":" Title (or name) of the coupon\n\nExample: ` \"Coupon 1\"`","title":"Title","x-displayname":"Title","x-ves-example":"Coupon 1"}}},"usageDiscountType":{"type":"string","description":"Indicates what type of discount is applied for a coupon: fixed price or percentage.\n\nunknown\nThe specified amount will be given as discount.\nThe specified percentage will be given as discount.","title":"Discount type","enum":["DISCOUNT_TYPE_UNKNOWN","DISCOUNT_TYPE_FIXED_AMOUNT","DISCOUNT_TYPE_PERCENTAGE"],"default":"DISCOUNT_TYPE_UNKNOWN","x-displayname":"Discount type","x-ves-proto-enum":"ves.io.schema.usage.DiscountType"},"usageHourlyItem":{"type":"object","description":"One line of usage by an hour. One hour as the least resolution.","title":"Hourly usage item","x-displayname":"Hourly usage item","x-ves-proto-message":"ves.io.schema.usage.HourlyItem","properties":{"container":{"type":"string","description":" Container name if this item correspond to the container usage. Otherwise it's empty\n\nExample: ` \"pa4-deployment1-abcd12\"`","title":"Container","x-displayname":"Container","x-ves-example":"pa4-deployment1-abcd12"},"deployment":{"type":"string","description":" [x-required]\n Deployment name if this item correspond to the container usage. Otherwise it's empty\n\nExample: ` \"pa4-deployment1\"`\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Deployment","x-displayname":"Deployment","x-ves-example":"pa4-deployment1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"end_timestamp":{"type":"string","description":" End of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp end","format":"date-time","x-displayname":"End","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"quantity":{"type":"number","description":" Quantity incurred\n\nExample: ` \"100\"`","title":"Quantity","format":"double","x-displayname":"Quantity","x-ves-example":"100"},"start_timestamp":{"type":"string","description":" Beginning of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"unit_name":{"type":"string","description":" Name of the quantity unit\n\nExample: ` \"MB\"`","title":"Unit name","x-displayname":"Unit name","x-ves-example":"MB"}}},"usageListCurrentUsageReq":{"type":"object","description":"Request message to get current usage details","title":"List current usage details request","x-displayname":"List current usage details request","x-ves-proto-message":"ves.io.schema.usage.ListCurrentUsageReq","properties":{"from":{"type":"string","description":" Indicates the \"from\" part of the request\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp from","format":"date-time","x-displayname":"From","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"namespace":{"type":"string","description":" Namespace to be considered\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"to":{"type":"string","description":" Indicates the \"to\" part of the request\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp to","format":"date-time","x-displayname":"To","x-ves-example":"2020-04-20T12:32:51.341959216Z"}}},"usageListCurrentUsageResp":{"type":"object","description":"Response message to get current usage details","title":"List current usage details response","x-displayname":"List current usage details response","x-ves-proto-message":"ves.io.schema.usage.ListCurrentUsageResp","properties":{"coupons":{"type":"array","description":" All used coupons","title":"Coupons","items":{"$ref":"#/components/schemas/usageCoupon"},"x-displayname":"Coupons"},"discount":{"type":"string","description":" Discount as hundredths of currency\n\nExample: ` \"12345\"`","title":"Discount","format":"int64","x-displayname":"Discount","x-ves-example":"12345"},"total_cost":{"type":"string","description":" Total cost as hundredths of currency\n\nExample: ` \"12345\"`","title":"Total cost","format":"int64","x-displayname":"Total cost","x-ves-example":"12345"},"usage_items":{"type":"array","description":" Collection of usage items, lines of response","title":"Usage items","items":{"$ref":"#/components/schemas/usageCalculatedUsageItem"},"x-displayname":"Usage items"}}},"usageListHourlyUsageDetailsReq":{"type":"object","description":"Request body for ListHourlyUsageDetails rpc method","title":"ListHourlyUsageDetailsReq","x-displayname":"List Hourly Usage Details Request","x-ves-proto-message":"ves.io.schema.usage.ListHourlyUsageDetailsReq","properties":{"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"namespace","x-ves-example":"system"},"query":{"type":"string","description":" Encoded query which is passed as is to barracute daemon\n\nExample: ` \"{'MetricLabel':'label'}\"`","title":"query","x-displayname":"query","x-ves-example":"{'MetricLabel':'label'}"}}},"usageListHourlyUsageDetailsResp":{"type":"object","description":"Response body for ListHourlyUsageDetails rpc method","title":"List Hourly Usage Details Response","x-displayname":"List Hourly Usage Details Response","x-ves-proto-message":"ves.io.schema.usage.ListHourlyUsageDetailsResp","properties":{"hourly_usage_items":{"type":"array","description":" Array of usage by hour in the period from the query","title":"Usage items","items":{"$ref":"#/components/schemas/usageHourlyItem"},"x-displayname":"Usage items"}}},"usageListMonthlyUsageReq":{"type":"object","description":"Request message to get mon thly usage details","title":"List monthly usage details request","x-displayname":"List monthly usage details request","x-ves-proto-message":"ves.io.schema.usage.ListMonthlyUsageReq","properties":{"namespace":{"type":"string","description":" Namespace to be considered\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"}}},"usageListMonthlyUsageResp":{"type":"object","description":"Response message to get monthly usage details","title":"List monthly usage details response","x-displayname":"List monthly usage details response","x-ves-proto-message":"ves.io.schema.usage.ListMonthlyUsageResp","properties":{"monthly_usage_items":{"type":"array","description":" Collection of usage items, lines of response","title":"Usage items","items":{"$ref":"#/components/schemas/usageMonthlyUsageType"},"x-displayname":"Usage items"}}},"usageListUsageDetailsReq":{"type":"object","description":"Request message to get usage details","title":"List usage details request","x-displayname":"List usage details request","x-ves-proto-message":"ves.io.schema.usage.ListUsageDetailsReq","properties":{"from":{"type":"string","description":" Indicates the \"from\" part of the request\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp from","format":"date-time","x-displayname":"From","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"namespace":{"type":"string","description":" Namespace to be considered\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"to":{"type":"string","description":" Indicates the \"to\" part of the request\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp to","format":"date-time","x-displayname":"To","x-ves-example":"2020-04-20T12:32:51.341959216Z"}}},"usageListUsageDetailsResp":{"type":"object","description":"Response message to get usage details","title":"List usage details response","x-displayname":"List usage details response","x-ves-proto-message":"ves.io.schema.usage.ListUsageDetailsResp","properties":{"usage_items":{"type":"array","description":" Collection of usage items, lines of response","title":"Usage items","items":{"$ref":"#/components/schemas/usageUsageItem"},"x-displayname":"Usage items"}}},"usageMonthlyUsageType":{"type":"object","description":"One line of usage, including pricing details","title":"MonthlyUsageType","x-displayname":"Usage item","x-ves-proto-message":"ves.io.schema.usage.MonthlyUsageType","properties":{"amount":{"type":"string","description":" Cost as hundredths of currency\n\nExample: ` \"1234\"`","title":"Amount","format":"int64","x-displayname":"Amount","x-ves-example":"1234"},"currency_code":{"type":"string","description":" ISO currency code\n\nExample: ` \"USD\"`","title":"Currency code","x-displayname":"Currency code","x-ves-example":"USD"},"end_timestamp":{"type":"string","description":" End of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp end","format":"date-time","x-displayname":"End","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"start_timestamp":{"type":"string","description":" Beginning of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"}}},"usageUsageItem":{"type":"object","description":"Usage item represents a line in a usage report, including quantity and resource incurring usage.","title":"Usage item","x-displayname":"usage item","x-ves-proto-message":"ves.io.schema.usage.UsageItem","properties":{"end_timestamp":{"type":"string","description":" End of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp end","format":"date-time","x-displayname":"End","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"hourly_breakdown":{"type":"array","description":" An array of HourlyItem with usage per hour. The sum of these items will result into the parent's object `quantity`\n Deprecated: use /hourly_usage_details along with hourly_breakdown_query","title":"Hourly breakdown","items":{"$ref":"#/components/schemas/usageHourlyItem"},"x-displayname":"Hourly breakdown"},"hourly_breakdown_query":{"type":"string","description":" [x-required]\n A base64 encoded json which should be passed as is to /hourly_usage_details\n to get hourly items for this aggregated usage.\n\nExample: ` \"{'MetricLabel':'label'}\"`\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Hourly breakdown query","x-displayname":"Hourly breakdown query","x-ves-example":"{'MetricLabel':'label'}","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"metric_label":{"type":"string","description":" [x-required]\n id of the usage type. As Usage type is shown for user and is a subject of frequent changes,\n this metric_label should be static and should be usage for mapping between calculated usage and aggregated_usage.\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Metric label","x-displayname":"Metric label","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace where the usage occurred\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"object_name":{"type":"string","description":" Name of the object where the usage occurred\n\nExample: ` \"pa4-resource1\"`","title":"Object name","x-displayname":"Object name","x-ves-example":"pa4-resource1"},"quantity":{"type":"number","description":" Quantity incurred\n\nExample: ` \"100\"`","title":"Quantity","format":"double","x-displayname":"Quantity","x-ves-example":"100"},"start_timestamp":{"type":"string","description":" Beginning of the time unit\n\nExample: ` \"2020-04-20T12:32:51.341959216Z\"`","title":"Timestamp start","format":"date-time","x-displayname":"Start","x-ves-example":"2020-04-20T12:32:51.341959216Z"},"unit_name":{"type":"string","description":" Name of the quantity unit\n\nExample: ` \"MB\"`","title":"Unit name","x-displayname":"Unit name","x-ves-example":"MB"},"usage_type":{"type":"string","description":" Type of the resource\n\nExample: ` \"ADN App Mgmt - VoltStack Large Containers\"`","title":"Usage type","x-displayname":"Usage type","x-ves-example":"ADN App Mgmt - VoltStack Large Containers"}}}}}}