@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.registration","description":"registration API(s) are used by Customer edge site to register itself with volterra edge cloud.\nEvery node in given site is represented by it's registration.\nregistration must have unique hostname for given cluster_name. Registration state is changed to RETIRED in order to decommission node.\nRegistration can't be changed by user after creation.\n\nRegistration contains HA information about node in infra section\nand site which belongs to in passport.","version":""},"paths":{"/api/register/namespaces/system/get-image-download-url":{"post":{"summary":"Get Image Download Url","description":"Returns image download url for each provider","operationId":"ves.io.schema.registration.CustomAPI.GetImageDownloadUrl","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationGetImageDownloadUrlResp"}}}},"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/registrationGetImageDownloadUrlReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-getimagedownloadurl"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.GetImageDownloadUrl"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/system/get-registrations-by-token":{"post":{"summary":"Get Registration UID by Site Token","description":"Returns list of registration uids that are using particular site token","operationId":"ves.io.schema.registration.CustomAPI.GetRegistrationsBySiteToken","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationGetRegistrationsBySiteTokenResp"}}}},"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/registrationGetRegistrationsBySiteTokenReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-getregistrationsbysitetoken"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.GetRegistrationsBySiteToken"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/system/suggest-values":{"post":{"summary":"Suggest Values","description":"Returns suggested values for the specified field in the given Create/Replace/Custom request","operationId":"ves.io.schema.registration.CustomAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaregistrationSuggestValuesResp"}}}},"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/registrationSuggestValuesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.SuggestValues"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/{metadata.namespace}/registrations":{"post":{"summary":"Create Registration","description":"VPM creates registration using this message, never used by users.","operationId":"ves.io.schema.registration.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationCreateResponse"}}}},"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/registrationCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-api-create"},"x-ves-proto-rpc":"ves.io.schema.registration.API.Create"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/register/namespaces/{metadata.namespace}/registrations/{metadata.name}":{"put":{"summary":"Replace Registration","description":"NO fields are allowed to be replaced","operationId":"ves.io.schema.registration.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationReplaceResponse"}}}},"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/registrationReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-api-replace"},"x-ves-proto-rpc":"ves.io.schema.registration.API.Replace"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/register/namespaces/{namespace}/listregistrationsbystate":{"post":{"summary":"List Registrations By State","description":"API endpoint for returning Registrations by status, e.g APPROVED, NEW, or RETIRED","operationId":"ves.io.schema.registration.CustomAPI.ListRegistrationsByState","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nRegistration namespace, only \"system\" namespaces is accepted","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationListStateReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-listregistrationsbystate"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.ListRegistrationsByState"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/{namespace}/registration/{name}/approve":{"post":{"summary":"Registration Approve","description":"RegistrationApprove approved pending registration and it can also decommission by changing state to RETIRED.","operationId":"ves.io.schema.registration.CustomAPI.RegistrationApprove","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationObjectChangeResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nRegistration namespace, only \"system\" namespaces is accepted","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-required\nx-example: \"r-e9030963-639e-41cd-aba6-261504f4a6be\"\nRegistration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationApprovalReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-registrationapprove"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.RegistrationApprove"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/{namespace}/registrations":{"get":{"summary":"List Registration","description":"List the set of registration in a namespace","operationId":"ves.io.schema.registration.CustomAPI.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationListResponse"}}}},"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 registration","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-registration-customapi-list"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.List"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/{namespace}/registrations/{name}":{"get":{"summary":"Get Registration","description":"Get registration specification","operationId":"ves.io.schema.registration.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationGetResponse"}}}},"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 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_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-registration-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.Get"},"delete":{"summary":"Delete Registration","description":"Delete the specified registration","operationId":"ves.io.schema.registration.CustomAPI.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"}},{"name":"fail_if_referred","description":"Fail the delete operation if this object is being referred by other objects","in":"query","required":false,"x-displayname":"Fail-If-Referred","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-delete"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.Delete"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/namespaces/{namespace}/registrations_by_site/{site_name}":{"get":{"summary":"List registrations by site","description":"List all registration in site","operationId":"ves.io.schema.registration.CustomAPI.ListRegistrationsBySite","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nRegistration namespace, only \"system\" namespaces is accepted","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site_name","description":"SiteName\n\nx-required\nx-example: \"ce02\"\nSite name to be used for registration filtering","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-registration-customapi-listregistrationsbysite"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.ListRegistrationsBySite"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/registerBootstrap":{"post":{"summary":"Registration Create","description":"Registration request to create registration is sent by the node on first boot. User never creates registration on her own.","operationId":"ves.io.schema.registration.CustomAPI.RegistrationCreate","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationObject"}}}},"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/registrationRegistrationCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-registrationcreate"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.RegistrationCreate"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/register/requestConfig":{"post":{"summary":"Registration Config","description":"API endpoint for returning configuration for admitted registrations.\nIt will fail with known error for non-ADMITTED registration","operationId":"ves.io.schema.registration.CustomAPI.RegistrationConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrationConfigResp"}}}},"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/registrationConfigReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-registration-customapi-registrationconfig"},"x-ves-proto-rpc":"ves.io.schema.registration.CustomAPI.RegistrationConfig"},"x-displayname":"Registration","x-ves-proto-service":"ves.io.schema.registration.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Registration","x-ves-proto-package":"ves.io.schema.registration","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"ioschemaStatusType":{"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"}}},"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"}}},"registrationApprovalReq":{"type":"object","description":"Request for admission approval","title":"Approval request","x-displayname":"Approval","x-ves-proto-message":"ves.io.schema.registration.ApprovalReq","properties":{"annotations":{"type":"object","description":" Optional.\n Annotations to set (add if missing, overwrite if exists)\n\nExample: ` \"key:value\"`","title":"Annotations","x-displayname":"Annotations","x-ves-example":"key:value"},"connected_region":{"type":"string","description":" Optional.\n closest REs to which to connect in selected region. If there is more than one RE with the label\n then select 2 of them. Otherwise default \"geo-ip\" database is consulted to find closest RE(s) to\n public ip with which node registration request was received.\n\nExample: ` \"value\"`","title":"Connected Region","x-displayname":"Connected Region","x-ves-example":"value"},"labels":{"type":"object","description":" Optional.\n Labels to set (add if missing, overwrite if exists)\n\nExample: ` \"key:value\"`","title":"Labels","x-displayname":"Labels","x-ves-example":"key:value"},"name":{"type":"string","description":" Registration name (= \"r-\" + uid) to approve. Registration name is taken from listing pending registrations.\n\nExample: ` \"r-e9030963-639e-41cd-aba6-261504f4a6be\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Name","x-ves-example":"r-e9030963-639e-41cd-aba6-261504f4a6be","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"passport":{"$ref":"#/components/schemas/registrationPassport"},"preferred_active_re":{"type":"string","description":" Optional.\n Preferred Active RE connection for CE(s) using private VN\n\nExample: ` \"value\"`","title":"Preferred Active RE","x-displayname":"Preferred Active RE","x-ves-example":"value"},"tunnel_type":{"$ref":"#/components/schemas/schemaSiteToSiteTunnelType"}}},"registrationConfigReq":{"type":"object","description":"Request to get configuration","title":"Configuration request","x-displayname":"Configuration Request","x-ves-proto-message":"ves.io.schema.registration.ConfigReq","properties":{"name":{"type":"string","description":" Registration name\n\nExample: ` \"r-e9030963-639e-41cd-aba6-261504f4a6be\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Name","x-ves-example":"r-e9030963-639e-41cd-aba6-261504f4a6be","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Registration namespace\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"token":{"type":"string","description":" Token - verify node identity\n\nExample: ` \"835af393-3056-46af-a9e4-57613fbe0339\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Token","x-displayname":"Token","x-ves-example":"835af393-3056-46af-a9e4-57613fbe0339","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"registrationConfigResp":{"type":"object","description":"Response for configuration request. This response is consumed by node.","title":"Configuration","x-displayname":"Configuration","x-ves-proto-message":"ves.io.schema.registration.ConfigResp","properties":{"hash":{"type":"string","description":" Hash of workload map which is used to verify consistency\n and check changes","title":"Hash","x-displayname":"Hash"},"workload":{"type":"object","description":" Configuration for applications and infrastructure","title":"Workload","x-displayname":"Workload"}}},"registrationCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of registration","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.registration.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemaregistrationCreateSpecType"}}},"registrationCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.registration.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemaregistrationGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"registrationGetImageDownloadUrlReq":{"type":"object","description":"Request to get image download url","title":"Get Image Download Url request","x-displayname":"Get Image Download Url Request","x-ves-proto-message":"ves.io.schema.registration.GetImageDownloadUrlReq","properties":{"provider":{"type":"string","description":" provider for that image\n\nExample: ` \"kvm\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Provider","x-displayname":"Provider","x-ves-example":"kvm","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"registrationGetImageDownloadUrlResp":{"type":"object","description":"Response to get image download url","title":"Get Image Download Url response","x-displayname":"Get Image Download Url Response","x-ves-proto-message":"ves.io.schema.registration.GetImageDownloadUrlResp","properties":{"image_download_url":{"type":"string","description":" URL of image download","title":"Image Download Url","x-displayname":"Image Download Url"},"image_md5_download_url":{"type":"string","description":" URL of image md5 download","title":"Image Md5 Download Url","x-displayname":"Image Md5 Download Url"}}},"registrationGetRegistrationsBySiteTokenReq":{"type":"object","description":"Request to get registration uuids by site token","title":"Get registration uuids by site token request","x-displayname":"Get Registration UUIDs by Site Token Request","x-ves-proto-message":"ves.io.schema.registration.GetRegistrationsBySiteTokenReq","properties":{"site_token":{"type":"string","description":" site token to query on\n\nExample: ` \"12345678-1234-1234-1234-1234567890ab\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Site token","x-displayname":"Site Token","x-ves-example":"12345678-1234-1234-1234-1234567890ab","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"registrationGetRegistrationsBySiteTokenResp":{"type":"object","description":"Response for querying registration uuids by site token","title":"Get registration uuids by site token response","x-displayname":"Get Registration UUIDs by Site Token Response","x-ves-proto-message":"ves.io.schema.registration.GetRegistrationsBySiteTokenResp","properties":{"registration_uuids":{"type":"array","description":" Registration UUIDs that uses the site token","title":"List of Registration UUIDs","items":{"type":"string"},"x-displayname":"Registration UUIDs"}}},"registrationGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read registration","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.registration.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/registrationCreateRequest"},"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"},"object":{"$ref":"#/components/schemas/registrationObject"},"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/registrationReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemaregistrationGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"registrationGetResponseFormatCode":{"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_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_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"registrationInfra":{"type":"object","description":"InfraMetadata stores information about instance infrastructure","title":"Infrastructure information","x-displayname":"Infra Information","x-ves-proto-message":"ves.io.schema.registration.Infra","properties":{"availability_zone":{"type":"string","description":" An Availability Zone is a high-availability offering that protects your applications and data from datacenter failures.\n\nExample: ` \"value\"`","title":"availability_zone","x-displayname":"Availability Zone","x-ves-example":"value"},"certified_hw":{"type":"string","description":" certified HW name used to map with F5XC certified_hardware definition\n\nExample: ` \"value\"`","title":"Certified hardware name","x-displayname":"Certified Hardware","x-ves-example":"value"},"domain":{"type":"string","description":" Machine domain. It's used for Kubernetes cloud provider when domain must be\n different than Volterra\n\nExample: ` \"value\"`","title":"Instance domain","x-displayname":"Instance Domain","x-ves-example":"value"},"hostname":{"type":"string","description":" Must be unique in entire cluster and same as OS settings.\n '.' (dots) are not allowed in hostname\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Instance hostname","x-displayname":"Hostname","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"hw_info":{"$ref":"#/components/schemas/siteOsInfo"},"instance_id":{"type":"string","description":" Instance id (assigned by infrastructure provider)\n\nExample: ` \"value\"`","title":"Instance ID","x-displayname":"Instance ID","x-ves-example":"value"},"interfaces":{"type":"object","description":" Machine interfaces present during registration time\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Interfaces","x-displayname":"Interfaces","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"internet_proxy":{"$ref":"#/components/schemas/registrationInternetProxy"},"machine_id":{"type":"string","description":" Machine id - generated by operating system\n\nExample: ` \"value\"`","title":"Machine ID","x-displayname":"Machine ID","x-ves-example":"value"},"provider":{"$ref":"#/components/schemas/registrationProvider"},"sw_info":{"$ref":"#/components/schemas/registrationSWInfo"},"timestamp":{"type":"string","description":" It's used to verify machine have acceptable time difference from server","title":"Timestamp","format":"date-time","x-displayname":"Current (machine) time"},"zone":{"type":"string","description":" Instance zone (or region), depends on provider\n\nExample: ` \"value\"`","title":"Zone","x-displayname":"Region","x-ves-example":"value"}}},"registrationInterface":{"type":"object","description":"x-displayName: \"Machine Interface\"\nInterface describe network interface","title":"Machine interface","properties":{"addr":{"type":"string","description":"x-displayName: \"IP Address\"\nx-example: \"192.168.100.1\"","title":"IP Address"},"name":{"type":"string","description":"x-displayName: \"Interface Name\"\nx-example: \"eth0\"","title":"Interface name"},"plen":{"type":"integer","description":"x-displayName: \"IP Prefix\"\nx-example: \"24\"","title":"Prefix length","format":"int32"}}},"registrationInternetProxy":{"type":"object","description":"Proxy describes options for HTTP or HTTPS proxy configurations","title":"Internet Proxy configuration","x-displayname":"Internet Proxy Configuration","x-ves-proto-message":"ves.io.schema.registration.InternetProxy","properties":{"http_proxy":{"type":"string","description":" It will be used as the proxy URL for HTTP requests and HTTPS requests unless overridden by HTTPSProxy or NoProxy.\n\nExample: ` \"http://USERNAME:PASSWORD@10.0.1.1:8080/\"`","title":"Http Proxy","x-displayname":"HTTP PROXY","x-ves-example":"http://USERNAME:PASSWORD@10.0.1.1:8080/"},"https_proxy":{"type":"string","description":" It will be used as the proxy URL for HTTPS requests unless overridden by NoProxy.\n\nExample: ` \"https://USERNAME:PASSWORD@10.0.0.1:8080/\"`","title":"Https Proxy","x-displayname":"HTTPS PROXY","x-ves-example":"https://USERNAME:PASSWORD@10.0.0.1:8080/"},"no_proxy":{"type":"string","description":" It specifies a string that contains comma-separated values\n specifying hosts that should be excluded from proxying. Each value is\n represented by an IP address prefix (1.2.3.4), an IP address prefix in\n CIDR notation (1.2.3.4/8), a domain name, or a special DNS label (*).\n An IP address prefix and domain name can also include a literal port\n number (1.2.3.4:80).\n A domain name matches that name and all subdomains. A domain name with\n a leading \".\" matches subdomains only. For example \"foo.com\" matches\n \"foo.com\" and \"bar.foo.com\"; \".y.com\" matches \"x.y.com\" but not \"y.com\".\n A single asterisk (*) indicates that no proxying should be done.\n\nExample: ` \"master.hostname.example.com,10.1.0.0/16,172.30.0.0/16\"`","title":"No Proxy","x-displayname":"NO PROXY","x-ves-example":"master.hostname.example.com,10.1.0.0/16,172.30.0.0/16"},"proxy_cacert_url":{"type":"string","description":" Allow optional different trust-store for proxy in HTTP CONNECT step\n by picking proxy ca certificate value.\n\nExample: ` \"string:///LS0tLS1CRUdJTiBDRxxxx\"`","title":"Proxy CA certificate URL","x-displayname":"Proxy CA certificate URL","x-ves-example":"string:///LS0tLS1CRUdJTiBDRxxxx"}}},"registrationListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of registration","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.registration.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/registrationListResponseItem"},"x-displayname":"Items"}}},"registrationListResponseItem":{"type":"object","description":"By default a summary of registration 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 registration","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.registration.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this registration","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this registration","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates registration is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemaregistrationGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this registration","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this registration\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"},"object":{"$ref":"#/components/schemas/registrationObject"},"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 registration\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"registrationListStateReq":{"type":"object","description":"Request for list registrations","title":"ListStateReq","x-displayname":"List State Request","x-ves-proto-message":"ves.io.schema.registration.ListStateReq","properties":{"namespace":{"type":"string","description":" Registration namespace, only \"system\" namespaces is accepted\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"state":{"$ref":"#/components/schemas/registrationObjectState"}}},"registrationObject":{"type":"object","description":"Registration object stores node registration and information regarding the node","title":"Registration object","x-displayname":"Object","x-ves-displayorder":"1,2,3,4","x-ves-proto-message":"ves.io.schema.registration.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/registrationSpecType"},"status":{"$ref":"#/components/schemas/schemaregistrationStatusType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"registrationObjectChangeResp":{"type":"object","description":"Generic response when object is changed, registration can be changed only via custom API.","title":"Registration change","x-displayname":"Registration Change","x-ves-proto-message":"ves.io.schema.registration.ObjectChangeResp","properties":{"obj":{"$ref":"#/components/schemas/registrationObject"}}},"registrationObjectState":{"type":"string","description":"Defines states for registration object\n\nState isn't set\nObject was created (registration request was received and object created)\nRegistration was approved and waiting for configuration\nThis state can be set by user only if current state is NEW\nRegistration is approved and prepared for  to connect\nIt can't be set manually.\nRegistration isn't valid anymore and it will be deleted in near future\nThis state can be set by user anytime.\nRegistration is failed (vpm reported or timeout)\nDEPRECATED. Registration is reported as finished (workload was deployed)\nUser action is required\nRegistration is online\nOperating system upgrade is in progress\nMaintenance is in progress","title":"ObjectState","enum":["NOTSET","NEW","APPROVED","ADMITTED","RETIRED","FAILED","DONE","PENDING","ONLINE","UPGRADING","MAINTENANCE"],"default":"NOTSET","x-displayname":"Object State","x-ves-proto-enum":"ves.io.schema.registration.ObjectState"},"registrationPassport":{"type":"object","description":"Passport stores information about identification and node configuration provided by CE during registration. It can be manually updated by user during approval.","title":"Passport","x-displayname":"Passport","x-ves-displayorder":"1,2,9,7,8,4,5,6,10,3,11,12,15","x-ves-oneof-field-operating_system_version_choice":"[\"default_os_version\",\"operating_system_version\"]","x-ves-oneof-field-volterra_sw_version_choice":"[\"default_sw_version\",\"volterra_software_version\"]","x-ves-proto-message":"ves.io.schema.registration.Passport","properties":{"cluster_name":{"type":"string","description":"\nExample: ` \"acme-ce01\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"cluster_name","x-displayname":"Cluster Name","x-ves-example":"acme-ce01","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"cluster_size":{"type":"integer","description":" Defines how many master nodes is in the cluster, only 1 or 3 is allowed\n 1 - cluster have single master, without HA\n 3 - cluster have 3 masters, with HA, all nodes should be allowed at same time, cluster won't start until ALL nodes are ADMITTED\n 0 - same as 1\n This value can't be changed after installation.\n It does not interact with auto-scaling as only pool nodes are scaled.\n\nExample: ` \"3\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.in: [0,1,3]\n","title":"Cluster size","format":"int32","x-displayname":"Cluster Size","x-ves-example":"3","x-ves-validation-rules":{"ves.io.schema.rules.int32.in":"[0,1,3]"}},"cluster_type":{"type":"string","description":"\nExample: ` \"ce\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"cluster_type","x-displayname":"Cluster Type","x-ves-example":"ce","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"default_os_version":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_sw_version":{"$ref":"#/components/schemas/ioschemaEmpty"},"latitude":{"type":"number","description":" Geographic location of this site\n\nExample: ` \"49.3156733\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: -90.0\n  ves.io.schema.rules.float.lte: 90.0\n  ves.io.schema.rules.message.required: true\n","title":"Latitude","format":"float","x-displayname":"Latitude","x-ves-example":"49.3156733","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"-90.0","ves.io.schema.rules.float.lte":"90.0","ves.io.schema.rules.message.required":"true"}},"longitude":{"type":"number","description":" Geographic location of this site\n\nExample: ` \"14.2484333\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.float.gte: -180.0\n  ves.io.schema.rules.float.lte: 180.0\n  ves.io.schema.rules.message.required: true\n","title":"Longitude","format":"float","x-displayname":"Longitude","x-ves-example":"14.2484333","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.float.gte":"-180.0","ves.io.schema.rules.float.lte":"180.0","ves.io.schema.rules.message.required":"true"}},"operating_system_version":{"type":"string","description":"Exclusive with [default_os_version]\n Operating System Version is optional parameter, which allows to specify target SW version for particular site e.g. 7.2009.10.\n\nExample: ` \"7.2009.10\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 20\n","title":"Operating System Version","maxLength":20,"x-displayname":"Operating System Version","x-ves-example":"7.2009.10","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20"}},"private_network_name":{"type":"string","description":" Private Network name for private access connectivity to F5XC ADN.\n It is used for PrivateLink, CloudLink and L3VPN.\n\nExample: ` \"private-ntw\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"Private Network Name","maxLength":64,"x-displayname":"Private Network Name","x-ves-example":"private-ntw","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"volterra_software_version":{"type":"string","description":"Exclusive with [default_sw_version]\n F5XC Software Version is optional parameter, which allows to specify target SW version for particular site e.g. crt-20210329-1002.\n\nExample: ` \"crt-20210329-1002\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 20\n","title":"F5XC Software Version","maxLength":20,"x-displayname":"F5XC Software Version","x-ves-example":"crt-20210329-1002","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"20"}}}},"registrationProvider":{"type":"string","description":"Infrastructure provider enum for registration. It describes where is instance running.\n\nProvider was not detected\nAWS cloud instance\nGoogle cloud instance\nAzure cloud instance\nVMWare VM\nKVM VM\nOther provider, which was not identified by system.\nF5XC HW device.\nIBM Cloud instance.\nKubernetes cluster in AWS\nKubernetes cluster in GCP\nKubernetes cluster in Azure\nKubernetes cluster in Vmware\nKubernetes cluster in VMware\nKubernetes cluster in Other provider\nKubernetes cluster in Volterra\nKubernetes cluster in IBM Cloud\nF5OS HW device.\nRSeries Device\nOCI Cloud Instance\nNutanix instance\nOpenstack Instance\nEquinix Instance","title":"Infrastructure provider","enum":["UNKNOWN","AWS","GOOGLE","AZURE","VMWARE","KVM","OTHER","VOLTERRA","IBMCLOUD","UNKNOWN_K8S","AWS_K8S","GCP_K8S","AZURE_K8S","VMWARE_K8S","KVM_K8S","OTHER_K8S","VOLTERRA_K8S","IBMCLOUD_K8S","F5OS","RSERIES","OCI","NUTANIX","OPENSTACK","EQUINIX"],"default":"UNKNOWN","x-displayname":"Infrastructure Provider","x-ves-proto-enum":"ves.io.schema.registration.Provider"},"registrationRegistrationCreateRequest":{"type":"object","description":"Register node. This API isn't designed to be used by users, it's only for node.","title":"Create registration","x-displayname":"Create registration","x-ves-proto-message":"ves.io.schema.registration.RegistrationCreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemaregistrationCreateSpecType"}}},"registrationReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a registration","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.registration.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemaregistrationReplaceSpecType"}}},"registrationReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.registration.ReplaceResponse"},"registrationSWInfo":{"type":"object","description":"SWInfo holds information about sw version","title":"SWInfo","x-displayname":"SW Info","x-ves-proto-message":"ves.io.schema.registration.SWInfo","properties":{"sw_version":{"type":"string","description":" SW Version in the site","title":"sw version","x-displayname":"SW Version"}}},"registrationSpecType":{"type":"object","description":"Shape of the registration specification","title":"Shape of the token specification","x-displayname":"Specification","x-ves-proto-message":"ves.io.schema.registration.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/schemaregistrationGlobalSpecType"}}},"registrationSuggestValuesReq":{"type":"object","description":"Request body of SuggestValues request","title":"SuggestValuesReq","x-displayname":"Request for SuggestValues","x-ves-proto-message":"ves.io.schema.registration.SuggestValuesReq","properties":{"field_path":{"type":"string","description":" JSON path of the field for which the suggested values are being requested.\n\nExample: ` \"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"field_path","maxLength":1024,"x-displayname":"Field Path","x-ves-example":"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"match_value":{"type":"string","description":" A substring that must be present in either the value or description of each SuggestedItem in the response.\n\nExample: ` \"some-substring\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"match_value","maxLength":256,"x-displayname":"Match Value","x-ves-example":"some-substring","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"request_body":{"$ref":"#/components/schemas/protobufAny"}}},"registrationWorkloadContext":{"type":"object","description":"x-displayName: \"Workload Context\"\nWorkloadContext defines context for workload templates and infrastructure configuration\nused in vpm","title":"Workload context","properties":{"app_name":{"type":"string","description":"x-displayName: \"App Name\"\nx-example: \"phobos\"\napplication type name","title":"AppName"},"params":{"type":"object","description":"x-displayName: \"Params\"\nx-example: \"value\"\nmap of workload params","title":"Params"}}},"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/ioschemaStatusType"}}},"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"}}},"schemaObjectMetaType":{"type":"object","description":"ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.\nThe information in this type can be specified by user during create and replace APIs.","title":"ObjectMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.ObjectMetaType","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","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"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. Object create will fail if\n provided by the client and the value exists in the system. Typically generated by the\n server on successful creation of an object and is not allowed to change once populated.\n Shadowed by SystemObjectMeta's uid field.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSiteToSiteTunnelType":{"type":"string","description":"Tunnel encapsulation to be used between sites\n\nTunnel can operate in both IPsec and SSL, with IPsec being prefered over SSL.\nTunnel is of type IPsec\nTunnel is of type SSL","title":"Site to site tunnel type","enum":["SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL","SITE_TO_SITE_TUNNEL_IPSEC","SITE_TO_SITE_TUNNEL_SSL"],"default":"SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL","x-displayname":"Tunnel type","x-ves-proto-enum":"ves.io.schema.SiteToSiteTunnelType"},"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"}}},"schemaSystemObjectMetaType":{"type":"object","description":"SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectMetaType","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":"value"},"creator_cookie":{"type":"string","description":" This can used by the creator of the object for later audit for e.g. by storing the\n version identifying information of the object so at future it can be determined if\n version present at remote end is current or stale.\n\nExample: ` \"value\"`","title":"creator_cookie","x-displayname":"Creator Cookie","x-ves-example":"value"},"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":"value"},"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"},"direct_ref_hash":{"type":"string","description":" A hash of the UIDs of  direct references on this object. This can be used to determine if \n this object hash has had references become resolved/unresolved","title":"direct_ref_hash","x-displayname":"Direct Reference Hash"},"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"},"namespace":{"type":"array","description":" The namespace this object belongs to. This is populated by the service based on the\n metadata.namespace field when an object is created.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"namespace","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Namespace Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"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"},"revision":{"type":"string","description":" A revision number which always increases with each modification of the object in storage\n This doesn't necessarily increase sequentially, but should always increase.\n This will be 0 when first created, and before any modifications.","title":"revision","format":"int64","x-displayname":"Revision"},"sre_disable":{"type":"boolean","description":" This should be set to true If VES/SRE operator wants to suppress an object from being\n presented to business-logic of a daemon(e.g. due to bad-form/issue-causing Object).\n This is meant only to be used in temporary situations for operational continuity till\n a fix is rolled out in business-logic.\n\nExample: ` \"true\"`","title":"sre_disable","format":"boolean","x-displayname":"SRE Disable","x-ves-example":"true"},"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"},"trace_info":{"type":"string","description":" trace_info holds information(<trace-id>:<span-id>:<parent-span-id>) of the request doing\n the object modification. This can be used on the watch side to create subsequent spans.\n This information can be used to co-relate activities across services (modulo state compression)\n for a synchronous API.\n\nExample: ` \"value\"`","title":"trace_info","x-displayname":"Trace Info","x-ves-example":"value"},"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"},"vtrp_id":{"type":"string","description":" Indicate origin of this object.","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"}}},"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"}}},"schemaregistrationCreateSpecType":{"type":"object","description":"VPM creates registration using this message, never used by users.","title":"Create registration","x-displayname":"Create Registration","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.registration.CreateSpecType","properties":{"infra":{"$ref":"#/components/schemas/registrationInfra"},"passport":{"$ref":"#/components/schemas/registrationPassport"},"token":{"type":"string","description":" Token is used for machine and tenant identification\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"Token","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"schemaregistrationGetSpecType":{"type":"object","description":"Get registration specification","title":"Get registration","x-displayname":"Get Registration","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.registration.GetSpecType","properties":{"infra":{"$ref":"#/components/schemas/registrationInfra"},"passport":{"$ref":"#/components/schemas/registrationPassport"},"token":{"type":"string","description":" Token is used for machine and tenant identification\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"Token","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"schemaregistrationGlobalSpecType":{"type":"object","title":"Shape of the registration specification","x-displayname":"Global Specification","x-ves-proto-message":"ves.io.schema.registration.GlobalSpecType","properties":{"infra":{"$ref":"#/components/schemas/registrationInfra"},"passport":{"$ref":"#/components/schemas/registrationPassport"},"role":{"type":"array","description":" Role of registered node. Used by system to determine what roles should be enforced.\n\nExample: ` \"k8s-master, etcd\"`","title":"Instance role","items":{"type":"string"},"x-displayname":"Role","x-ves-example":"k8s-master, etcd"},"site":{"type":"array","description":" Site for this registration, assigned after registration is assigned to site.","title":"Site","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Site"},"token":{"type":"string","description":" Token is used for machine and tenant identification\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Token","x-displayname":"Token","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tunnel_type":{"$ref":"#/components/schemas/schemaSiteToSiteTunnelType"}}},"schemaregistrationReplaceSpecType":{"type":"object","description":"NO fields are allowed to be replaced","title":"Replace registration","x-displayname":"Replace Registration","x-ves-proto-message":"ves.io.schema.registration.ReplaceSpecType"},"schemaregistrationStatusType":{"type":"object","description":"Most recent observer status of object","title":"Shape of the registration status","x-displayname":"Status Type","x-ves-displayorder":"1,2","x-ves-proto-message":"ves.io.schema.registration.StatusType","properties":{"current_state":{"$ref":"#/components/schemas/registrationObjectState"},"object_status":{"$ref":"#/components/schemas/ioschemaStatusType"}}},"schemaregistrationSuggestValuesResp":{"type":"object","description":"Response body of SuggestValues request","title":"SuggestValuesResp","x-displayname":"Response for SuggestValues","x-ves-proto-message":"ves.io.schema.registration.SuggestValuesResp","properties":{"items":{"type":"array","description":" List of suggested items.","title":"item_lists","items":{"$ref":"#/components/schemas/schemaregistrationSuggestedItem"},"x-displayname":"Suggested Items"}}},"schemaregistrationSuggestedItem":{"type":"object","description":"A tuple with a suggested value and it's description.","title":"SuggestedItem","x-displayname":"Suggested Item","x-ves-oneof-field-value_choice":"[\"ref_value\",\"str_value\"]","x-ves-proto-message":"ves.io.schema.registration.SuggestedItem","properties":{"description":{"type":"string","description":" Optional description for the suggested value.","title":"description","x-displayname":"Description"},"ref_value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"str_value":{"type":"string","description":"Exclusive with [ref_value]\n","title":"str_value","x-displayname":"String"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"siteBios":{"type":"object","description":"BIOS information.","title":"Bios Data","x-displayname":"Bios Data","x-ves-proto-message":"ves.io.schema.site.Bios","properties":{"date":{"type":"string","description":" information from /sys/class/dmi/id/bios_date\n\nExample: ` \"value\"`","title":"date","x-displayname":"Date","x-ves-example":"value"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/bios_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/bios_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteBoard":{"type":"object","description":"Board information","title":"Board Details","x-displayname":"Board Details","x-ves-proto-message":"ves.io.schema.site.Board","properties":{"asset_tag":{"type":"string","description":" information from /sys/class/dmi/id/board_asset_tag\n\nExample: ` \"value\"`","title":"asset_tag","x-displayname":"Asset Tag","x-ves-example":"value"},"name":{"type":"string","description":" information from /sys/class/dmi/id/board_name\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"},"serial":{"type":"string","description":" information from /sys/class/dmi/id/board_serial\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/board_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/board_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteChassis":{"type":"object","description":"Chassis information.","title":"Chassis Details","x-displayname":"Chassis Details","x-ves-proto-message":"ves.io.schema.site.Chassis","properties":{"asset_tag":{"type":"string","description":" information from /sys/class/dmi/id/chassis_asset_tag\n\nExample: ` \"value\"`","title":"asset_tag","x-displayname":"Asset Tag","x-ves-example":"value"},"serial":{"type":"string","description":" information from /sys/class/dmi/id/chassis_serial\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"type":{"type":"integer","description":" information from /sys/class/dmi/id/chassis_type\n\nExample: ` \"0\"`","title":"type","format":"int64","x-displayname":"Type","x-ves-example":"0"},"vendor":{"type":"string","description":" information from /sys/class/dmi/id/chassis_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" information from /sys/class/dmi/id/chassis_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteCpu":{"type":"object","description":"CPU information","title":"Cpu information","x-displayname":"Cpu Information","x-ves-proto-message":"ves.io.schema.site.Cpu","properties":{"cache":{"type":"integer","description":" CPU cache size in KB\n\nExample: ` \"8192\"`","title":"cache","format":"int64","x-displayname":"Cache","x-ves-example":"8192"},"cores":{"type":"integer","description":" number of physical CPU cores\n\nExample: ` \"4\"`","title":"cores","format":"int64","x-displayname":"Cores","x-ves-example":"4"},"cpus":{"type":"integer","description":" number of physical CPUs\n\nExample: ` \"4\"`","title":"cpus","format":"int64","x-displayname":"CPUs","x-ves-example":"4"},"model":{"type":"string","description":" CPU model\n\nExample: ` \"value\"`","title":"model","x-displayname":"Model","x-ves-example":"value"},"speed":{"type":"integer","description":" CPU clock rate in MHz\n\nExample: ` \"4200\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"4200"},"threads":{"type":"integer","description":" number of logical (HT) CPU cores\n\nExample: ` \"4\"`","title":"threads","format":"int64","x-displayname":"Threads","x-ves-example":"4"},"vendor":{"type":"string","description":" CPU vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"}}},"siteGPU":{"type":"object","description":"GPU information on server","title":"GPU","x-displayname":"GPU","x-ves-proto-message":"ves.io.schema.site.GPU","properties":{"cuda_version":{"type":"string","description":" GPU Cuda Version\n\nExample: ` \"10.2\"`","title":"cudaVersion","x-displayname":"Cuda Version","x-ves-example":"10.2"},"driver_version":{"type":"string","description":" GPU Driver Version\n\nExample: ` \"440.82\"`","title":"driverVersion","x-displayname":"Driver Version","x-ves-example":"440.82"},"gpu_device":{"type":"array","description":" List of GPU devices in server","title":"GPUDevice","items":{"$ref":"#/components/schemas/siteGPUDevice"},"x-displayname":"GPU devices"}}},"siteGPUDevice":{"type":"object","title":"GPUDevice","x-displayname":"GPUDevice","x-ves-proto-message":"ves.io.schema.site.GPUDevice","properties":{"id":{"type":"string","description":" GPU ID\n\nExample: ` \"00000000:17:00.0\"`","title":"id","x-displayname":"GPU ID","x-ves-example":"00000000:17:00.0"},"processes":{"type":"string","description":" GPU Processes\n\nExample: ` \"value\"`","title":"processes","x-displayname":"Processes","x-ves-example":"value"},"product_name":{"type":"string","description":" GPU Product Name\n\nExample: ` \"Quadro P1000\"`","title":"productName","x-displayname":"Product Name","x-ves-example":"Quadro P1000"}}},"siteKernel":{"type":"object","description":"Kernel information","title":"Kernel Information","x-displayname":"Kernel","x-ves-proto-message":"ves.io.schema.site.Kernel","properties":{"architecture":{"type":"string","description":" kernel architecture\n\nExample: ` \"value\"`","title":"architecture","x-displayname":"Architecture","x-ves-example":"value"},"release":{"type":"string","description":" kernel release\n\nExample: ` \"value\"`","title":"release","x-displayname":"Release","x-ves-example":"value"},"version":{"type":"string","description":" kernel version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteLinkQuality":{"type":"string","description":"Link quality determined by VER using different probes\n\nUnknown quality\nLink quality is good\nLink quality is poor\nQuality disabled","title":"Link quality","enum":["QUALITY_UNKNOWN","QUALITY_GOOD","QUALITY_POOR","QUALITY_DISABLED"],"default":"QUALITY_UNKNOWN","x-displayname":"Link quality","x-ves-proto-enum":"ves.io.schema.site.LinkQuality"},"siteLinkType":{"type":"string","description":"Link type of interface determined operationally\n\nLink type unknown\nLink type ethernet\nWiFi link of type 802.11ac\nWiFi link of type 802.11bgn\nLink type 4G\nWiFi link\nWan link","title":"Link type","enum":["LINK_TYPE_UNKNOWN","LINK_TYPE_ETHERNET","LINK_TYPE_WIFI_802_11AC","LINK_TYPE_WIFI_802_11BGN","LINK_TYPE_4G","LINK_TYPE_WIFI","LINK_TYPE_WAN"],"default":"LINK_TYPE_UNKNOWN","x-displayname":"Link type","x-ves-proto-enum":"ves.io.schema.site.LinkType"},"siteMemory":{"type":"object","description":"Memory information.","title":"Memory Information","x-displayname":"Memory Information","x-ves-proto-message":"ves.io.schema.site.Memory","properties":{"size_mb":{"type":"integer","description":" RAM size in MB\n\nExample: ` \"value\"`","title":"size_mb","format":"int64","x-displayname":"RAM","x-ves-example":"value"},"speed":{"type":"integer","description":" RAM data rate in MT/s\n\nExample: ` \"value\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"value"},"type":{"type":"string","description":" type of memory, eg. DDR4\n\nExample: ` \"DDR4\"`","title":"type","x-displayname":"Type","x-ves-example":"DDR4"}}},"siteNetworkDevice":{"type":"object","description":"NetworkDevice information.","title":"Network Device Information","x-displayname":"Network Device Information","x-ves-proto-message":"ves.io.schema.site.NetworkDevice","properties":{"driver":{"type":"string","description":" driver of device, eg. e1000e\n\nExample: ` \"e1000e\"`","title":"driver","x-displayname":"Driver","x-ves-example":"e1000e"},"ip_address":{"type":"array","description":" ip address on interface\n\nExample: ` \"1.1.1.1\"`","title":"ip_address","items":{"type":"string"},"x-displayname":"IP Address","x-ves-example":"1.1.1.1"},"link_quality":{"$ref":"#/components/schemas/siteLinkQuality"},"link_type":{"$ref":"#/components/schemas/siteLinkType"},"mac_address":{"type":"string","description":" mac address on interface\n\nExample: ` \"value\"`","title":"mac_address","x-displayname":"MAC Address","x-ves-example":"value"},"name":{"type":"string","description":" name of device, eg. eth0\n\nExample: ` \"eth0\"`","title":"name","x-displayname":"Name","x-ves-example":"eth0"},"port":{"type":"string","description":" used port, eg. tp\n\nExample: ` \"value\"`","title":"port","x-displayname":"Port","x-ves-example":"value"},"speed":{"type":"integer","description":" device max supported speed in Mbps\n\nExample: ` \"1000\"`","title":"speed","format":"int64","x-displayname":"Speed","x-ves-example":"1000"}}},"siteOS":{"type":"object","description":"Details of Operating System","title":"OS","x-displayname":"OS","x-ves-proto-message":"ves.io.schema.site.OS","properties":{"architecture":{"type":"string","description":" Architecture of OS\n\nExample: ` \"amd64\"`","title":"architecture","x-displayname":"Architecture","x-ves-example":"amd64"},"name":{"type":"string","description":" Name of OS\n\nExample: ` \"Container Linux by CoreOS 1855.4.0 (Rhyolite)\"`","title":"name","x-displayname":"Name","x-ves-example":"Container Linux by CoreOS 1855.4.0 (Rhyolite)"},"release":{"type":"string","description":" Release of the OS\n\nExample: ` \"20.04\"`","title":"release","x-displayname":"Release","x-ves-example":"20.04"},"vendor":{"type":"string","description":" Vendor of OS\n\nExample: ` \"coreos\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"coreos"},"version":{"type":"string","description":" Version of OS\n\nExample: ` \"1855.4.0\"`","title":"version","x-displayname":"Version","x-ves-example":"1855.4.0"}}},"siteOsInfo":{"type":"object","description":"OsInfo holds information about host OS and HW","title":"OsInfo","x-displayname":"Os Info","x-ves-proto-message":"ves.io.schema.site.OsInfo","properties":{"bios":{"$ref":"#/components/schemas/siteBios"},"board":{"$ref":"#/components/schemas/siteBoard"},"chassis":{"$ref":"#/components/schemas/siteChassis"},"cpu":{"$ref":"#/components/schemas/siteCpu"},"gpu":{"$ref":"#/components/schemas/siteGPU"},"kernel":{"$ref":"#/components/schemas/siteKernel"},"memory":{"$ref":"#/components/schemas/siteMemory"},"network":{"type":"array","description":" List of network devices in server","title":"network","items":{"$ref":"#/components/schemas/siteNetworkDevice"},"x-displayname":"Network"},"numa_nodes":{"type":"integer","description":" Non-uniform memory access (NUMA) nodes count\n\nExample: ` \"1\"`\n\nValidation Rules:\n  ves.io.schema.rules.int32.gte: 0\n","title":"NUMA Nodes Count","format":"int32","x-displayname":"NUMA nodes count","x-ves-example":"1","x-ves-validation-rules":{"ves.io.schema.rules.int32.gte":"0"}},"os":{"$ref":"#/components/schemas/siteOS"},"product":{"$ref":"#/components/schemas/siteProduct"},"storage":{"type":"array","description":" List of storage devices in server","title":"storage","items":{"$ref":"#/components/schemas/siteStorageDevice"},"x-displayname":"Storage"},"usb":{"type":"array","description":" List of USB devices in server","title":"USBDevice","items":{"$ref":"#/components/schemas/siteUSBDevice"},"x-displayname":"USB devices"}}},"siteProduct":{"type":"object","description":"Product information","title":"Product Information","x-displayname":"Product Information","x-ves-proto-message":"ves.io.schema.site.Product","properties":{"name":{"type":"string","description":" product name, eg. for aws m5a.xlarge. Info taken from /sys/class/dmi/id/product_name\n\nExample: ` \"m5a.xlarge\"`","title":"name","x-displayname":"Name","x-ves-example":"m5a.xlarge"},"serial":{"type":"string","description":" serial number, eg. for aws ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/id/product_serial\n\nExample: ` \"ec254b6d-9676-1a51-8b10-21370dbdc3e5\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"ec254b6d-9676-1a51-8b10-21370dbdc3e5"},"vendor":{"type":"string","description":" vendor name, eg. for aws Amazon EC2. Info taken from /sys/class/dmi/id/product_vendor\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"},"version":{"type":"string","description":" version name. Info taken from /sys/class/dmi/id/product_version\n\nExample: ` \"value\"`","title":"version","x-displayname":"Version","x-ves-example":"value"}}},"siteStorageDevice":{"type":"object","description":"StorageDevice information.","title":"Storage Information","x-displayname":"Storage Information","x-ves-proto-message":"ves.io.schema.site.StorageDevice","properties":{"driver":{"type":"string","description":" driver of device\n\nExample: ` \"value\"`","title":"driver","x-displayname":"Driver","x-ves-example":"value"},"model":{"type":"string","description":" model of device\n\nExample: ` \"value\"`","title":"model","x-displayname":"Model","x-ves-example":"value"},"name":{"type":"string","description":" name of device, eg. nvme0n1\n\nExample: ` \"nvme0n1\"`","title":"name","x-displayname":"Name","x-ves-example":"nvme0n1"},"serial":{"type":"string","description":" serial of device\n\nExample: ` \"value\"`","title":"serial","x-displayname":"Serial Number","x-ves-example":"value"},"size_gb":{"type":"integer","description":" device size in GB\n\nExample: ` \"value\"`","title":"size_gb","format":"int64","x-displayname":"Size(GB)","x-ves-example":"value"},"vendor":{"type":"string","description":" vendor of device\n\nExample: ` \"value\"`","title":"vendor","x-displayname":"Vendor","x-ves-example":"value"}}},"siteUSBDevice":{"type":"object","description":"Information about USB device","title":"USB device","x-displayname":"USB Device informaton","x-ves-proto-message":"ves.io.schema.site.USBDevice","properties":{"address":{"type":"integer","description":" Address of the device on the bus in decimal\n\nExample: ` \"4\"`","title":"address","format":"int64","x-displayname":"Address","x-ves-example":"4"},"b_device_class":{"type":"string","description":" The class of this device\n\nExample: ` \"hub\"`","title":"b_device_class","x-displayname":"Class","x-ves-example":"hub"},"b_device_protocol":{"type":"string","description":" The protocol (within the sub-class) of this device\n\nExample: ` \"0002\"`","title":"b_device_protocol","x-displayname":"Protocol","x-ves-example":"0002"},"b_device_sub_class":{"type":"string","description":" The sub-class (within the class) of this device\n\nExample: ` \"hub\"`","title":"b_device_sub_class","x-displayname":"Subclass","x-ves-example":"hub"},"b_max_packet_size":{"type":"integer","description":" Maximum size of the control transfer\n\nExample: ` \"64\"`","title":"b_max_packet_size","format":"int64","x-displayname":"Max packet size","x-ves-example":"64"},"bcd_device":{"type":"string","description":" The device version\n\nExample: ` \"5.05\"`","title":"bcd_device","x-displayname":"BCD Device","x-ves-example":"5.05"},"bcd_usb":{"type":"string","description":" USB Specification Release Number\n\nExample: ` \"2.0\"`","title":"bcd_usb","x-displayname":"BCD Spec","x-ves-example":"2.0"},"bus":{"type":"integer","description":" The bus on which the device was detected in decimal\n\nExample: ` \"1\"`","title":"bus","format":"int64","x-displayname":"Bus","x-ves-example":"1"},"description":{"type":"string","description":" Device description\n\nExample: ` \"NetVista Full Width Keyboard (IBM Corp.)\"`","title":"description","x-displayname":"Description","x-ves-example":"NetVista Full Width Keyboard (IBM Corp.)"},"i_manufacturer":{"type":"string","description":" Manufacturer name\n\nExample: ` \"Voltera\"`","title":"i_manufacturer","x-displayname":"Manufacturer","x-ves-example":"Voltera"},"i_product":{"type":"string","description":" Product name reported by device\n\nExample: ` \"xHCI Host Controller\"`","title":"i_product","x-displayname":"Device product","x-ves-example":"xHCI Host Controller"},"i_serial":{"type":"string","description":" Index of Serial Number String Descriptor\n\nExample: ` \"0000:00:14.0\"`","title":"i_serial_number","x-displayname":"iSerialNumber","x-ves-example":"0000:00:14.0"},"id_product":{"type":"string","description":" Product ID (Assigned by Manufacturer) in hex\n\nExample: ` \"0x0002\"`","title":"id_product","x-displayname":"Product ID","x-ves-example":"0x0002"},"id_vendor":{"type":"string","description":" Vendor ID (Assigned by USB Org) in hex\n\nExample: ` \"0x1d6b\"`","title":"id_vendor","x-displayname":"Vendor ID","x-ves-example":"0x1d6b"},"port":{"type":"integer","description":" Port on which the device was detected in decimal\n\nExample: ` \"3\"`","title":"port","format":"int64","x-displayname":"Port","x-ves-example":"3"},"product_name":{"type":"string","description":" Product ID translated to name (if available)\n\nExample: ` \"NetVista Full Width Keyboard\"`","title":"product_name","x-displayname":"Product name","x-ves-example":"NetVista Full Width Keyboard"},"speed":{"type":"string","description":" The negotiated operating speed for the device\n\nExample: ` \"high\"`","title":"speed","x-displayname":"Speed","x-ves-example":"high"},"usb_type":{"$ref":"#/components/schemas/siteUsbType"},"vendor_name":{"type":"string","description":" Vendor ID translated to name (if available)\n\nExample: ` \"IBM Corp.\"`","title":"vendor_name","x-displayname":"Vendor name","x-ves-example":"IBM Corp."}}},"siteUsbType":{"type":"string","description":"Type of USB device\n\nUnknown USB device type\nInternal USB present in Certified HW\nUSB device present during node registration\nUSB device that can be matched by USB rules","title":"UsbType","enum":["UNKNOWN_USB","INTERNAL","REGISTERED","CONFIGURABLE"],"default":"UNKNOWN_USB","x-displayname":"USB Type","x-ves-proto-enum":"ves.io.schema.site.UsbType"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.report","description":"Report configuration contains the information like\n\n    Time at which the report was last sent to object store.\n    Report ID.","version":""},"paths":{"/api/report/namespaces/{namespace}/reports/{name}":{"get":{"summary":"Get Report","description":"Get Report will read the report metadata.","operationId":"ves.io.schema.report.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportGetResponse"}}}},"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-report-api-get"},"x-ves-proto-rpc":"ves.io.schema.report.API.Get"},"x-displayname":"Report","x-ves-proto-service":"ves.io.schema.report.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/report/namespaces/{namespace}/reports/{name}/download":{"get":{"summary":"Download Report","description":"Download report","operationId":"ves.io.schema.report.CustomAPI.DownloadReport","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportDownloadReportResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace for this request.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Report Name\n\nx-required\nx-example: \"test-report\"\nName of the report which has to be downloadd.","in":"path","required":true,"x-displayname":"Report 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-report-customapi-downloadreport"},"x-ves-proto-rpc":"ves.io.schema.report.CustomAPI.DownloadReport"},"x-displayname":"Report","x-ves-proto-service":"ves.io.schema.report.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Report","x-ves-proto-package":"ves.io.schema.report","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"reportAttachmentValue":{"type":"object","description":"Attachment data contains contentId and the data.","title":"Attachment Value","x-displayname":"Attachment Value","x-ves-proto-message":"ves.io.schema.report.AttachmentValue","properties":{"content":{"type":"string","description":" content for attachment\n\nExample: ` \"abcd\"`","title":"content","x-displayname":"Content","x-ves-example":"abcd"},"content_id":{"type":"string","description":" content id for attachment\n\nExample: ` \"cid:security_events.png\"`","title":"content id","x-displayname":"ContentId","x-ves-example":"cid:security_events.png"},"content_type":{"type":"string","description":" content type for attachment\n\nExample: ` \"image/png\"`","title":"content type","x-displayname":"Content Type","x-ves-example":"image/png"},"file_name":{"type":"string","description":" file name for attachment\n\nExample: ` \"security_events.png\"`","title":"file name","x-displayname":"File Name","x-ves-example":"security_events.png"}}},"reportAttackImpact":{"type":"object","description":"attack impact","title":"AttackImpact","x-displayname":"Attack Impact","x-ves-proto-message":"ves.io.schema.report.AttackImpact","properties":{"data":{"type":"array","description":" attack impact data\n\nExample: ` \"Attack Impact\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"attack impact data","items":{"$ref":"#/components/schemas/reportAttackImpactData"},"x-displayname":"Attack Impact Data","x-ves-example":"Attack Impact","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Attack Impact\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Attack Impact Header","x-ves-example":"Attack Impact","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportAttackImpactData":{"type":"object","description":"key value pair of attack impact data","title":"AttackImpactData","x-displayname":"Attack Impact Data","x-ves-proto-message":"ves.io.schema.report.AttackImpactData","properties":{"key":{"$ref":"#/components/schemas/reportAttackImpactKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldDataList"}}},"reportAttackImpactKey":{"type":"string","description":"attack impact key\n\nIndicates field not being set","title":"AttackImpactKey","enum":["ATTACK_IMPACT_KEY_NONE","ATTACK_IMPACT_KEY_TOP_3_ATTACKED_PATHS","ATTACK_IMPACT_KEY_TOP_3_ATTACKED_DOMAINS"],"default":"ATTACK_IMPACT_KEY_NONE","x-displayname":"Attack Impact Key","x-ves-proto-enum":"ves.io.schema.report.AttackImpactKey"},"reportAttackSources":{"type":"object","description":"attack sources","title":"AttackSources","x-displayname":"Attack Sources","x-ves-proto-message":"ves.io.schema.report.AttackSources","properties":{"data":{"type":"array","description":" Attack Sources data\n\nExample: ` \"Attack Sources\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Attack Sources data","items":{"$ref":"#/components/schemas/reportAttackSourcesData"},"x-displayname":"Attack Sources Data","x-ves-example":"Attack Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Attack Sources\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Attack Sources Header","x-ves-example":"Attack Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportAttackSourcesData":{"type":"object","description":"key value pair of attack sources data","title":"AttackSourcesData","x-displayname":"Attack Sources Data","x-ves-proto-message":"ves.io.schema.report.AttackSourcesData","properties":{"key":{"$ref":"#/components/schemas/reportAttackSourcesKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldDataList"}}},"reportAttackSourcesKey":{"type":"string","description":"attack sources key\n\nIndicates field not being set","title":"AttackSourcesKey","enum":["ATTACK_SOURCES_KEY_NONE","ATTACK_SOURCES_KEY_TOP_3_ASNS","ATTACK_SOURCES_KEY_TOP_3_COUNTRIES"],"default":"ATTACK_SOURCES_KEY_NONE","x-displayname":"Attack Sources Key","x-ves-proto-enum":"ves.io.schema.report.AttackSourcesKey"},"reportDownloadReportResponse":{"type":"object","description":"Download report response","title":"Download Report Response","x-displayname":"Download Report Response","x-ves-proto-message":"ves.io.schema.report.DownloadReportResponse","properties":{"Attachments":{"type":"array","description":" Attachments for email","title":"Attachments","items":{"$ref":"#/components/schemas/reportAttachmentValue"},"x-displayname":"Attachments"},"css_data":{"type":"string","description":" report data in css\n\nExample: ` \"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"css data","x-displayname":"Css Data","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"html_data":{"type":"string","description":" report data in html\n\nExample: ` \"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"html data","x-displayname":"Html Data","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportFieldValueType":{"type":"string","description":"field value type\n\nIndicates field not being set","title":"field value type","enum":["TYPE_NONE","TYPE_RATE","TYPE_PERCENT","TYPE_THROUGHPUT","TYPE_NUMBER"],"default":"TYPE_NONE","x-displayname":"Widget Field Value Type","x-ves-proto-enum":"ves.io.schema.report.FieldValueType"},"reportGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read report","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.report.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/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"},"spec":{"$ref":"#/components/schemas/reportGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"reportGetResponseFormatCode":{"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"},"reportGetSpecType":{"type":"object","description":"Get Report will read the report metadata.","title":"Get Report","x-displayname":"Get Report","x-ves-oneof-field-report_data":"[\"atb\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report.GetSpecType","properties":{"atb":{"$ref":"#/components/schemas/reportReportDataATB"},"report_config":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"report_creator_method":{"$ref":"#/components/schemas/reportReportCreatorMethod"},"report_delivery_status":{"$ref":"#/components/schemas/reportReportDeliveryStatus"},"report_frequency":{"type":"string","description":" report frequency\n\nExample: `  \"Every week Monday 4PM PST\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"Report Frequency","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_generation_status":{"$ref":"#/components/schemas/reportReportGenerationStatus"},"report_id":{"type":"string","format":"uint64"},"report_status":{"$ref":"#/components/schemas/reportReportStatus"},"sent_time":{"type":"string","description":" sent time\n\nExample: `  \"June 3 2PM 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","format":"date-time","x-displayname":"Report Sent Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"waap":{"$ref":"#/components/schemas/reportReportDataWAAP"}}},"reportProtectedLBCount":{"type":"object","description":"Protected LB Count.","title":"ProtectedLBCount","x-displayname":"Protected LB Count","x-ves-proto-message":"ves.io.schema.report.ProtectedLBCount","properties":{"protected_lb_count":{"type":"string","description":" LB protected by waap\n\nExample: ` \"24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"LB count protectd by waap","format":"uint64","x-displayname":"LB count protected by WAAP","x-ves-example":"24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"total_lb_count":{"type":"string","description":" total LB count\n\nExample: ` \"50\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"total LB count","format":"uint64","x-displayname":"Total LB count","x-ves-example":"50","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportCreatorMethod":{"type":"string","description":"report creator method\n\nIndicates field not being set","title":"Report Creator Method","enum":["REPORT_CREATE_METHOD_NONE","REPORT_CREATE_METHOD_PERIODIC","REPORT_CREATE_METHOD_USER_TRIGGERED"],"default":"REPORT_CREATE_METHOD_NONE","x-displayname":"Report Creator Method","x-ves-proto-enum":"ves.io.schema.report.ReportCreatorMethod"},"reportReportDataATB":{"type":"object","description":"ATB report data.","title":"ReportDataATB","x-displayname":"ATB Report Data","x-ves-proto-message":"ves.io.schema.report.ReportDataATB","properties":{"json_data":{"type":"string","description":" json_data\n\nExample: ` \"{malicious_bots10}\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"JSON data containing details like the number of malicious bots detected in the given timerange","x-displayname":"JSON data","x-ves-example":"{malicious_bots: 10}","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportDataWAAP":{"type":"object","description":"WAAP report data.","title":"ReportDataWAAP","x-displayname":"WAAP Report Data","x-ves-proto-message":"ves.io.schema.report.ReportDataWAAP","properties":{"attack_impact":{"$ref":"#/components/schemas/reportAttackImpact"},"attack_sources":{"$ref":"#/components/schemas/reportAttackSources"},"lb_count":{"$ref":"#/components/schemas/reportProtectedLBCount"},"report_footer":{"$ref":"#/components/schemas/ioschemaEmpty"},"report_header":{"$ref":"#/components/schemas/reportReportHeader"},"security_events":{"$ref":"#/components/schemas/reportSecurityEvents"},"threat_details":{"$ref":"#/components/schemas/reportThreatDetails"}}},"reportReportDeliveryState":{"type":"string","description":"report delivery state\n\nIndicates field not being set\nstate is Success\nstate is Error\nstate is Partial\nstate is Pending\nIndicates no user groups are configured and report can be downloaded","title":"Report delivery state","enum":["REPORT_DELIVERY_STATE_NONE","REPORT_DELIVERY_STATE_SUCCESS","REPORT_DELIVERY_STATE_ERROR","REPORT_DELIVERY_STATE_PARTIAL","REPORT_DELIVERY_STATE_PENDING","REPORT_DELIVERY_STATE_DOWNLOAD"],"default":"REPORT_DELIVERY_STATE_NONE","x-displayname":"Report Delivery State","x-ves-proto-enum":"ves.io.schema.report.ReportDeliveryState"},"reportReportDeliveryStatus":{"type":"object","description":"report generation status","title":"Report Delivery Status","x-displayname":"Report Delivery Status","x-ves-proto-message":"ves.io.schema.report.ReportDeliveryStatus","properties":{"delivered_time":{"type":"string","description":" delivery time\n\nExample: ` \"June 3 8PM 2022\"`","title":"report delivered time","format":"date-time","x-displayname":"Report delivered time","x-ves-example":"June 3 8PM 2022"},"eta":{"type":"string","description":" estimated time\n\nExample: ` \"June 3 11PM 2022\"`","title":"estimated time at which the report delivery would be complete","format":"date-time","x-displayname":"Estimated Time at which the report generation would be complete","x-ves-example":"June 3 11PM 2022"},"report_delivery_state":{"$ref":"#/components/schemas/reportReportDeliveryState"}}},"reportReportFrequency":{"type":"string","description":"report frequency\n\nIndicates field not being set","title":"Report Frequency","enum":["REPORT_FREQUENCY_NONE","REPORT_FREQUENCY_DAILY","REPORT_FREQUENCY_WEEKLY","REPORT_FREQUENCY_MONTHLY"],"default":"REPORT_FREQUENCY_NONE","x-displayname":"Report Frequency","x-ves-proto-enum":"ves.io.schema.report.ReportFrequency"},"reportReportGenerationStatus":{"type":"object","description":"report generation status","title":"Report Generation Status","x-displayname":"Report Generation Status","x-ves-proto-message":"ves.io.schema.report.ReportGenerationStatus","properties":{"eta":{"type":"string","description":" estimated time\n\nExample: ` \"June 3 11PM 2022\"`","title":"estimated time at which the report generation would be complete","format":"date-time","x-displayname":"Estimated Time at which the report generation would be complete","x-ves-example":"June 3 11PM 2022"},"report_status":{"$ref":"#/components/schemas/reportReportStatus"},"scheduled_time":{"type":"string","description":" scheduled time\n\nExample: ` \"June 3 8PM 2022\"`","title":"report scheduled time","format":"date-time","x-displayname":"Report scheduled time","x-ves-example":"June 3 8PM 2022"}}},"reportReportHeader":{"type":"object","description":"report header","title":"report header","x-displayname":"Report Header","x-ves-proto-message":"ves.io.schema.report.ReportHeader","properties":{"end_time":{"type":"string","description":" end time of the report data\n\nExample: ` \"3 July 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report end time","x-displayname":"End Time of Report","x-ves-example":"3 July 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"generation_time":{"type":"string","description":" report generation time\n\nExample: ` \"3 July 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"3 July 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" namespace of the report data\n\nExample: ` \"ves-system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"namespace","x-displayname":"Namespace","x-ves-example":"ves-system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_frequency":{"$ref":"#/components/schemas/reportReportFrequency"},"report_sub_title":{"type":"string","description":" report sub title\n\nExample: ` \"Web App and API Protection\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"sub title of the report","x-displayname":"Report Sub Title","x-ves-example":"Web App and API Protection","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_title":{"type":"string","description":" report title\n\nExample: ` \"WAAP Dashboard summary\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"title of the report","x-displayname":"Report Title","x-ves-example":"WAAP Dashboard summary","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the report data\n\nExample: ` \"3 Jun 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report start time","x-displayname":"Start Time of Report","x-ves-example":"3 Jun 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tenant_fqdn":{"type":"string","description":" x-displayName \"Tenant\"\n Tenant to which this object belongs.\n\nExample: ` \"testing.demo1.volterra.us\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"tenant fqdn","x-ves-example":"testing.demo1.volterra.us","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportStatus":{"type":"string","description":"report status\n\nIndicates field not being set\nUnable to send report to all the users specified in the user groups of report config object.","title":"Report Status","enum":["NONE","SUCCESS","ERROR","PENDING","PAUSED","PARTIAL"],"default":"NONE","x-displayname":"Report Status","x-ves-proto-enum":"ves.io.schema.report.ReportStatus"},"reportSecurityEvents":{"type":"object","description":"Security events Breakdown","title":"SecurityEvents","x-displayname":"Security Events Breakdown","x-ves-proto-message":"ves.io.schema.report.SecurityEvents","properties":{"data":{"type":"array","description":" Security events breakdown data\n\nExample: ` \"Threat data 16k\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Security events data","items":{"$ref":"#/components/schemas/reportSecurityEventsData"},"x-displayname":"Security events breakdown data","x-ves-example":"Threat data 16k","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" Security events header \n\nExample: ` \"Security Events Breakdown\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Security Events header","x-ves-example":"Security Events Breakdown","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportSecurityEventsData":{"type":"object","description":"Security events breakdown data","title":"SecurityEventsData","x-displayname":"Security Events Data","x-ves-proto-message":"ves.io.schema.report.SecurityEventsData","properties":{"key":{"$ref":"#/components/schemas/reportSecurityEventsKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldData"}}},"reportSecurityEventsKey":{"type":"string","description":"security events key\n\nIndicates field not being set","title":"SecurityEventsKey","enum":["SECURITY_EVENTS_KEY_NONE","SECURITY_EVENTS_KEY_TOTAL_SECURITY_EVENTS","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_BLOCKED"],"default":"SECURITY_EVENTS_KEY_NONE","x-displayname":"Security events key","x-ves-proto-enum":"ves.io.schema.report.SecurityEventsKey"},"reportThreatDetails":{"type":"object","description":"Threat details","title":"ThreatDetails","x-displayname":"Threat details","x-ves-proto-message":"ves.io.schema.report.ThreatDetails","properties":{"data":{"type":"array","description":" Threat details data.\n\nExample: ` \"Threat data 16k\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Threat details data","items":{"$ref":"#/components/schemas/reportThreatDetailsData"},"x-displayname":"Threat details data","x-ves-example":"Threat data 16k","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Threat details\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Threat details Header","x-ves-example":"Threat details","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportThreatDetailsData":{"type":"object","description":"key value pair threat details data","title":"ThreatDetailsData","x-displayname":"Threat Details Data","x-ves-proto-message":"ves.io.schema.report.ThreatDetailsData","properties":{"key":{"$ref":"#/components/schemas/reportThreatDetailsKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldData"}}},"reportThreatDetailsKey":{"type":"string","description":"threat details key\n\nIndicates field not being set","title":"ThreatDetailsKey","enum":["THREAT_DETAILS_KEY_NONE","THREAT_DETAILS_KEY_ALL_TRAFFIC_IS_FROM_BOTS","THREAT_DETAILS_KEY_ALL_TRAFFIC_FROM_MALICIOUS_BOTS","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS","THREAT_DETAILS_KEY_IP_REPUTATION_ATTACK_MITIGATED","THREAT_DETAILS_KEY_LB_DDOS_ATTACK_ACTIVITY","THREAT_DETAILS_KEY_MALICIOUS_USERS_DETECTED","THREAT_DETAILS_KEY_API_ENDPOINTS","THREAT_DETAILS_KEY_API_ENDPOINTS_PII_DETECTED","THREAT_DETAILS_KEY_API_ENDPOINTS_PII_NOT_DETECTED","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_ALLOWED","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_BLOCKED","THREAT_DETAILS_KEY_IP_REPUTATION_ALLOWED","THREAT_DETAILS_KEY_IP_REPUTATION_BLOCKED"],"default":"THREAT_DETAILS_KEY_NONE","x-displayname":"Threat Details Key","x-ves-proto-enum":"ves.io.schema.report.ThreatDetailsKey"},"reportWaapReportFieldData":{"type":"object","description":"waap report field data","title":"Waap Report Field Data","x-displayname":"Waap Report Field Data","x-ves-proto-message":"ves.io.schema.report.WaapReportFieldData","properties":{"current_value":{"type":"number","description":" field current value\n\nExample: ` \"16000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"field current value","format":"double","x-displayname":"Current Value","x-ves-example":"16000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"current_value_header":{"type":"string","description":" field value header\n\nExample: ` \"Digital Ocean\"`","title":"field value header","x-displayname":"Field Value Header","x-ves-example":"Digital Ocean"},"current_value_sub_values":{"type":"object","description":" field sub values\n\nExample: ` \"128000 value will be sub-divided further like WAF6100, Bot defense:1500\"`","title":"field value sub values","x-displayname":"Field Sub Values","x-ves-example":"128000 value will be sub-divided further like WAF: 6100, Bot defense:1500"},"current_value_type":{"$ref":"#/components/schemas/reportFieldValueType"},"prev_value":{"type":"number","description":" field previous value, type will be same as current_value_type\n\nExample: ` \"15000\"`","title":"field previous value","format":"double","x-displayname":"Field Previous Value","x-ves-example":"15000"},"prev_value_header":{"type":"string","description":" field previous value header\n\nExample: ` \"ULAYER ASN\"`","title":"field previous value header","x-displayname":"Field Previous Value Header","x-ves-example":"ULAYER ASN"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"reportWaapReportFieldDataList":{"type":"object","description":"waap report field data list","title":"Waap Report Field Data List","x-displayname":"Waap Report Field Data List","x-ves-proto-message":"ves.io.schema.report.WaapReportFieldDataList","properties":{"data":{"type":"array","description":" waap report data field list \n\nExample: ` \"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"field data list","items":{"$ref":"#/components/schemas/reportWaapReportFieldData"},"x-displayname":"List of Waap Report Data Fields","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"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"}}},"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"}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}}}}}