@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.alert_receiver","description":"Alert Receiver is used to specify a receiver (slack, pagerDuty, etc.,) to send the alert notifications.\nAn Alert Receiver may be associated with one or more Alert Policy objects, which defines one or more routes to match\nthe incoming alert.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/alert_receivers":{"post":{"summary":"Create Alert Receiver","description":"Creates a new Alert Receiver object","operationId":"ves.io.schema.alert_receiver.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverCreateResponse"}}}},"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/alert_receiverCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-api-create"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.API.Create"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/alert_receivers/{metadata.name}":{"put":{"summary":"Replace Alert Receiver","description":"Replaces the content of an Alert Receiver object","operationId":"ves.io.schema.alert_receiver.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverReplaceResponse"}}}},"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/alert_receiverReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-api-replace"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.API.Replace"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/alert_receivers":{"get":{"summary":"List Alert Receiver","description":"List the set of alert_receiver in a namespace","operationId":"ves.io.schema.alert_receiver.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverListResponse"}}}},"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 alert_receiver","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-alert_receiver-api-list"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.API.List"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/alert_receivers/{name}":{"get":{"summary":"Get Alert Receiver","description":"Get the Alert Receiver object","operationId":"ves.io.schema.alert_receiver.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-api-get"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.API.Get"},"delete":{"summary":"Delete Alert Receiver","description":"Delete the specified alert_receiver","operationId":"ves.io.schema.alert_receiver.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-api-delete"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.API.Delete"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/alert/namespaces/{namespace}/alert_receivers/{name}/confirm":{"post":{"summary":"Confirm Alert Receiver","description":"API to confirm the Alert Receiver - applicable only for email and sms","operationId":"ves.io.schema.alert_receiver.CustomAPI.ConfirmAlertReceiver","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverConfirmAlertReceiverResponse"}}}},"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: \"ns1\"\nNamespace in which the alert receiver is configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"email1\"\nName of the alert receiver","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverConfirmAlertReceiverRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-customapi-confirmalertreceiver"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.CustomAPI.ConfirmAlertReceiver"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/alert/namespaces/{namespace}/alert_receivers/{name}/test":{"post":{"summary":"Test Alert Receiver","description":"API to send test alert","operationId":"ves.io.schema.alert_receiver.CustomAPI.TestAlertReceiver","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverTestAlertReceiverResponse"}}}},"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: \"ns1\"\nNamespace in which the alert receiver is configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"slack1\"\nName of the alert receiver","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverTestAlertReceiverRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-customapi-testalertreceiver"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.CustomAPI.TestAlertReceiver"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/alert/namespaces/{namespace}/alert_receivers/{name}/verify":{"post":{"summary":"Verify Alert Receiver","description":"API to send request to verify Alert Receiver - applicable only for email and sms","operationId":"ves.io.schema.alert_receiver.CustomAPI.VerifyAlertReceiver","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverVerifyAlertReceiverResponse"}}}},"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: \"ns1\"\nNamespace in which the alert receiver is configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"email1\"\nName of the alert receiver","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert_receiverVerifyAlertReceiverRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert_receiver-customapi-verifyalertreceiver"},"x-ves-proto-rpc":"ves.io.schema.alert_receiver.CustomAPI.VerifyAlertReceiver"},"x-displayname":"Alert Receiver","x-ves-proto-service":"ves.io.schema.alert_receiver.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Alert Receiver","x-ves-proto-package":"ves.io.schema.alert_receiver","components":{"schemas":{"alert_receiverAuthToken":{"type":"object","description":"Authentication Token for access","title":"Token Authentication","x-displayname":"Access Token","x-ves-proto-message":"ves.io.schema.alert_receiver.AuthToken","properties":{"token":{"$ref":"#/components/schemas/schemaSecretType"}}},"alert_receiverCACertificateObj":{"type":"object","description":"Configuration for CA certificate","title":"CA Certificate Object","x-displayname":"CA Certificate Object","x-ves-proto-message":"ves.io.schema.alert_receiver.CACertificateObj","properties":{"trusted_ca":{"type":"array","description":" Reference to client certificate object\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"certificate_object_refs","maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Certificate Object","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"alert_receiverClientCertificateObj":{"type":"object","description":"Configuration for client certificate","title":"Client Certificate Object","x-displayname":"Client Certificate Object","x-ves-proto-message":"ves.io.schema.alert_receiver.ClientCertificateObj","properties":{"use_tls_obj":{"type":"array","description":" Reference to client certificate object\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"certificate_object_refs","maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Certificate Object","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"alert_receiverConfirmAlertReceiverRequest":{"type":"object","description":"Request to confirm the Alert Receiver","title":"Confirm Alert Receiver Request","x-displayname":"Confirm Alert Receiver Request","x-ves-proto-message":"ves.io.schema.alert_receiver.ConfirmAlertReceiverRequest","properties":{"name":{"type":"string","description":" Name of the alert receiver\n\nExample: ` \"email1\"`","title":"Name","x-displayname":"Name","x-ves-example":"email1"},"namespace":{"type":"string","description":" Namespace in which the alert receiver is configured\n\nExample: ` \"ns1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"verification_code":{"type":"string","description":" Verification Code received by the user\n\nExample: ` \"123456\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.len_bytes: 6\n","title":"Verification Code","x-displayname":"Verification Code","x-ves-example":"123456","x-ves-validation-rules":{"ves.io.schema.rules.string.len_bytes":"6"}}}},"alert_receiverConfirmAlertReceiverResponse":{"type":"object","description":"Response for the Alert Receiver Confirm request; empty because the only returned\ninformation is error message.","title":"Confirm Alert Receiver Response","x-displayname":"Confirm Alert Receiver Response","x-ves-proto-message":"ves.io.schema.alert_receiver.ConfirmAlertReceiverResponse"},"alert_receiverCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of alert_receiver","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.alert_receiver.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/alert_receiverCreateSpecType"}}},"alert_receiverCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.alert_receiver.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/alert_receiverGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"alert_receiverCreateSpecType":{"type":"object","description":"Creates a new Alert Receiver object","title":"Create Alert Receiver","x-displayname":"Create Alert Receiver","x-ves-oneof-field-receiver":"[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]","x-ves-proto-message":"ves.io.schema.alert_receiver.CreateSpecType","properties":{"email":{"$ref":"#/components/schemas/alert_receiverEmailConfig"},"opsgenie":{"$ref":"#/components/schemas/alert_receiverOpsGenieConfig"},"pagerduty":{"$ref":"#/components/schemas/alert_receiverPagerDutyConfig"},"slack":{"$ref":"#/components/schemas/alert_receiverSlackConfig"},"sms":{"$ref":"#/components/schemas/alert_receiverSMSConfig"},"webhook":{"$ref":"#/components/schemas/alert_receiverWebhookConfig"}}},"alert_receiverDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a alert_receiver","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.alert_receiver.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"alert_receiverEmailConfig":{"type":"object","title":"EmailConfig","x-displayname":"Email Configuration","x-ves-proto-message":"ves.io.schema.alert_receiver.EmailConfig","properties":{"email":{"type":"string","description":" Email id of the user\n\nExample: ` \"abc@email.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.email: true\n","title":"Email","x-displayname":"Email","x-ves-example":"abc@email.com","x-ves-validation-rules":{"ves.io.schema.rules.string.email":"true"}}}},"alert_receiverGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read alert_receiver","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.alert_receiver.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/alert_receiverCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/alert_receiverReplaceRequest"},"spec":{"$ref":"#/components/schemas/alert_receiverGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/alert_receiverStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"alert_receiverGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"alert_receiverGetSpecType":{"type":"object","description":"Get the Alert Receiver object","title":"Get Alert Receiver","x-displayname":"Get Alert Receiver","x-ves-oneof-field-receiver":"[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]","x-ves-proto-message":"ves.io.schema.alert_receiver.GetSpecType","properties":{"email":{"$ref":"#/components/schemas/alert_receiverEmailConfig"},"opsgenie":{"$ref":"#/components/schemas/alert_receiverOpsGenieConfig"},"pagerduty":{"$ref":"#/components/schemas/alert_receiverPagerDutyConfig"},"slack":{"$ref":"#/components/schemas/alert_receiverSlackConfig"},"sms":{"$ref":"#/components/schemas/alert_receiverSMSConfig"},"webhook":{"$ref":"#/components/schemas/alert_receiverWebhookConfig"}}},"alert_receiverHTTPConfig":{"type":"object","description":"Configuration for HTTP endpoint","title":"HTTP Configuration","x-displayname":"HTTP Configuration","x-ves-displayorder":"15,11,4,5","x-ves-oneof-field-auth_choice":"[\"auth_token\",\"basic_auth\",\"client_cert_obj\",\"no_authorization\"]","x-ves-oneof-field-tls_choice":"[\"no_tls\",\"use_tls\"]","x-ves-proto-message":"ves.io.schema.alert_receiver.HTTPConfig","properties":{"auth_token":{"$ref":"#/components/schemas/alert_receiverAuthToken"},"basic_auth":{"$ref":"#/components/schemas/alert_receiverHttpBasicAuth"},"client_cert_obj":{"$ref":"#/components/schemas/alert_receiverClientCertificateObj"},"enable_http2":{"type":"boolean","description":" Configure to use HTTP2 protocol.\n\nExample: ` \"value\"`","title":"Enable HTTP2","format":"boolean","x-displayname":"Enable HTTP2","x-ves-example":"value"},"follow_redirects":{"type":"boolean","description":" Configure whether HTTP requests follow HTTP 3xx redirects.\n\nExample: ` \"value\"`","title":"Follow Redirects","format":"boolean","x-displayname":"Follow Redirects","x-ves-example":"value"},"no_authorization":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_tls":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_tls":{"$ref":"#/components/schemas/alert_receiverTLSConfig"}}},"alert_receiverHttpBasicAuth":{"type":"object","description":"Authorization parameters to access HTPP alert Receiver Endpoint.","title":"HTTP Basic Authorization","x-displayname":"Basic Authorization Credentials","x-ves-proto-message":"ves.io.schema.alert_receiver.HttpBasicAuth","properties":{"password":{"$ref":"#/components/schemas/schemaSecretType"},"user_name":{"type":"string","description":" HTTP Basic Auth User Name\n\nExample: ` \"Joe\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n","title":"username","maxLength":64,"x-displayname":"User Name","x-ves-example":"Joe","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64"}}}},"alert_receiverListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of alert_receiver","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.alert_receiver.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/alert_receiverListResponseItem"},"x-displayname":"Items"}}},"alert_receiverListResponseItem":{"type":"object","description":"By default a summary of alert_receiver 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 alert_receiver","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.alert_receiver.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this alert_receiver","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this alert_receiver","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates alert_receiver is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/alert_receiverGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this alert_receiver","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this alert_receiver\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/alert_receiverStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this alert_receiver\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"alert_receiverOpsGenieConfig":{"type":"object","description":"OpsGenie configuration to send alert notifications","title":"Opsgenie Config","x-displayname":"OpsGenie Config","x-ves-proto-message":"ves.io.schema.alert_receiver.OpsGenieConfig","properties":{"api_key":{"$ref":"#/components/schemas/schemaSecretType"},"url":{"type":"string","description":" URL to send API requests to\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","x-displayname":"API URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}}}},"alert_receiverPagerDutyConfig":{"type":"object","description":"PagerDuty configuration to send alert notifications","title":"PagerDuty Config","x-displayname":"PagerDuty Config","x-ves-proto-message":"ves.io.schema.alert_receiver.PagerDutyConfig","properties":{"routing_key":{"$ref":"#/components/schemas/schemaSecretType"},"url":{"type":"string","description":" URL to send API requests to\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","x-displayname":"Pager Duty URL","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}}}},"alert_receiverReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a alert_receiver","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.alert_receiver.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/alert_receiverReplaceSpecType"}}},"alert_receiverReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.alert_receiver.ReplaceResponse"},"alert_receiverReplaceSpecType":{"type":"object","description":"Replaces the content of an Alert Receiver object","title":"Replace Alert Receiver","x-displayname":"Replace Alert Receiver","x-ves-oneof-field-receiver":"[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]","x-ves-proto-message":"ves.io.schema.alert_receiver.ReplaceSpecType","properties":{"email":{"$ref":"#/components/schemas/alert_receiverEmailConfig"},"opsgenie":{"$ref":"#/components/schemas/alert_receiverOpsGenieConfig"},"pagerduty":{"$ref":"#/components/schemas/alert_receiverPagerDutyConfig"},"slack":{"$ref":"#/components/schemas/alert_receiverSlackConfig"},"sms":{"$ref":"#/components/schemas/alert_receiverSMSConfig"},"webhook":{"$ref":"#/components/schemas/alert_receiverWebhookConfig"}}},"alert_receiverSMSConfig":{"type":"object","title":"SMSConfig","x-displayname":"SMS Configuration","x-ves-proto-message":"ves.io.schema.alert_receiver.SMSConfig","properties":{"contact_number":{"type":"string","description":" Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code]\n\nExample: ` \"+14084004001\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.phone_number: true\n","title":"Contact Number","x-displayname":"Contact Number","x-ves-example":"+14084004001","x-ves-validation-rules":{"ves.io.schema.rules.string.phone_number":"true"}}}},"alert_receiverSlackConfig":{"type":"object","description":"Slack configuration to send alert notifications","title":"Slack Config","x-displayname":"Slack Config","x-ves-proto-message":"ves.io.schema.alert_receiver.SlackConfig","properties":{"channel":{"type":"string","description":" Channel or user to send notifications to\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: ^[a-z0-9-_]{1,80}$\n","title":"Channel","x-displayname":"Channel","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"^[a-z0-9-_]{1,80}$"}},"url":{"$ref":"#/components/schemas/schemaSecretType"}}},"alert_receiverStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Alert Receiver Status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.alert_receiver.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"alert_receiverTLSConfig":{"type":"object","description":"Configures the token request's TLS settings.","title":"TLS Config","x-displayname":"TLS Config","x-ves-displayorder":"10,14,15","x-ves-oneof-field-server_validation_choice":"[\"use_server_verification\",\"volterra_trusted_ca\"]","x-ves-oneof-field-sni_choice":"[\"disable_sni\",\"sni\"]","x-ves-proto-message":"ves.io.schema.alert_receiver.TLSConfig","properties":{"disable_sni":{"$ref":"#/components/schemas/ioschemaEmpty"},"max_version":{"$ref":"#/components/schemas/schemaTlsProtocol"},"min_version":{"$ref":"#/components/schemas/schemaTlsProtocol"},"sni":{"type":"string","description":"Exclusive with [disable_sni]\n SNI value to be used.\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"sni","maxLength":256,"x-displayname":"SNI Value","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256"}},"use_server_verification":{"$ref":"#/components/schemas/alert_receiverUpstreamTlsValidationContext"},"volterra_trusted_ca":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"alert_receiverTestAlertReceiverRequest":{"type":"object","description":"Request to send test alert","title":"Test Alert Receiver Request","x-displayname":"Test Alert Receiver Request","x-ves-proto-message":"ves.io.schema.alert_receiver.TestAlertReceiverRequest","properties":{"name":{"type":"string","description":" Name of the alert receiver\n\nExample: ` \"slack1\"`","title":"Name","x-displayname":"Name","x-ves-example":"slack1"},"namespace":{"type":"string","description":" Namespace in which the alert receiver is configured\n\nExample: ` \"ns1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"alert_receiverTestAlertReceiverResponse":{"type":"object","description":"Response for the Alert Receiver test request; empty because the only returned\ninformation is error message.","title":"Test Alert Receiver Response","x-displayname":"Test Alert Receiver Response","x-ves-proto-message":"ves.io.schema.alert_receiver.TestAlertReceiverResponse"},"alert_receiverUpstreamTlsValidationContext":{"type":"object","description":"Upstream TLS Validation Context","title":"UpstreamTlsValidationContext","x-displayname":"TLS Validation Context for Servers","x-ves-proto-message":"ves.io.schema.alert_receiver.UpstreamTlsValidationContext","properties":{"ca_cert_obj":{"$ref":"#/components/schemas/alert_receiverCACertificateObj"}}},"alert_receiverVerifyAlertReceiverRequest":{"type":"object","description":"Send request to verify Alert Receiver","title":"Verify Alert Receiver Request","x-displayname":"Verify Alert Receiver Request","x-ves-proto-message":"ves.io.schema.alert_receiver.VerifyAlertReceiverRequest","properties":{"name":{"type":"string","description":" Name of the alert receiver\n\nExample: ` \"email1\"`","title":"Name","x-displayname":"Name","x-ves-example":"email1"},"namespace":{"type":"string","description":" Namespace in which the alert receiver is configured\n\nExample: ` \"ns1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"alert_receiverVerifyAlertReceiverResponse":{"type":"object","description":"Response for the Alert Receiver Verify request; empty because the only returned\ninformation is error message.","title":"Verify Alert Receiver Response","x-displayname":"Verify Alert Receiver Response","x-ves-proto-message":"ves.io.schema.alert_receiver.VerifyAlertReceiverResponse"},"alert_receiverWebhookConfig":{"type":"object","description":"Webhook configuration to send alert notifications","title":"Webhook Config","x-displayname":"Webhook Config","x-ves-proto-message":"ves.io.schema.alert_receiver.WebhookConfig","properties":{"http_config":{"$ref":"#/components/schemas/alert_receiverHTTPConfig"},"url":{"$ref":"#/components/schemas/schemaSecretType"}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaTlsProtocol":{"type":"string","description":"TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.","title":"TlsProtocol","enum":["TLS_AUTO","TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"default":"TLS_AUTO","x-displayname":"TLS Protocol","x-ves-proto-enum":"ves.io.schema.TlsProtocol"},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"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"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.alert","description":"Alert may be generated based on the metrics or based on severity level in the logs. All alerts are scoped by \ntenant and namespace and tagged with the following default labels that can be used to fetch\nthe desired alerts.\n\n\"alertname\" - Name of the alert. This uniquely identifies the alert rule/configuration that generated the alert.\n\"type\" - Type of the alert. Type is used to associate alert to a configuration object or any user visible entity.\n         For example, virtual host, virtual network, app_type, etc.\n\"identifier\" - Identifier of the alert. For virtual-network, this would be the name of the virtual-network.\n\"severity\" - Indicates the severity of the alert. Valid values are minor, major, critical.\n\nAlert may have additional labels associated depending on the labels associated with the metric used to configure the alert rule.\nAlerts can be queried by specifying one or more of the above labels in the match filter.\nIf the match filter is not specified, then all the alerts for the tenant and corresponding namespace in the request will be returned in the response.","version":""},"paths":{"/api/data/namespaces/system/all_ns_alerts":{"get":{"summary":"Get Alerts","description":"For system namespace, all the alerts for the tenant matching the filter specified in the request\nwill be returned in the response.","operationId":"ves.io.schema.alert.CustomAPI.AlertsAllNamespaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertResponse"}}}},"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":"x-example: \"value\"\nnamespace to scope the listing of alerts.\nwhen namespace = \"system\", all alerts for the tenant will be returned.","in":"query","required":false,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"inactive","description":"x-example: \"false\"\nIf set to true, active alerts will not be returned in the response.","in":"query","required":false,"x-displayname":"Inactive","schema":{"type":"boolean","format":"boolean"}},{"name":"silenced","description":"x-example: \"true\"\nshow silenced alerts - alerts that are muted based on the matchers configured in the alert manager.","in":"query","required":false,"x-displayname":"Silenced","schema":{"type":"boolean","format":"boolean"}},{"name":"inhibited","description":"x-example: \"false\"\nshow inhibited alerts - alerts that are suppressed if certain other alerts are firing.","in":"query","required":false,"x-displayname":"Inhibited","schema":{"type":"boolean","format":"boolean"}},{"name":"unprocessed","description":"x-example: \"false\"\nshow unprocessed alerts.","in":"query","required":false,"x-displayname":"Unprocessed","schema":{"type":"boolean","format":"boolean"}},{"name":"filter","description":"x-example: \"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"\nList of matchers to filter alerts by.\nFiltering via label matchers follows the same syntax and semantics as Prometheus.\nsyntax for filter := {[<matcher>]} \n<matcher> := <label_name><operator>\"<label_value>\"\n<label_name> := string\n  All alerts have the following default labels:\n    \"alertname\", \"identifier\", \"type\", \"severity\"\n<label_value> := string\n<operator> := [ same as label match operators supported by prometheus - Please refer https://prometheus.io/docs/prometheus/latest/querying/basics ]\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.","in":"query","required":false,"x-displayname":"Filter","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alertsallnamespaces"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.AlertsAllNamespaces"},"x-displayname":"Alerts","x-ves-proto-service":"ves.io.schema.alert.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/alerts":{"get":{"summary":"Get Alerts","description":"Get alerts matching the filter for the given namespace.","operationId":"ves.io.schema.alert.CustomAPI.Alerts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"value\"\nnamespace to scope the listing of alerts.\nwhen namespace = \"system\", all alerts for the tenant will be returned.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"inactive","description":"x-example: \"false\"\nIf set to true, active alerts will not be returned in the response.","in":"query","required":false,"x-displayname":"Inactive","schema":{"type":"boolean","format":"boolean"}},{"name":"silenced","description":"x-example: \"true\"\nshow silenced alerts - alerts that are muted based on the matchers configured in the alert manager.","in":"query","required":false,"x-displayname":"Silenced","schema":{"type":"boolean","format":"boolean"}},{"name":"inhibited","description":"x-example: \"false\"\nshow inhibited alerts - alerts that are suppressed if certain other alerts are firing.","in":"query","required":false,"x-displayname":"Inhibited","schema":{"type":"boolean","format":"boolean"}},{"name":"unprocessed","description":"x-example: \"false\"\nshow unprocessed alerts.","in":"query","required":false,"x-displayname":"Unprocessed","schema":{"type":"boolean","format":"boolean"}},{"name":"filter","description":"x-example: \"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"\nList of matchers to filter alerts by.\nFiltering via label matchers follows the same syntax and semantics as Prometheus.\nsyntax for filter := {[<matcher>]} \n<matcher> := <label_name><operator>\"<label_value>\"\n<label_name> := string\n  All alerts have the following default labels:\n    \"alertname\", \"identifier\", \"type\", \"severity\"\n<label_value> := string\n<operator> := [ same as label match operators supported by prometheus - Please refer https://prometheus.io/docs/prometheus/latest/querying/basics ]\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.","in":"query","required":false,"x-displayname":"Filter","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alerts"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.Alerts"},"x-displayname":"Alerts","x-ves-proto-service":"ves.io.schema.alert.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/alerts/history":{"get":{"summary":"Get Alerts History","description":"Get the history of alert notifications sent to the end-user between the start_time and end_time that matches the\nfilter specified in the request.","operationId":"ves.io.schema.alert.CustomAPI.AlertsHistory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryResponse"}}}},"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 alerts.\nFor \"system\" namespace, all alerts for the tenant will be returned.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"filter","description":"x-example: \"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"\nList of matchers to filter alert by.\nsyntax for filter := {[<matcher>]}\n<matcher> := <label_name><operator>\"<label_value>\"\n<label_name> := string\n  All alerts have the following default labels:\n    \"alertname\", \"identifier\", \"group\", \"severity\"\n<label_value> := string\n<operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n  = : Select labels that are exactly equal to the provided string\n  != : Select labels that are not equal to the provided string.\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.","in":"query","required":false,"x-displayname":"Filter","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"2019-09-23T12:30:11.733Z\"\nfetch alerts whose timestamp >= start_time\nformat: unix_timestamp|rfc 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\n          If end_time is not specified, then the start_time will be evaluated to <current time>-10m","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"2019-09-24T12:30:11.733Z\"\nfetch alerts whose timestamp <= end_time\nformat: unix_timestamp|rfc 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\n          If start_time is not specified, then the end_time will be evaluated to <current time>","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alertshistory"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.AlertsHistory"},"x-displayname":"Alerts","x-ves-proto-service":"ves.io.schema.alert.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/alerts/history/aggregation":{"post":{"summary":"Alerts History Aggregation","description":"Get summary/aggregation data for alerts in the given namespace.\nFor `system` namespace, all alerts for the tenant matching the query specified\nin the request will be considered for aggregation.","operationId":"ves.io.schema.alert.CustomAPI.AlertsHistoryAggregation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryAggregationResponse"}}}},"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 alerts.\nFor \"system\" namespace, all alerts for the tenant will be returned.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alertshistoryaggregation"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.AlertsHistoryAggregation"},"x-displayname":"Alerts","x-ves-proto-service":"ves.io.schema.alert.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/alerts/history/scroll":{"get":{"summary":"Alerts History Scroll","description":"Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse\ncontaining no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the\nAlertsHistoryScrollRequest. Use the scroll_id returned in the AlertsHistoryResponse to fetch the next batch of alert messages and\none can continue this process till the scroll_id returned in the AlertsHistoryResponse is \"\" which indicates no more\nalert messages to scroll.","operationId":"ves.io.schema.alert.CustomAPI.AlertsHistoryScroll","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryResponse"}}}},"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\"\nfetch the alerts scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of alert messages.","in":"query","required":false,"x-displayname":"Scroll ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alertshistoryscroll"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.AlertsHistoryScroll"},"post":{"summary":"Alerts History Scroll","description":"Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse\ncontaining no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the\nAlertsHistoryScrollRequest. Use the scroll_id returned in the AlertsHistoryResponse to fetch the next batch of alert messages and\none can continue this process till the scroll_id returned in the AlertsHistoryResponse is \"\" which indicates no more\nalert messages to scroll.","operationId":"ves.io.schema.alert.CustomAPI.AlertsHistoryScroll","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryResponse"}}}},"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\"\nfetch the alerts scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertAlertsHistoryScrollRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-alert-customapi-alertshistoryscroll"},"x-ves-proto-rpc":"ves.io.schema.alert.CustomAPI.AlertsHistoryScroll"},"x-displayname":"Alerts","x-ves-proto-service":"ves.io.schema.alert.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Alerts","x-ves-proto-package":"ves.io.schema.alert","components":{"schemas":{"alertAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the alert response","title":"Aggregation Request","properties":{"cardinality_aggregation":{"$ref":"#/components/schemas/alertCardinalityAggregation"},"date_aggregation":{"$ref":"#/components/schemas/alertDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/alertFieldAggregation"},"multi_field_aggregation":{"$ref":"#/components/schemas/alertMultiFieldAggregation"}}},"alertAlertsHistoryAggregationRequest":{"type":"object","description":"Request to get only aggregation data for alerts.","title":"Alerts History Aggregation Request","x-displayname":"Alerts History Aggregation Request","x-ves-proto-message":"ves.io.schema.alert.AlertsHistoryAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch alerts whose timestamp <= end_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end_time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"filter":{"type":"string","description":" List of matchers to filter alert by.\n syntax for filter := {[<matcher>]}\n <matcher> := <label_name><operator>\"<label_value>\"\n <label_name> := string\n   All alerts have the following default labels:\n     \"alertname\", \"identifier\", \"group\", \"severity\"\n <label_value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : Select labels that are exactly equal to the provided string\n   != : Select labels that are not equal to the provided string.\n When more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\n Optional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.\n\nExample: ` \"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"`","title":"filter","x-displayname":"Filter","x-ves-example":"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}"},"namespace":{"type":"string","description":" namespace to scope the listing of alerts.\n For \"system\" namespace, all alerts for the tenant will be returned.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"start_time":{"type":"string","description":" fetch alerts whose timestamp >= start_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start_time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"alertAlertsHistoryAggregationResponse":{"type":"object","description":"Response message for AlertsHistoryAggregationRequest","title":"Alerts History Aggregation Response","x-displayname":"Alerts History Aggregation Response","x-ves-proto-message":"ves.io.schema.alert.AlertsHistoryAggregationResponse","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the alerts response. If the number of alerts that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregation data is key'ed with the aggregation name specified in the request.","title":"aggregations","x-displayname":"Aggregations"},"total_hits":{"type":"string","description":" total number of alerts that matched the query.\n\nExample: ` \"0\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"0"}}},"alertAlertsHistoryResponse":{"type":"object","description":"Response message for AlertsHistoryRequest/AlertsHistoryScrollRequest","title":"Alerts History Response","x-displayname":"Alerts History Response","x-ves-proto-message":"ves.io.schema.alert.AlertsHistoryResponse","properties":{"alerts":{"type":"array","description":" list of alerts that matched the filter. Contains no more than 500 alerts per response.\n\nExample: ` \"value\"`","title":"alerts","items":{"type":"string"},"x-displayname":"Alerts","x-ves-example":"value"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.\n Empty scroll_id indicates no more messages to scroll (EOF).\n Note: scroll_id is valid only for 2 minutes. i.e., If one intend to retrieve next batch of the result, then the\n       scroll request should be sent within 2 minutes upon receiving the response.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll_id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="},"total_hits":{"type":"string","description":" total number of alerts that matched the query.\n\nExample: ` \"100\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"100"}}},"alertAlertsHistoryScrollRequest":{"type":"object","description":"Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse\ncontaining no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the\nAlertsHistoryScrollRequest. Use the scroll_id returned in the AlertsHistoryResponse to fetch the next batch of alert messages and\none can continue this process till the scroll_id returned in the AlertsHistoryResponse is \"\" which indicates no more\nalert messages to scroll.","title":"Alerts History Scroll Request","x-displayname":"Alerts History Scroll Request","x-ves-proto-message":"ves.io.schema.alert.AlertsHistoryScrollRequest","properties":{"namespace":{"type":"string","description":" fetch the alerts scoped by namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of alert messages.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll_id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="}}},"alertCardinalityAggregation":{"type":"object","description":"x-displayName: \"Cardinality Aggregation\"\nGet approximate count of distinct values for the field in the alerts.","title":"Cardinality Aggregation","properties":{"field":{"$ref":"#/components/schemas/alertKeyField"}}},"alertDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate alerts based on timestamp in the alert","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket","title":"sub aggregation"}}},"alertDateSubAggregation":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\nAggregate alerts in each date bucket based on one of the sub aggregation types","title":"Date SubAggregation","properties":{"field_aggregation":{"$ref":"#/components/schemas/alertFieldAggregation"}}},"alertFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate alerts based on the key fields in the alert.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/alertKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"alertKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nAlerts can be aggregated based on these fields.\n\n - ALERTNAME: x-displayName: \"Alertname\"\n - IDENTIFIER: x-displayName: \"Identifier\"\n - GROUP: x-displayName: \"Group\"\n - SEVERITY: x-displayName: \"Severity\"\n - SITE: x-displayName: \"Site\"\n - STARTSAT: x-displayName: \"StartsAt\"\n - DESCRIPTION: x-displayName: \"Description\"","title":"Key Field","enum":["ALERTNAME","IDENTIFIER","GROUP","SEVERITY","SITE","STARTSAT","DESCRIPTION"],"default":"ALERTNAME"},"alertMultiFieldAggregation":{"type":"object","description":"x-displayName: \"MultiField Aggregation\"\nAggregate alerts based on the key fields in the alert.","title":"MultiField Aggregation","properties":{"fields":{"type":"array","description":"x-displayName: \"Field\"\nx-required\n\nField name by which the logs should be aggregated.","title":"field","items":{"$ref":"#/components/schemas/alertKeyField"}},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregations\"\nx-example: \"top hits sub aggregation\"\n\nThis option provides sub-aggregations for each field aggregation bucket.","title":"sub aggregations"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"alertMultiFieldSubAggregation":{"type":"object","description":"x-displayName: \"MultiFieldSubAggregation\"\nAggregate events in each field bucket based on one of the sub aggregation types","title":"MultiFieldSubAggregation","properties":{"top_hits_aggregation":{"$ref":"#/components/schemas/alertTopHitsAggregation"}}},"alertResponse":{"type":"object","description":"Returns list of alerts that matches the selection criteria in the request\nExample value:\n[\n {\n   \"annotations\": {\n     \"description\": \"string\",\n     \"additionalProp1\": \"string\",\n     \"additionalProp2\": \"string\"\n   },\n   \"receivers\": [\n     {\n       \"name\": \"string\"\n     }\n   ],\n   \"fingerprint\": \"string\",\n   \"startsAt\": \"2019-06-06T22:14:27.304Z\",\n   \"updatedAt\": \"2019-06-06T22:14:27.304Z\",\n   \"endsAt\": \"2019-06-06T22:14:27.304Z\",\n   \"status\": {\n     \"state\": \"unprocessed\",\n     \"silencedBy\": [\n      \"string\"\n    ],\n     \"inhibitedBy\": [\n       \"string\"\n     ]\n   },\n   \"labels\": {\n     \"alertname\": \"string\",\n     \"type\": \"string\",\n     \"identifier\": \"string\",\n     \"severity\": \"string\",\n     \"additionalLabel1\": \"string\",\n     \"additionalLabel2\": \"string\"\n   },\n   \"generatorURL\": \"string\"\n }\n]","title":"Alerts Response","x-displayname":"Alerts Response","x-ves-proto-message":"ves.io.schema.alert.Response","properties":{"data":{"type":"string","description":" data contains the list of alerts.\n\nExample: ` \"value\"`","title":"data","x-displayname":"Alerts","x-ves-example":"value"}}},"alertTopHitsAggregation":{"type":"object","description":"x-displayName: \"Top Hits Aggregation\"\nGet the top hits for a given field, with a given sorted order","title":"Top Hits Aggregation","properties":{"field":{"$ref":"#/components/schemas/alertKeyField"},"sort_ascending_order":{"type":"boolean","description":"x-displayName: \"Sort in Ascending Order\"\nx-example: true\n\nBoolean to decide the sorting order\nOptional: If not specified, descending order would be used","title":"sort_ascending_order","format":"boolean"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logAvgAggregationData":{"type":"object","description":"x-displayName: \"Avg Aggregation Data\"\nAverage Aggregation data","title":"AvgAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the average value of field","title":"value","format":"double"}}},"logCardinalityAggregationData":{"type":"object","description":"x-displayName: \"Cardinality Aggregation Data\"\nApproximate count of distinct values of the log field specified in the request.","title":"CardinalityAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of distinct values of a log field","title":"count","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregationBucket":{"type":"object","description":"x-displayName: \"Date Aggregation Bucket\"\nDate histogram bucket containing the timestamp and the number of logs in that bucket.","title":"DateAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the date bucket","title":"sub aggregation"},"time":{"type":"string","description":"x-displayName: \"Time\"\nx-example: 1578710280000\n\nunix timestamp","title":"time","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregationData":{"type":"object","description":"x-displayName: \"Date Aggregation Data\"\nDate aggregation data","title":"DateAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing timestamp and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logDateAggregationBucket"}},"step":{"type":"string","description":"x-displayName: \"Step\"\nx-example: \"30m\"\nActual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logDateSubAggregationData":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\n\nDate subaggregation data","title":"DateSubAggregationData","properties":{"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"}}},"logFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Aggregation Bucket\"\nField aggregation bucket containing field value and the number of logs.","title":"FieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"US\"","title":"key"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the field aggregation bucket","title":"sub aggregation"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Aggregation Data\"\nField Aggregation data","title":"FieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldAggregationBucket"}}}},"logFieldSubAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"}}},"logFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Field SubAggregation\"\nField subaggregation data","title":"FieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubAggregationBucket"}},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logFieldSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"}}},"logFieldSubFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Data\"\nField Aggregation data as Field Sub-aggregation","title":"FieldSubFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubFieldAggregationBucket"}}}},"logFilterAggregationData":{"type":"object","description":"x-displayName: \"Filter Aggregation Data\"\nFilter Aggregation Data","title":"FilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logFilterSubAggregationData":{"type":"object","description":"x-displayName: \"FilterSubAggregation\"\nFilter subaggregation data","title":"FilterSubAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFilterSubFieldAggregationBucket"}}}},"logFilterSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Filter Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FilterSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logLogAggregationData":{"type":"object","description":"x-displayName: \"Log Aggregation\"\nLog aggregation response data","title":"LogAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"date_aggregation":{"$ref":"#/components/schemas/logDateAggregationData"},"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logMaxAggregationData":{"type":"object","description":"x-displayName: \"Max Aggregation Data\"\nMax Aggregation data","title":"MaxAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the maximum value of field","title":"value","format":"double"}}},"logMetricsAggregationData":{"type":"object","description":"x-displayName: \"Metrics Aggregation\"\nMetrics aggregation data","title":"MetricsAggregationData","properties":{"percentile":{"$ref":"#/components/schemas/logPercentileAggregationData"}}},"logMinAggregationData":{"type":"object","description":"x-displayName: \"Min Aggregation Data\"\nMin Aggregation data","title":"MinAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the minimum value of field","title":"value","format":"double"}}},"logMultiFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Bucket\"\nMulti-Field aggregation bucket containing field values and the number of logs.","title":"MultiFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"keys":{"type":"object","description":"x-displayName: \"Keys\"\nKeys contain the name/value pair that identifies the unique combination of multiple key fields\nx-example: \"{\"SRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the multi field aggregation bucket","title":"sub aggregation"}}},"logMultiFieldAggregationData":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Data\"\nMulti-Field Aggregation data","title":"MultiFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logMultiFieldAggregationBucket"}}}},"logMultiFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Multi Field SubAggregation\"\nField subaggregation data","title":"MultiFieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"top_hits_aggregation":{"$ref":"#/components/schemas/logTopHitsAggregationData"}}},"logMultiFilterAggregationData":{"type":"object","description":"x-displayName: \"Multi Filter Aggregation Data\"\nMulti Filter Aggregation data","title":"MultiFilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"}}},"logOrderByData":{"type":"object","description":"x-displayName: \"Order by Data\"\nOrder by data","title":"OrderByData","properties":{"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"}}},"logPercentileAggregationData":{"type":"object","description":"x-displayName: \"Percentile Aggregation Data\"\nPercentile Aggregation data","title":"PercentileAggregationData","properties":{"key":{"type":"number","description":"x-displayName: \"Key\"\nx-example: 99.0","title":"key","format":"double"},"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the key percent","title":"value","format":"double"}}},"logTopHitsAggregationData":{"type":"object","description":"x-displayName: \"TopHits Aggregation Data\"\nTop Hits Aggregation Data.","title":"TopHitsAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of top hit values","title":"count","format":"uint64"},"documents":{"type":"array","description":"x-displayName: \"Documents\"\ndocument values","title":"documents","items":{"type":"string"}}}},"schemaTrendSentiment":{"type":"string","description":"x-displayName: \"Trend Sentiment\"\ntrend sentiment\n\n - TREND_SENTIMENT_NONE: x-displayName: \"None\"\n - TREND_SENTIMENT_POSITIVE: x-displayName: \"Positive\"\nIndicates trend sentiment is positive\n - TREND_SENTIMENT_NEGATIVE: x-displayName: \"Negative\"\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE"},"schemaTrendValue":{"type":"object","description":"x-displayName: \"Trend Value\"\nTrend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","properties":{"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"\ndescription of the method used to calculate trend.","title":"Description"},"previous_value":{"type":"string","description":"x-displayName: \"Previous Value\"\nx-example: \"200.00\"","title":"Previous Value"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"x-displayName: \"Value\"\nx-example: \"-15\"","title":"Value"}}}}}}