@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.data_delivery.receiver","description":"Data Delivery is used to specify a receiver (s3 bucket, etc.) for periodic delivery of customer/tenant data to customer sinks(destinations)","version":""},"paths":{"/api/data-intelligence/namespaces/{metadata.namespace}/receivers":{"post":{"summary":"Create Data Delivery","description":"Creates a new Data Delivery object","operationId":"ves.io.schema.shape.data_delivery.receiver.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/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/receiverCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-receiver-api-create"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.receiver.API.Create"},"x-displayname":"Data Delivery","x-ves-proto-service":"ves.io.schema.shape.data_delivery.receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data-intelligence/namespaces/{metadata.namespace}/receivers/{metadata.name}":{"put":{"summary":"Replace Data Delivery","description":"Replaces the content of an Data Delivery object","operationId":"ves.io.schema.shape.data_delivery.receiver.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/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/receiverReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-receiver-api-replace"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.receiver.API.Replace"},"x-displayname":"Data Delivery","x-ves-proto-service":"ves.io.schema.shape.data_delivery.receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/receivers":{"get":{"summary":"List Data Delivery","description":"List the set of receiver in a namespace","operationId":"ves.io.schema.shape.data_delivery.receiver.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/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 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-shape-data_delivery-receiver-api-list"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.receiver.API.List"},"x-displayname":"Data Delivery","x-ves-proto-service":"ves.io.schema.shape.data_delivery.receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/receivers/{name}":{"get":{"summary":"Get Data Delivery","description":"Get the Data Delivery object","operationId":"ves.io.schema.shape.data_delivery.receiver.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/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-shape-data_delivery-receiver-api-get"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.receiver.API.Get"},"delete":{"summary":"Delete Data Delivery","description":"Delete the specified receiver","operationId":"ves.io.schema.shape.data_delivery.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/receiverDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-receiver-api-delete"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.receiver.API.Delete"},"x-displayname":"Data Delivery","x-ves-proto-service":"ves.io.schema.shape.data_delivery.receiver.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Data Delivery","x-ves-proto-package":"ves.io.schema.shape.data_delivery.receiver","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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"}}},"receiverAuthToken":{"type":"object","description":"Authentication Token for access","title":"Token Authentication","x-displayname":"Access Token","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.AuthToken","properties":{"token":{"$ref":"#/components/schemas/schemaSecretType"}}},"receiverAzureBlobConfig":{"type":"object","description":"Azure Blob Configuration for Data Delivery","title":"Azur Blob Configuration","x-displayname":"Azure Blob Configuration","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.AzureBlobConfig","properties":{"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"compression":{"$ref":"#/components/schemas/receiverCompressionType"},"connection_string":{"$ref":"#/components/schemas/schemaSecretType"},"container_name":{"type":"string","description":" Container Name is the name of the container into which logs should be stored\n\nExample: ` \"logs\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 63\n  ves.io.schema.rules.string.min_len: 3\n  ves.io.schema.rules.string.pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$\n","title":"Container Name","minLength":3,"maxLength":63,"x-displayname":"Container Name","x-ves-example":"logs","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"63","ves.io.schema.rules.string.min_len":"3","ves.io.schema.rules.string.pattern":"^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$"}}}},"receiverAzureEventHubsConfig":{"type":"object","description":"x-displayName: \"Azure Event Hubs Configuration\"\nAzure Event Hubs Configuration for Data Delivery","title":"Azure Event Hubgs Configuration","properties":{"connection_string":{"$ref":"#/components/schemas/schemaSecretType"},"instance":{"type":"string","description":"x-displayName: \"Event Hubs Instance\"\nx-required\nx-example: \"logs\"\nEvent Hubs Instance name into which logs should be stored","title":"Event Hubs Instance"},"namespace":{"type":"string","description":"x-displayName: \"Event Hubs Namespace\"\nx-required\nx-example: \"myhub\"\nEvent Hubs Namespace is namespace with instance into which logs should be stored","title":"Event Hubs Namespace"}}},"receiverBatchOptionType":{"type":"object","description":"Batch Options allow tuning for how batches of logs are sent to an endpoint","title":"Batch Options","x-displayname":"Batch Options","x-ves-oneof-field-batch_bytes":"[\"max_bytes\",\"max_bytes_disabled\"]","x-ves-oneof-field-batch_events":"[\"max_events\",\"max_events_disabled\"]","x-ves-oneof-field-batch_timeout":"[\"default_timeout_seconds\",\"timeout_seconds\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.BatchOptionType","properties":{"default_timeout_seconds":{"$ref":"#/components/schemas/ioschemaEmpty"},"max_bytes":{"type":"integer","description":"Exclusive with [max_bytes_disabled]\n Send batch to endpoint after the batch is equal to or larger than this many bytes\n\nExample: ` \"16384\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 4096\n  ves.io.schema.rules.uint32.lte: 104857600\n","title":"Max Bytes","format":"int64","x-displayname":"Max Bytes","x-ves-example":"16384","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"4096","ves.io.schema.rules.uint32.lte":"104857600"}},"max_bytes_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"max_events":{"type":"integer","description":"Exclusive with [max_events_disabled]\n Send batch to endpoint after this many log messages are in the batch\n\nExample: ` \"200\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 32\n  ves.io.schema.rules.uint32.lte: 100000\n","title":"Max Events","format":"int64","x-displayname":"Max Events","x-ves-example":"200","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"32","ves.io.schema.rules.uint32.lte":"100000"}},"max_events_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"timeout_seconds":{"type":"string","description":"Exclusive with [default_timeout_seconds]\n Send batch to the endpoint after this many seconds\n\nExample: ` \"600\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 300-3600\n","title":"Timeout Seconds","format":"uint64","x-displayname":"Timeout Seconds","x-ves-example":"600","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"300-3600"}}}},"receiverCompressionType":{"type":"object","description":"Compression Type","title":"CompressionType","x-displayname":"Compression Type","x-ves-oneof-field-compression_choice":"[\"gzip_compression\",\"no_compression\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.CompressionType","properties":{"gzip_compression":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_compression":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"receiverCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of receiver","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/receiverCreateSpecType"}}},"receiverCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/receiverGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"receiverCreateSpecType":{"type":"object","description":"Creates a new Data Delivery object","title":"Create Data Delivery","x-displayname":"Create Data Delivery","x-ves-oneof-field-receiver":"[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.CreateSpecType","properties":{"azure_receiver":{"$ref":"#/components/schemas/receiverAzureBlobConfig"},"datadog_receiver":{"$ref":"#/components/schemas/receiverDatadogConfig"},"dataset_type":{"type":"string","description":" Select the Data Set\n\nExample: ` \"DI Advanced\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 128\n","maxLength":128,"x-displayname":"Data Set","x-ves-example":"DI Advanced","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"128"}},"gcp_bucket_receiver":{"$ref":"#/components/schemas/receiverGCPBucketConfig"},"http_receiver":{"$ref":"#/components/schemas/receiverHTTPConfig"},"s3_receiver":{"$ref":"#/components/schemas/receiverS3Config"},"splunk_receiver":{"$ref":"#/components/schemas/receiverSplunkConfig"}}},"receiverDatadogConfig":{"type":"object","description":"Configuration for Datadog endpoint","title":"Datadog Configuration","x-displayname":"Datadog Configuration","x-ves-oneof-field-endpoint_choice":"[\"endpoint\",\"site\"]","x-ves-oneof-field-tls_choice":"[\"no_tls\",\"use_tls\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.DatadogConfig","properties":{"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"compression":{"$ref":"#/components/schemas/receiverCompressionType"},"datadog_api_key":{"$ref":"#/components/schemas/schemaSecretType"},"endpoint":{"type":"string","description":"Exclusive with [site]\n Datadog Endpoint, example: `example.com:9000`\n\nExample: ` \"example.com:9000\"`","title":"Datadog Endpoint","x-displayname":"Datadog Endpoint","x-ves-example":"example.com:9000"},"no_tls":{"$ref":"#/components/schemas/ioschemaEmpty"},"site":{"type":"string","description":"Exclusive with [endpoint]\n Datadog Site, example: `datadoghq.com`\n\nExample: ` \"datadoghq.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname_or_ip: true\n","title":"Datadog Site","x-displayname":"Datadog Site","x-ves-example":"datadoghq.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname_or_ip":"true"}},"use_tls":{"$ref":"#/components/schemas/receiverTLSConfigType"}}},"receiverDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a receiver","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.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"}}},"receiverGCPBucketConfig":{"type":"object","description":"GCP Bucket Configuration for Global Log Receiver","title":"GCP Bucket Configuration","x-displayname":"GCP BucketConfiguration","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.GCPBucketConfig","properties":{"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"bucket":{"type":"string","description":" GCP Bucket Name\n\nExample: ` \"my-log-bucket\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 128\n  ves.io.schema.rules.string.min_len: 3\n  ves.io.schema.rules.string.pattern: ^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$\n","title":"GCP Bucket Name","minLength":3,"maxLength":128,"x-displayname":"GCP Bucket Name","x-ves-example":"my-log-bucket","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"128","ves.io.schema.rules.string.min_len":"3","ves.io.schema.rules.string.pattern":"^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$"}},"compression":{"$ref":"#/components/schemas/receiverCompressionType"},"gcp_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"receiverGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read receiver","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/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/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/receiverReplaceRequest"},"spec":{"$ref":"#/components/schemas/receiverGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/receiverStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"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"},"receiverGetSpecType":{"type":"object","description":"Get the Data Delivery object","title":"Get Data Delivery","x-displayname":"Get Data Delivery","x-ves-oneof-field-receiver":"[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.GetSpecType","properties":{"azure_receiver":{"$ref":"#/components/schemas/receiverAzureBlobConfig"},"datadog_receiver":{"$ref":"#/components/schemas/receiverDatadogConfig"},"dataset_type":{"type":"string","description":" Select the Data Set\n\nExample: ` \"DI Advanced\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 128\n","maxLength":128,"x-displayname":"Data Set","x-ves-example":"DI Advanced","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"128"}},"delivery_status":{"type":"string","description":" Delivery Status i.e Success/ Failed/ Pending\n\nExample: ` \"Pending\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]\n","x-displayname":"Delivery Status","x-ves-example":"Pending","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]"}},"frequency_seconds":{"type":"string","description":" Deliver logs at this frequency. Default is 5 min (300 seconds)\n\nExample: ` \"300\"`","format":"uint64","x-displayname":"Frequency","x-ves-example":"300"},"gcp_bucket_receiver":{"$ref":"#/components/schemas/receiverGCPBucketConfig"},"http_receiver":{"$ref":"#/components/schemas/receiverHTTPConfig"},"last_sent":{"type":"string","description":" The date when logs were last delivered to the customer\n\nExample: ` \"2021-09-21:44:34.171543432Z\"`","format":"date-time","x-displayname":"Last Sent","x-ves-example":"2021-09-21:44:34.171543432Z"},"receiver_state":{"type":"string","description":" State of the Receiver i.e Enabled/ Disabled\n\nExample: ` \"Enabled\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"Enabled\\\",\\\"Disabled\\\"]\n","x-displayname":"Receiver State","x-ves-example":"Enabled","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"Enabled\\\",\\\"Disabled\\\"]"}},"s3_receiver":{"$ref":"#/components/schemas/receiverS3Config"},"splunk_receiver":{"$ref":"#/components/schemas/receiverSplunkConfig"}}},"receiverHTTPConfig":{"type":"object","description":"Configuration for HTTP endpoint","title":"HTTP Configuration","x-displayname":"HTTP Configuration","x-ves-oneof-field-auth_choice":"[\"auth_basic\",\"auth_none\",\"auth_token\"]","x-ves-oneof-field-tls_choice":"[\"no_tls\",\"use_tls\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.HTTPConfig","properties":{"auth_basic":{"$ref":"#/components/schemas/receiverHttpAuthBasic"},"auth_none":{"$ref":"#/components/schemas/ioschemaEmpty"},"auth_token":{"$ref":"#/components/schemas/receiverAuthToken"},"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"compression":{"$ref":"#/components/schemas/receiverCompressionType"},"no_tls":{"$ref":"#/components/schemas/ioschemaEmpty"},"uri":{"type":"string","description":" HTTP Uri is the Uri of the HTTP endpoint to send logs to, example: `http://example.com:9000/logs`\n\nExample: ` \"http://example.com:9000/logs\"`\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":"HTTP Uri","x-displayname":"HTTP Uri","x-ves-example":"http://example.com:9000/logs","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"use_tls":{"$ref":"#/components/schemas/receiverTLSConfigType"}}},"receiverHttpAuthBasic":{"type":"object","description":"Authentication parameters to access HTTP Log Receiver Endpoint.","title":"HTTP Basic Authentication","x-displayname":"Basic Authentication Credentials","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.HttpAuthBasic","properties":{"password":{"$ref":"#/components/schemas/schemaSecretType"},"user_name":{"type":"string","description":" HTTP Basic Auth User Name\n\nExample: ` \"Joe\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"username","maxLength":64,"x-displayname":"User Name","x-ves-example":"Joe","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}}}},"receiverListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of receiver","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.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/receiverListResponseItem"},"x-displayname":"Items"}}},"receiverListResponseItem":{"type":"object","description":"By default a summary of 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 receiver","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this receiver","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this receiver","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates receiver is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/receiverGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this receiver","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this 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/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 receiver\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"receiverReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a receiver","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/receiverReplaceSpecType"}}},"receiverReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.ReplaceResponse"},"receiverReplaceSpecType":{"type":"object","description":"Replaces the content of an Data Delivery object","title":"Replace Log Receiver","x-displayname":"Replace Data Delivery","x-ves-oneof-field-receiver":"[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.ReplaceSpecType","properties":{"azure_receiver":{"$ref":"#/components/schemas/receiverAzureBlobConfig"},"datadog_receiver":{"$ref":"#/components/schemas/receiverDatadogConfig"},"dataset_type":{"type":"string","description":" Select the Data Set\n\nExample: ` \"DI Advanced\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 128\n","maxLength":128,"x-displayname":"Data Set","x-ves-example":"DI Advanced","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"128"}},"gcp_bucket_receiver":{"$ref":"#/components/schemas/receiverGCPBucketConfig"},"http_receiver":{"$ref":"#/components/schemas/receiverHTTPConfig"},"s3_receiver":{"$ref":"#/components/schemas/receiverS3Config"},"splunk_receiver":{"$ref":"#/components/schemas/receiverSplunkConfig"}}},"receiverS3Config":{"type":"object","description":"S3 Configuration for Data Delivery","title":"S3 Configuration","x-displayname":"S3 Configuration","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.S3Config","properties":{"aws_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"aws_region":{"type":"string","description":" AWS Region Name\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]\n","title":"AWS Region","x-displayname":"AWS Region","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]"}},"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"bucket":{"type":"string","description":" S3 Bucket Name\n\nExample: ` \"my-bucket\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 128\n  ves.io.schema.rules.string.min_len: 3\n  ves.io.schema.rules.string.pattern: ^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$\n","title":"S3 Bucket Name","minLength":3,"maxLength":128,"x-displayname":"S3 Bucket Name","x-ves-example":"my-bucket","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"128","ves.io.schema.rules.string.min_len":"3","ves.io.schema.rules.string.pattern":"^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$"}},"compression":{"$ref":"#/components/schemas/receiverCompressionType"}}},"receiverSplunkConfig":{"type":"object","description":"Configuration for Splunk HEC Logs endpoint","title":"Splunk HEC Logs Configuration","x-displayname":"Splunk HEC Logs Configuration","x-ves-oneof-field-tls_choice":"[\"no_tls\",\"use_tls\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.SplunkConfig","properties":{"batch":{"$ref":"#/components/schemas/receiverBatchOptionType"},"compression":{"$ref":"#/components/schemas/receiverCompressionType"},"endpoint":{"type":"string","description":" Splunk HEC Logs Endpoint, example: `https://http-input-hec.splunkcloud.com`\n\nExample: ` \"https://http-inputs-hec.splunkcloud.com\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Splunk HEC Logs Endpoint","x-displayname":"Splunk HEC Logs Endpoint","x-ves-example":"https://http-inputs-hec.splunkcloud.com","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"no_tls":{"$ref":"#/components/schemas/ioschemaEmpty"},"splunk_hec_token":{"$ref":"#/components/schemas/schemaSecretType"},"use_tls":{"$ref":"#/components/schemas/receiverTLSConfigType"}}},"receiverStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Data Delivery Status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.shape.data_delivery.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/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"receiverTLSClientConfigType":{"type":"object","description":"mTLS Client config allows configuration of mtls client options","title":"mTLS Client config","x-displayname":"mTLS Client Config","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.TLSClientConfigType","properties":{"certificate":{"type":"string","description":" Client  certificate is PEM-encoded certificate or certificate-chain.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","maxLength":131072,"x-displayname":"Client Certificate","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}},"key_url":{"$ref":"#/components/schemas/schemaSecretType"}}},"receiverTLSConfigType":{"type":"object","description":"TLS Parameters for client connection to the endpoint","title":"Endpoint TLS Parameters","x-displayname":"TLS Parameters Endpoint","x-ves-oneof-field-ca_choice":"[\"no_ca\",\"trusted_ca_url\"]","x-ves-oneof-field-mtls_choice":"[\"mtls_disabled\",\"mtls_enable\"]","x-ves-oneof-field-verify_certificate":"[\"disable_verify_certificate\",\"enable_verify_certificate\"]","x-ves-oneof-field-verify_hostname":"[\"disable_verify_hostname\",\"enable_verify_hostname\"]","x-ves-proto-message":"ves.io.schema.shape.data_delivery.receiver.TLSConfigType","properties":{"disable_verify_certificate":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_verify_hostname":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_verify_certificate":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_verify_hostname":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtls_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mtls_enable":{"$ref":"#/components/schemas/receiverTLSClientConfigType"},"no_ca":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_ca_url":{"type":"string","description":"Exclusive with [no_ca]\n The URL or value for trusted Server CA certificate or certificate chain\n Certificates in PEM format including the PEM headers.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Server CA certificates","maxLength":131072,"x-displayname":"Server CA Certificates","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"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"}}},"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"}}},"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"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.data_delivery","description":"Custom handler in Data Delivery microservice will forward request(s) to backend API(s)","version":""},"paths":{"/api/data-intelligence/namespaces/system/dataSets":{"get":{"summary":"Get Data Sets","description":"Get the list of data sets eligible for the tenant","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.GetDataSets","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryGetDataSetsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-getdatasets"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.GetDataSets"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/system/datadictionary/{dataset}":{"get":{"summary":"Get Data Dictionary","description":"Get the dataset features from Data dictionary API","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.GetDataDictionary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryGetDataDictionaryResponse"}}}},"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":"dataset","description":"dataset\n\nx-example: \"di_advanced\"\nidentifier to request the dataset features","in":"path","required":true,"x-displayname":"Dataset","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-getdatadictionary"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.GetDataDictionary"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/system/init-request":{"post":{"summary":"Enable Data Intelligence","description":"Request to enable Data Intelligence for the tenant","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.Init","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaEmpty"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-init"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.Init"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/data-dictionary/datasets":{"get":{"summary":"List DataSets","description":"API to list datasets by tenant","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.ListDataSets","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryListDataSetsResponse"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-listdatasets"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.ListDataSets"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/di/flowlabels":{"get":{"summary":"List FlowLabels","description":"ListFlowLabels takes a customer name and returns a list of FlowLabel objects","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.ListFlowLabels","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryListFlowLabelsResponse"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-listflowlabels"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.ListFlowLabels"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/di/summary":{"post":{"summary":"Load Executive Summary","description":"Executive summary page for DI premium customers","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.LoadExecutiveSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryLoadExecutiveSummaryResponse"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryLoadExecutiveSummaryRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-loadexecutivesummary"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.LoadExecutiveSummary"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/receivers/{id}/status":{"post":{"summary":"Update Status of Receiver","description":"Update receiver object status from enable to disable and vice versa","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.UpdateReceiverStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryUpdateReceiverStatusResponse"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"splunk-cloud-receiver\"\nReceiver Name","in":"path","required":true,"x-displayname":"Receiver ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryUpdateReceiverStatusRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-updatereceiverstatus"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.UpdateReceiverStatus"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/receivers/{id}/test":{"post":{"summary":"Test Receiver","description":"API to test receiver destination sink connection","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.TestReceiver","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryTestReceiverResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace in which the receiver is configured","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"id\n\nx-example: \"splunk-cloud-receiver\"\nReceiver Name","in":"path","required":true,"x-displayname":"Receiver ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_deliveryTestReceiverRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-testreceiver"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.TestReceiver"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data-intelligence/namespaces/{namespace}/suggest-values":{"post":{"summary":"Suggest Values","description":"Returns suggested values for the specified field in the given Create/Replace/Custom request","operationId":"ves.io.schema.shape.data_delivery.CustomAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSuggestValuesResp"}}}},"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: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSuggestValuesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-data_delivery-customapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.shape.data_delivery.CustomAPI.SuggestValues"},"x-displayname":"Data Delivery APIs","x-ves-proto-service":"ves.io.schema.shape.data_delivery.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Data Delivery APIs","x-ves-proto-package":"ves.io.schema.shape.data_delivery","components":{"schemas":{"data_deliveryDataPoint":{"type":"object","description":"Message object representing data point","title":"DataPoint","x-displayname":"Data Point","x-ves-proto-message":"ves.io.schema.shape.data_delivery.DataPoint","properties":{"timestamp":{"type":"string","description":" Unix timestamp (seconds since epoch)","title":"Timestamp","format":"int64","x-displayname":"Timestamp"},"value":{"type":"number","description":" Value at the given timestamp","title":"Value","format":"double","x-displayname":"Value"}}},"data_deliveryDataSet":{"type":"object","description":"Represents the dataset details","title":"DataSet","x-displayname":"DataSet","x-ves-proto-message":"ves.io.schema.shape.data_delivery.DataSet","properties":{"description":{"type":"string","description":" Detailed description of the dataset","title":"Description","x-displayname":"Description"},"id":{"type":"string","description":" Unique string id for the dataset\n\nExample: ` \"di-advanced-bot\"`","title":"DataSet ID","x-displayname":"DataSet ID","x-ves-example":"di-advanced-bot"},"name":{"type":"string","description":" name of the dataset\n\nExample: ` \"string\"`","title":"Name","x-displayname":"Name","x-ves-example":"string"},"status":{"type":"string","description":" Information to suggest if the dataset is currently subscribed by the tenant\n\nExample: ` \"subscribed\"`","title":"Status","x-displayname":"Status","x-ves-example":"subscribed"}}},"data_deliveryEventsReason":{"type":"object","description":"Message object representing events reason","title":"EventsReason","x-displayname":"Events Reason","x-ves-proto-message":"ves.io.schema.shape.data_delivery.EventsReason","properties":{"category":{"type":"string","description":" string representing event category\n\nExample: ` \"DeviceID\"`","title":"Category","x-displayname":"Category","x-ves-example":"DeviceID"},"eventsCount":{"type":"integer","description":" number of such events","title":"EventsCount","format":"int64","x-displayname":"Events Count"},"eventsPercentage":{"type":"number","description":" number of such events percentage","title":"EventsPercentage","format":"double","x-displayname":"Events Percentage"},"reason":{"type":"string","description":" string representing event reason\n\nExample: ` \"High Distinct Local Cache ID Volume\"`","title":"Reason","x-displayname":"Reason","x-ves-example":"High Distinct Local Cache ID Volume"}}},"data_deliveryFeature":{"type":"object","description":"Definition of feature which is unit of dataset","title":"Feature","x-displayname":"Feature","x-ves-proto-message":"ves.io.schema.shape.data_delivery.Feature","properties":{"data_format":{"type":"string","description":"\n\nExample: ` \"string\"`","title":"Data format","x-displayname":"Data format","x-ves-example":"string"},"description":{"type":"string","description":" Detailed description of the feature","title":"Description  \nx-displayName: \"Description\"\nDetailed description of the feature","x-displayname":"Description"},"feature_name":{"type":"string","description":" Name of the feature","title":"feature name","x-displayname":"Feature Name"},"is_new_field":{"type":"boolean","description":" Information to suggest if this is existing or new feature in dataset","title":"IsNewField","format":"boolean","x-displayname":"IsNewField"},"notes":{"type":"string","description":" Additional notes about the dataset feature","title":"Notes","x-displayname":"Notes"},"required":{"type":"boolean","description":" Is the feature mandatory or optional ","title":"Required","format":"boolean","x-displayname":"Required"}}},"data_deliveryFlowLabel":{"type":"object","description":"message representing flow label information","title":"FlowLabel","x-displayname":"Flow Label","x-ves-proto-message":"ves.io.schema.shape.data_delivery.FlowLabel","properties":{"flowLabel":{"type":"string","description":" flowLabel for filtering the data\n\nExample: ` \"Login\"`","title":"FlowLabel","x-displayname":"Flow Label","x-ves-example":"Login"},"platform":{"type":"string","description":" platform for filtering the data","title":"Platform","x-displayname":"Platform"}}},"data_deliveryGetDataDictionaryResponse":{"type":"object","description":"dataset feature fetched  by data dictionary API","title":"GetDataDictionaryResponse","x-displayname":"Dataset feature","x-ves-proto-message":"ves.io.schema.shape.data_delivery.GetDataDictionaryResponse","properties":{"feature_list":{"type":"array","description":"List of features for requested dataset","title":"Feature list","items":{"$ref":"#/components/schemas/data_deliveryFeature"},"x-displayname":"Feature List"}}},"data_deliveryGetDataSetsResponse":{"type":"object","description":"x-example: \"DI Advanced\"\nList of Data Sets eligible for the tenant","title":"GetDataSetsResponse","x-displayname":"Data Set","x-ves-proto-message":"ves.io.schema.shape.data_delivery.GetDataSetsResponse","properties":{"dataSets":{"type":"array","items":{"type":"string"}}}},"data_deliveryLineChartData":{"type":"object","description":"Message object representing line chart data","title":"LineChartData","x-displayname":"Line Chart Data","x-ves-proto-message":"ves.io.schema.shape.data_delivery.LineChartData","properties":{"granularity":{"type":"string","description":" Granularity of the data points (\"1m\", \"5m\", etc.)\n\nExample: ` \"5m\"`","title":"Granularity","x-displayname":"Granularity","x-ves-example":"5m"},"series":{"type":"array","description":" Array of data series","title":"Series","items":{"$ref":"#/components/schemas/data_deliverySeries"},"x-displayname":"Series"}}},"data_deliveryListDataSetsResponse":{"type":"object","description":"Response of list datasets by tenant","title":"ListDataSetsResponse","x-displayname":"List DataSets Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.ListDataSetsResponse","properties":{"dataset_list":{"type":"array","description":"List of datasets for tenant","title":"DataSet list","items":{"$ref":"#/components/schemas/data_deliveryDataSet"},"x-displayname":"DataSet List"}}},"data_deliveryListFlowLabelsResponse":{"type":"object","description":"Response object to list flow labels","title":"ListFlowLabelsResponse","x-displayname":"List FlowLabels Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.ListFlowLabelsResponse","properties":{"flowLabels":{"type":"array","description":" flow labels","title":"FlowLabels","items":{"$ref":"#/components/schemas/data_deliveryFlowLabel"},"x-displayname":"FlowLabels"}}},"data_deliveryLoadExecutiveSummaryRequest":{"type":"object","description":"Request object to get executive summary of DI premium customer","title":"LoadExecutiveSummaryRequest","x-displayname":"Load Executive Summary Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.LoadExecutiveSummaryRequest","properties":{"anomalousScorePercentile":{"type":"number","description":" Percentile of anomalous score.","title":"AnomalousScorePercentile","format":"double","x-displayname":"AnomalousScorePercentile"},"flowLabels":{"type":"array","description":" flowLabel for filtering the data","title":"FlowLabels","items":{"$ref":"#/components/schemas/data_deliveryFlowLabel"},"x-displayname":"Flow Labels"},"granularity":{"type":"string","description":" Granularity of the data points (\"1m\", \"5m\", etc.)\n\nExample: ` \"5m\"`","title":"Granularity","x-displayname":"Granularity","x-ves-example":"5m"},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"platform":{"type":"string","description":" platform criteria for filtering the data\n\nExample: ` \"mobile\"`","title":"Platform","x-displayname":"Platform","x-ves-example":"mobile"},"timeRange":{"type":"string","description":" Time range (\"1h\", \"7d\", etc.)\n\nExample: ` \"1h\"`","title":"TimeRange","x-displayname":"Time Range","x-ves-example":"1h"},"timestamp":{"type":"string","description":" Unix timestamp (seconds since epoch)","title":"Timestamp","format":"int64","x-displayname":"Timestamp"}}},"data_deliveryLoadExecutiveSummaryResponse":{"type":"object","description":"Response object to get executive summary of DI premium customer","title":"LoadExecutiveSummaryResponse","x-displayname":"Load Executive Summary Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.LoadExecutiveSummaryResponse","properties":{"eventsReasons":{"type":"array","description":" message representing the transaction data\n\nExample: ` \"high attempt value , high success volume\"`","title":"EventsReason","items":{"$ref":"#/components/schemas/data_deliveryEventsReason"},"x-displayname":"Events Reason","x-ves-example":"high attempt value , high success volume"},"lineChartData":{"$ref":"#/components/schemas/data_deliveryLineChartData"},"summary":{"$ref":"#/components/schemas/data_deliverySummaryPanel"}}},"data_deliverySeries":{"type":"object","description":"Message object representing series","title":"Series","x-displayname":"Series","x-ves-proto-message":"ves.io.schema.shape.data_delivery.Series","properties":{"data":{"type":"array","description":" Array of data points","title":"DataPoint","items":{"$ref":"#/components/schemas/data_deliveryDataPoint"},"x-displayname":"Data Point"},"name":{"type":"string","description":" Name of the series (\"typical\", \"bot\", \"anomalous\")\n\nExample: ` \"bot\"`","title":"Name","x-displayname":"Name","x-ves-example":"bot"}}},"data_deliverySummaryPanel":{"type":"object","description":"Message object representing summary panel","title":"SummaryPanel","x-displayname":"Summary Panel","x-ves-proto-message":"ves.io.schema.shape.data_delivery.SummaryPanel","properties":{"anomalousDevices":{"type":"integer","description":" Number of devices identified as anomalous.","title":"AnomalousDevices","format":"int64","x-displayname":"Anomalous Devices"},"anomalousDevicesPercentage":{"type":"number","description":" Percentage of anomalous devices over total evaluated devices.","title":"AnomalousDevicesPercentage","format":"double","x-displayname":"Anomalous Devices Percentage"},"anomalousMaxScore":{"type":"number","description":" Max anomalous score","title":"AnomalousMaxScore","format":"double","x-displayname":"Anomalous Max Score"},"anomalousMinScore":{"type":"number","description":" Min anomalous score","title":"AnomalousMinScore","format":"double","x-displayname":"Anomalous Min Score"},"anomalousPercentage":{"type":"number","description":" Percentage of anomalous transactions over total evaluated transactions.","title":"AnomalousPercentage","format":"double","x-displayname":"Anomalous Percentage"},"anomalousTransactions":{"type":"integer","description":" Number of transactions identified as anomalous.","title":"anomalousTransactions","format":"int64","x-displayname":"Anomalous Transactions"},"botPercentage":{"type":"number","description":" Percentage of bot transactions over total evaluated transactions.","title":"BotPercentage","format":"double","x-displayname":"Bot Percentage"},"botTransactions":{"type":"integer","description":" Number of transactions identified as bots.","title":"BotTransactions","format":"int64","x-displayname":"Bot Transactions"},"totalEvaluatedDevices":{"type":"integer","description":" Total number of evaluated devices.","title":"TotalEvaluatedDevices","format":"int64","x-displayname":"Total Evaluated Devices"},"totalEvaluatedTransactions":{"type":"integer","description":" Total number of evaluated transactions.","title":"TotalEvaluatedTransactions","format":"int64","x-displayname":"Total Evaluated Transactions"}}},"data_deliveryTestReceiverRequest":{"type":"object","description":"Request to test receiver & destination sink","title":"Test Receiver Request","x-displayname":"Test Receiver Request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.TestReceiverRequest","properties":{"id":{"type":"string","description":" Receiver Name\n\nExample: ` \"splunk-cloud-receiver\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.not_empty: true\n","title":"id","x-displayname":"Receiver ID","x-ves-example":"splunk-cloud-receiver","x-ves-validation-rules":{"ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace in which the receiver is configured\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"data_deliveryTestReceiverResponse":{"type":"object","description":"Response for the Receiver test request; empty because the only returned\ninformation is error message.","title":"Test Receiver Response","x-displayname":"Test Receiver Response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.TestReceiverResponse","properties":{"message":{"type":"string","description":" The error string if the status is failed\n\nExample: ` \"Credentials invalid\"`","title":"message","x-displayname":"Message","x-ves-example":"Credentials invalid"},"status":{"$ref":"#/components/schemas/data_deliveryTestReceiverStatusType"}}},"data_deliveryTestReceiverStatusType":{"type":"string","description":"Test Receiver connection status\n\nThe receiver credentials & settings has been tested and the connection has been validated\nThere is error when trying to test the connection for destination sink with given credentials","title":"TestReceiverStatusType","enum":["SUCCESS","FAILED"],"default":"SUCCESS","x-displayname":"Test Receiver Status Type","x-ves-proto-enum":"ves.io.schema.shape.data_delivery.TestReceiverStatusType"},"data_deliveryUpdateReceiverStatusRequest":{"type":"object","description":"Request to update","title":"UpdateReceiverStatusRequest","x-displayname":"Update Receiver status request","x-ves-proto-message":"ves.io.schema.shape.data_delivery.UpdateReceiverStatusRequest","properties":{"id":{"type":"string","description":" Receiver Name\n\nExample: ` \"splunk-cloud-receiver\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.not_empty: true\n","title":"id","x-displayname":"Receiver ID","x-ves-example":"splunk-cloud-receiver","x-ves-validation-rules":{"ves.io.schema.rules.string.not_empty":"true"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"type":{"$ref":"#/components/schemas/shapedata_deliveryStatusType"}}},"data_deliveryUpdateReceiverStatusResponse":{"type":"object","description":"Payload about status of receiver status result","title":"UpdateReceiverStatusResponse","x-displayname":"Update Receiver status response","x-ves-proto-message":"ves.io.schema.shape.data_delivery.UpdateReceiverStatusResponse","properties":{"id":{"type":"string","description":" Id of the receiver\n\nExample: ` \"splunk-cloud-receiver\"`","title":"id","x-displayname":"Receiver ID","x-ves-example":"splunk-cloud-receiver"},"receiver_name":{"type":"string","description":" name of the receiver configured by the customer\n\nExample: ` \"splunk-cloud-receiver\"`","title":"receiver_name","x-displayname":"Receiver Name","x-ves-example":"splunk-cloud-receiver"},"status":{"type":"string","description":" values: not_modified , success\n Status about receiver status modification\n\nExample: ` \"not_modified\"`","title":"status","x-displayname":"Status","x-ves-example":"not_modified"}}},"namespaceSuggestValuesReq":{"type":"object","description":"Request body of SuggestValues request","title":"SuggestValuesReq","x-displayname":"Request for SuggestValues","x-ves-proto-message":"ves.io.schema.namespace.SuggestValuesReq","properties":{"field_path":{"type":"string","description":" JSON path of the field for which the suggested values are being requested.\n\nExample: ` \"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"field_path","maxLength":1024,"x-displayname":"Field Path","x-ves-example":"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"match_value":{"type":"string","description":" A substring that must be present in either the value or description of each SuggestedItem in the response.\n\nExample: ` \"some-substring\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"match_value","maxLength":256,"x-displayname":"Match Value","x-ves-example":"some-substring","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"request_body":{"$ref":"#/components/schemas/protobufAny"}}},"namespaceSuggestValuesResp":{"type":"object","description":"Response body of SuggestValues request","title":"SuggestValuesResp","x-displayname":"Response for SuggestValues","x-ves-proto-message":"ves.io.schema.namespace.SuggestValuesResp","properties":{"items":{"type":"array","description":" List of suggested items.","title":"item_lists","items":{"$ref":"#/components/schemas/namespaceSuggestedItem"},"x-displayname":"Suggested Items"}}},"namespaceSuggestedItem":{"type":"object","description":"A tuple with a suggested value and it's description.","title":"SuggestedItem","x-displayname":"Suggested Item","x-ves-oneof-field-value_choice":"[\"ref_value\",\"str_value\"]","x-ves-proto-message":"ves.io.schema.namespace.SuggestedItem","properties":{"description":{"type":"string","description":" Optional description for the suggested value.","title":"description","x-displayname":"Description"},"ref_value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"str_value":{"type":"string","description":"Exclusive with [ref_value]\n","title":"str_value","x-displayname":"String"},"title":{"type":"string","description":" Optional title to be displayed instead of the actual value.\n Used when pure value doesn't contain all the needed information to be displayed,\n or when display titles should be customized.","title":"title","x-displayname":"Title"},"value":{"type":"string","description":" Suggested value for the field.\n Should use value_choice.str_value instead.","title":"value","x-displayname":"Value"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaEmpty":{"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"},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"shapedata_deliveryStatusType":{"type":"string","description":"Type of Status\n\n - DISABLE: DISABLE\n\nDisable Receiver\n - ENABLE: ENABLE\n\nEnable Receiver","title":"StatusType","enum":["DISABLE","ENABLE"],"default":"DISABLE","x-displayname":"Status type","x-ves-proto-enum":"ves.io.schema.shape.data_delivery.StatusType"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0094.public.ves.io.schema.bigcne.data_group.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.bigcne.data_group","description":"A data group is a group of related items - IP addresses/subnets, strings, or integers that can be referenced in iRules.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/data_groups":{"post":{"summary":"Create Data group","description":"Create data group in a given namespace. If one already exists it will give an error.","operationId":"ves.io.schema.bigcne.data_group.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-bigcne-data_group-api-create"},"x-ves-proto-rpc":"ves.io.schema.bigcne.data_group.API.Create"},"x-displayname":"Data Group","x-ves-proto-service":"ves.io.schema.bigcne.data_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/data_groups/{metadata.name}":{"put":{"summary":"Replace Data Group","description":"Replace Data Group in a given namespace.","operationId":"ves.io.schema.bigcne.data_group.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-bigcne-data_group-api-replace"},"x-ves-proto-rpc":"ves.io.schema.bigcne.data_group.API.Replace"},"x-displayname":"Data Group","x-ves-proto-service":"ves.io.schema.bigcne.data_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/data_groups":{"get":{"summary":"List Data Group","description":"List the set of data_group in a namespace","operationId":"ves.io.schema.bigcne.data_group.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of data_group","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-bigcne-data_group-api-list"},"x-ves-proto-rpc":"ves.io.schema.bigcne.data_group.API.List"},"x-displayname":"Data Group","x-ves-proto-service":"ves.io.schema.bigcne.data_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/data_groups/{name}":{"get":{"summary":"Get Data Group","description":"Get Data Group details.","operationId":"ves.io.schema.bigcne.data_group.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-bigcne-data_group-api-get"},"x-ves-proto-rpc":"ves.io.schema.bigcne.data_group.API.Get"},"delete":{"summary":"Delete Data Group","description":"Delete the specified data_group","operationId":"ves.io.schema.bigcne.data_group.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_groupDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-bigcne-data_group-api-delete"},"x-ves-proto-rpc":"ves.io.schema.bigcne.data_group.API.Delete"},"x-displayname":"Data Group","x-ves-proto-service":"ves.io.schema.bigcne.data_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Data Group","x-ves-proto-package":"ves.io.schema.bigcne.data_group","components":{"schemas":{"bigcnedata_groupCreateSpecType":{"type":"object","description":"Create data group in a given namespace. If one already exists it will give an error.","title":"Create Data Group","x-displayname":"Create Data group","x-ves-oneof-field-data_group_type":"[\"address_records\",\"integer_records\",\"string_records\"]","x-ves-proto-message":"ves.io.schema.bigcne.data_group.CreateSpecType","properties":{"address_records":{"$ref":"#/components/schemas/data_groupAddressRecords"},"integer_records":{"$ref":"#/components/schemas/data_groupIntegerRecords"},"string_records":{"$ref":"#/components/schemas/data_groupStringRecords"}}},"bigcnedata_groupGetSpecType":{"type":"object","description":"Get Data Group details.","title":"Get Data Group","x-displayname":"Get Data Group","x-ves-oneof-field-data_group_type":"[\"address_records\",\"integer_records\",\"string_records\"]","x-ves-proto-message":"ves.io.schema.bigcne.data_group.GetSpecType","properties":{"address_records":{"$ref":"#/components/schemas/data_groupAddressRecords"},"integer_records":{"$ref":"#/components/schemas/data_groupIntegerRecords"},"string_records":{"$ref":"#/components/schemas/data_groupStringRecords"}}},"bigcnedata_groupReplaceSpecType":{"type":"object","description":"Replace Data Group in a given namespace.","title":"Replace Data Group","x-displayname":"Replace Data Group","x-ves-oneof-field-data_group_type":"[\"address_records\",\"integer_records\",\"string_records\"]","x-ves-proto-message":"ves.io.schema.bigcne.data_group.ReplaceSpecType","properties":{"address_records":{"$ref":"#/components/schemas/data_groupAddressRecords"},"integer_records":{"$ref":"#/components/schemas/data_groupIntegerRecords"},"string_records":{"$ref":"#/components/schemas/data_groupStringRecords"}}},"data_groupAddressRecords":{"type":"object","description":"Data group with address record List","title":"Address record List","x-displayname":"Address Record","x-ves-proto-message":"ves.io.schema.bigcne.data_group.AddressRecords","properties":{"records":{"type":"object","description":"\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.ip: true\n  ves.io.schema.rules.map.max_pairs: 4096\n  ves.io.schema.rules.map.values.string.pattern: ^[0-9a-zA-Z._-]*$\n","title":"Address records","x-displayname":"Address records","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.ip":"true","ves.io.schema.rules.map.max_pairs":"4096","ves.io.schema.rules.map.values.string.pattern":"^[0-9a-zA-Z._-]*$"}}}},"data_groupCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of data_group","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.bigcne.data_group.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/bigcnedata_groupCreateSpecType"}}},"data_groupCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.bigcne.data_group.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/bigcnedata_groupGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"data_groupDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a data_group","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.bigcne.data_group.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"data_groupGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read data_group","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.bigcne.data_group.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/data_groupCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/data_groupReplaceRequest"},"spec":{"$ref":"#/components/schemas/bigcnedata_groupGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"data_groupGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"data_groupIntegerRecords":{"type":"object","description":"Data group with integer record List","title":"Integer record List","x-displayname":"Integer record List","x-ves-proto-message":"ves.io.schema.bigcne.data_group.IntegerRecords","properties":{"records":{"type":"object","description":"\n\nValidation Rules:\n  ves.io.schema.rules.map.max_pairs: 4096\n  ves.io.schema.rules.map.values.string.pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$\n","title":"Integer records","x-displayname":"Integer records","x-ves-validation-rules":{"ves.io.schema.rules.map.max_pairs":"4096","ves.io.schema.rules.map.values.string.pattern":"^[a-zA-Z_][a-zA-Z0-9_]*$"}}}},"data_groupListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of data_group","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.bigcne.data_group.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/data_groupListResponseItem"},"x-displayname":"Items"}}},"data_groupListResponseItem":{"type":"object","description":"By default a summary of data_group is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of data_group","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.bigcne.data_group.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this data_group","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this data_group","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates data_group is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/bigcnedata_groupGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this data_group","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this data_group\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this data_group\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"data_groupReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a data_group","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.bigcne.data_group.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/bigcnedata_groupReplaceSpecType"}}},"data_groupReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.bigcne.data_group.ReplaceResponse"},"data_groupStringRecords":{"type":"object","description":"Data group with strings record List","title":"Strings record List","x-displayname":"String record List","x-ves-proto-message":"ves.io.schema.bigcne.data_group.StringRecords","properties":{"records":{"type":"object","description":"\n\nValidation Rules:\n  ves.io.schema.rules.map.max_pairs: 4096\n  ves.io.schema.rules.map.values.string.pattern: ^[0-9a-zA-Z._-]*$\n","title":"String records","x-displayname":"String records","x-ves-validation-rules":{"ves.io.schema.rules.map.max_pairs":"4096","ves.io.schema.rules.map.values.string.pattern":"^[0-9a-zA-Z._-]*$"}}}},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}}}}}