@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.report_config","description":"Report configuration contains the information like\n\n    List of namespaces for which the report should be generated.\n    Frequency of report generation.\n    Time at which the report should be generated","version":""},"paths":{"/api/report/namespaces/{metadata.namespace}/report_configs":{"post":{"summary":"Create Report Configuration","description":"Report configuration is used to schedule report generation at a later point in time.","operationId":"ves.io.schema.report_config.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configCreateResponse"}}}},"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/report_configCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-api-create"},"x-ves-proto-rpc":"ves.io.schema.report_config.API.Create"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/report/namespaces/{metadata.namespace}/report_configs/{metadata.name}":{"put":{"summary":"Replace Report Configuration","description":"Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.","operationId":"ves.io.schema.report_config.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configReplaceResponse"}}}},"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/report_configReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-api-replace"},"x-ves-proto-rpc":"ves.io.schema.report_config.API.Replace"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs":{"get":{"summary":"List Report Configuration","description":"List the set of report_config in a namespace","operationId":"ves.io.schema.report_config.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configListResponse"}}}},"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 report_config","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-report_config-api-list"},"x-ves-proto-rpc":"ves.io.schema.report_config.API.List"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs/list-reports-history":{"post":{"summary":"List Reports History","description":"List Reports history for the list of report configurations in the given namespace","operationId":"ves.io.schema.report_config.CustomAPI.ListReportsHistory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configListReportsHistoryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace for this request.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/report_configListReportsHistoryRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-customapi-listreportshistory"},"x-ves-proto-rpc":"ves.io.schema.report_config.CustomAPI.ListReportsHistory"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs/list-reports-history-bot-defence":{"post":{"summary":"List Reports History Bot Defence","description":"List Reports history bot defence for the list of report configurations in the given namespace","operationId":"ves.io.schema.report_config.CustomAPI.ListReportsHistoryBotDefence","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configListReportsHistoryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace for this request.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/report_configListReportsHistoryRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-customapi-listreportshistorybotdefence"},"x-ves-proto-rpc":"ves.io.schema.report_config.CustomAPI.ListReportsHistoryBotDefence"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs/list-reports-history-waap":{"post":{"summary":"List Reports History Waap","description":"List Reports history waap for the list of report configurations in the given namespace","operationId":"ves.io.schema.report_config.CustomAPI.ListReportsHistoryWaap","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configListReportsHistoryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace for this request.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/report_configListReportsHistoryRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-customapi-listreportshistorywaap"},"x-ves-proto-rpc":"ves.io.schema.report_config.CustomAPI.ListReportsHistoryWaap"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs/{name}":{"get":{"summary":"Get Report Configuration","description":"Get Report Configuration will read the configuration","operationId":"ves.io.schema.report_config.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configGetResponse"}}}},"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-report_config-api-get"},"x-ves-proto-rpc":"ves.io.schema.report_config.API.Get"},"delete":{"summary":"Delete Report Configuration","description":"Delete the specified report_config","operationId":"ves.io.schema.report_config.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/report_configDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-api-delete"},"x-ves-proto-rpc":"ves.io.schema.report_config.API.Delete"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/report/namespaces/{namespace}/report_configs/{name}/generate":{"post":{"summary":"Generate Report Now","description":"Generate report now","operationId":"ves.io.schema.report_config.CustomAPI.GenerateReport","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configGenerateReportResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"system\"\nNamespace for this request.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-required\nx-example: \"test-report\"\nName of the report config for which report has to be generated.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configGenerateReportRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-report_config-customapi-generatereport"},"x-ves-proto-rpc":"ves.io.schema.report_config.CustomAPI.GenerateReport"},"x-displayname":"Report Configuration","x-ves-proto-service":"ves.io.schema.report_config.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Report Configuration","x-ves-proto-package":"ves.io.schema.report_config","components":{"requestBodies":{"report_configListReportsHistoryRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/report_configListReportsHistoryRequest"}}},"required":true}},"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"}}},"reportAttackImpact":{"type":"object","description":"attack impact","title":"AttackImpact","x-displayname":"Attack Impact","x-ves-proto-message":"ves.io.schema.report.AttackImpact","properties":{"data":{"type":"array","description":" attack impact data\n\nExample: ` \"Attack Impact\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"attack impact data","items":{"$ref":"#/components/schemas/reportAttackImpactData"},"x-displayname":"Attack Impact Data","x-ves-example":"Attack Impact","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Attack Impact\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Attack Impact Header","x-ves-example":"Attack Impact","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportAttackImpactData":{"type":"object","description":"key value pair of attack impact data","title":"AttackImpactData","x-displayname":"Attack Impact Data","x-ves-proto-message":"ves.io.schema.report.AttackImpactData","properties":{"key":{"$ref":"#/components/schemas/reportAttackImpactKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldDataList"}}},"reportAttackImpactKey":{"type":"string","description":"attack impact key\n\nIndicates field not being set","title":"AttackImpactKey","enum":["ATTACK_IMPACT_KEY_NONE","ATTACK_IMPACT_KEY_TOP_3_ATTACKED_PATHS","ATTACK_IMPACT_KEY_TOP_3_ATTACKED_DOMAINS"],"default":"ATTACK_IMPACT_KEY_NONE","x-displayname":"Attack Impact Key","x-ves-proto-enum":"ves.io.schema.report.AttackImpactKey"},"reportAttackSources":{"type":"object","description":"attack sources","title":"AttackSources","x-displayname":"Attack Sources","x-ves-proto-message":"ves.io.schema.report.AttackSources","properties":{"data":{"type":"array","description":" Attack Sources data\n\nExample: ` \"Attack Sources\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Attack Sources data","items":{"$ref":"#/components/schemas/reportAttackSourcesData"},"x-displayname":"Attack Sources Data","x-ves-example":"Attack Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Attack Sources\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Attack Sources Header","x-ves-example":"Attack Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportAttackSourcesData":{"type":"object","description":"key value pair of attack sources data","title":"AttackSourcesData","x-displayname":"Attack Sources Data","x-ves-proto-message":"ves.io.schema.report.AttackSourcesData","properties":{"key":{"$ref":"#/components/schemas/reportAttackSourcesKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldDataList"}}},"reportAttackSourcesKey":{"type":"string","description":"attack sources key\n\nIndicates field not being set","title":"AttackSourcesKey","enum":["ATTACK_SOURCES_KEY_NONE","ATTACK_SOURCES_KEY_TOP_3_ASNS","ATTACK_SOURCES_KEY_TOP_3_COUNTRIES"],"default":"ATTACK_SOURCES_KEY_NONE","x-displayname":"Attack Sources Key","x-ves-proto-enum":"ves.io.schema.report.AttackSourcesKey"},"reportFieldValueType":{"type":"string","description":"field value type\n\nIndicates field not being set","title":"field value type","enum":["TYPE_NONE","TYPE_RATE","TYPE_PERCENT","TYPE_THROUGHPUT","TYPE_NUMBER"],"default":"TYPE_NONE","x-displayname":"Widget Field Value Type","x-ves-proto-enum":"ves.io.schema.report.FieldValueType"},"reportProtectedLBCount":{"type":"object","description":"Protected LB Count.","title":"ProtectedLBCount","x-displayname":"Protected LB Count","x-ves-proto-message":"ves.io.schema.report.ProtectedLBCount","properties":{"protected_lb_count":{"type":"string","description":" LB protected by waap\n\nExample: ` \"24\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"LB count protectd by waap","format":"uint64","x-displayname":"LB count protected by WAAP","x-ves-example":"24","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"total_lb_count":{"type":"string","description":" total LB count\n\nExample: ` \"50\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"total LB count","format":"uint64","x-displayname":"Total LB count","x-ves-example":"50","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportCreatorMethod":{"type":"string","description":"report creator method\n\nIndicates field not being set","title":"Report Creator Method","enum":["REPORT_CREATE_METHOD_NONE","REPORT_CREATE_METHOD_PERIODIC","REPORT_CREATE_METHOD_USER_TRIGGERED"],"default":"REPORT_CREATE_METHOD_NONE","x-displayname":"Report Creator Method","x-ves-proto-enum":"ves.io.schema.report.ReportCreatorMethod"},"reportReportDataATB":{"type":"object","description":"ATB report data.","title":"ReportDataATB","x-displayname":"ATB Report Data","x-ves-proto-message":"ves.io.schema.report.ReportDataATB","properties":{"json_data":{"type":"string","description":" json_data\n\nExample: ` \"{malicious_bots10}\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"JSON data containing details like the number of malicious bots detected in the given timerange","x-displayname":"JSON data","x-ves-example":"{malicious_bots: 10}","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportDataWAAP":{"type":"object","description":"WAAP report data.","title":"ReportDataWAAP","x-displayname":"WAAP Report Data","x-ves-proto-message":"ves.io.schema.report.ReportDataWAAP","properties":{"attack_impact":{"$ref":"#/components/schemas/reportAttackImpact"},"attack_sources":{"$ref":"#/components/schemas/reportAttackSources"},"lb_count":{"$ref":"#/components/schemas/reportProtectedLBCount"},"report_footer":{"$ref":"#/components/schemas/ioschemaEmpty"},"report_header":{"$ref":"#/components/schemas/reportReportHeader"},"security_events":{"$ref":"#/components/schemas/reportSecurityEvents"},"threat_details":{"$ref":"#/components/schemas/reportThreatDetails"}}},"reportReportDeliveryState":{"type":"string","description":"report delivery state\n\nIndicates field not being set\nstate is Success\nstate is Error\nstate is Partial\nstate is Pending\nIndicates no user groups are configured and report can be downloaded","title":"Report delivery state","enum":["REPORT_DELIVERY_STATE_NONE","REPORT_DELIVERY_STATE_SUCCESS","REPORT_DELIVERY_STATE_ERROR","REPORT_DELIVERY_STATE_PARTIAL","REPORT_DELIVERY_STATE_PENDING","REPORT_DELIVERY_STATE_DOWNLOAD"],"default":"REPORT_DELIVERY_STATE_NONE","x-displayname":"Report Delivery State","x-ves-proto-enum":"ves.io.schema.report.ReportDeliveryState"},"reportReportDeliveryStatus":{"type":"object","description":"report generation status","title":"Report Delivery Status","x-displayname":"Report Delivery Status","x-ves-proto-message":"ves.io.schema.report.ReportDeliveryStatus","properties":{"delivered_time":{"type":"string","description":" delivery time\n\nExample: ` \"June 3 8PM 2022\"`","title":"report delivered time","format":"date-time","x-displayname":"Report delivered time","x-ves-example":"June 3 8PM 2022"},"eta":{"type":"string","description":" estimated time\n\nExample: ` \"June 3 11PM 2022\"`","title":"estimated time at which the report delivery would be complete","format":"date-time","x-displayname":"Estimated Time at which the report generation would be complete","x-ves-example":"June 3 11PM 2022"},"report_delivery_state":{"$ref":"#/components/schemas/reportReportDeliveryState"}}},"reportReportFrequency":{"type":"string","description":"report frequency\n\nIndicates field not being set","title":"Report Frequency","enum":["REPORT_FREQUENCY_NONE","REPORT_FREQUENCY_DAILY","REPORT_FREQUENCY_WEEKLY","REPORT_FREQUENCY_MONTHLY"],"default":"REPORT_FREQUENCY_NONE","x-displayname":"Report Frequency","x-ves-proto-enum":"ves.io.schema.report.ReportFrequency"},"reportReportGenerationStatus":{"type":"object","description":"report generation status","title":"Report Generation Status","x-displayname":"Report Generation Status","x-ves-proto-message":"ves.io.schema.report.ReportGenerationStatus","properties":{"eta":{"type":"string","description":" estimated time\n\nExample: ` \"June 3 11PM 2022\"`","title":"estimated time at which the report generation would be complete","format":"date-time","x-displayname":"Estimated Time at which the report generation would be complete","x-ves-example":"June 3 11PM 2022"},"report_status":{"$ref":"#/components/schemas/reportReportStatus"},"scheduled_time":{"type":"string","description":" scheduled time\n\nExample: ` \"June 3 8PM 2022\"`","title":"report scheduled time","format":"date-time","x-displayname":"Report scheduled time","x-ves-example":"June 3 8PM 2022"}}},"reportReportHeader":{"type":"object","description":"report header","title":"report header","x-displayname":"Report Header","x-ves-proto-message":"ves.io.schema.report.ReportHeader","properties":{"end_time":{"type":"string","description":" end time of the report data\n\nExample: ` \"3 July 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report end time","x-displayname":"End Time of Report","x-ves-example":"3 July 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"generation_time":{"type":"string","description":" report generation time\n\nExample: ` \"3 July 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"3 July 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" namespace of the report data\n\nExample: ` \"ves-system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"namespace","x-displayname":"Namespace","x-ves-example":"ves-system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_frequency":{"$ref":"#/components/schemas/reportReportFrequency"},"report_sub_title":{"type":"string","description":" report sub title\n\nExample: ` \"Web App and API Protection\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"sub title of the report","x-displayname":"Report Sub Title","x-ves-example":"Web App and API Protection","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_title":{"type":"string","description":" report title\n\nExample: ` \"WAAP Dashboard summary\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"title of the report","x-displayname":"Report Title","x-ves-example":"WAAP Dashboard summary","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the report data\n\nExample: ` \"3 Jun 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report start time","x-displayname":"Start Time of Report","x-ves-example":"3 Jun 2022","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"tenant_fqdn":{"type":"string","description":" x-displayName \"Tenant\"\n Tenant to which this object belongs.\n\nExample: ` \"testing.demo1.volterra.us\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"tenant fqdn","x-ves-example":"testing.demo1.volterra.us","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportReportStatus":{"type":"string","description":"report status\n\nIndicates field not being set\nUnable to send report to all the users specified in the user groups of report config object.","title":"Report Status","enum":["NONE","SUCCESS","ERROR","PENDING","PAUSED","PARTIAL"],"default":"NONE","x-displayname":"Report Status","x-ves-proto-enum":"ves.io.schema.report.ReportStatus"},"reportSecurityEvents":{"type":"object","description":"Security events Breakdown","title":"SecurityEvents","x-displayname":"Security Events Breakdown","x-ves-proto-message":"ves.io.schema.report.SecurityEvents","properties":{"data":{"type":"array","description":" Security events breakdown data\n\nExample: ` \"Threat data 16k\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Security events data","items":{"$ref":"#/components/schemas/reportSecurityEventsData"},"x-displayname":"Security events breakdown data","x-ves-example":"Threat data 16k","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" Security events header \n\nExample: ` \"Security Events Breakdown\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Security Events header","x-ves-example":"Security Events Breakdown","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportSecurityEventsData":{"type":"object","description":"Security events breakdown data","title":"SecurityEventsData","x-displayname":"Security Events Data","x-ves-proto-message":"ves.io.schema.report.SecurityEventsData","properties":{"key":{"$ref":"#/components/schemas/reportSecurityEventsKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldData"}}},"reportSecurityEventsKey":{"type":"string","description":"security events key\n\nIndicates field not being set","title":"SecurityEventsKey","enum":["SECURITY_EVENTS_KEY_NONE","SECURITY_EVENTS_KEY_TOTAL_SECURITY_EVENTS","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_WAF_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_BOT_DEFENSE_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_API_SECURITY_EVENTS_BLOCKED","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_ALLOWED","SECURITY_EVENTS_KEY_SERVICE_POLICY_SECURITY_EVENTS_BLOCKED"],"default":"SECURITY_EVENTS_KEY_NONE","x-displayname":"Security events key","x-ves-proto-enum":"ves.io.schema.report.SecurityEventsKey"},"reportThreatDetails":{"type":"object","description":"Threat details","title":"ThreatDetails","x-displayname":"Threat details","x-ves-proto-message":"ves.io.schema.report.ThreatDetails","properties":{"data":{"type":"array","description":" Threat details data.\n\nExample: ` \"Threat data 16k\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Threat details data","items":{"$ref":"#/components/schemas/reportThreatDetailsData"},"x-displayname":"Threat details data","x-ves-example":"Threat data 16k","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header":{"type":"string","description":" header\n\nExample: ` \"Threat details\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"header","x-displayname":"Threat details Header","x-ves-example":"Threat details","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportThreatDetailsData":{"type":"object","description":"key value pair threat details data","title":"ThreatDetailsData","x-displayname":"Threat Details Data","x-ves-proto-message":"ves.io.schema.report.ThreatDetailsData","properties":{"key":{"$ref":"#/components/schemas/reportThreatDetailsKey"},"value":{"$ref":"#/components/schemas/reportWaapReportFieldData"}}},"reportThreatDetailsKey":{"type":"string","description":"threat details key\n\nIndicates field not being set","title":"ThreatDetailsKey","enum":["THREAT_DETAILS_KEY_NONE","THREAT_DETAILS_KEY_ALL_TRAFFIC_IS_FROM_BOTS","THREAT_DETAILS_KEY_ALL_TRAFFIC_FROM_MALICIOUS_BOTS","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS","THREAT_DETAILS_KEY_IP_REPUTATION_ATTACK_MITIGATED","THREAT_DETAILS_KEY_LB_DDOS_ATTACK_ACTIVITY","THREAT_DETAILS_KEY_MALICIOUS_USERS_DETECTED","THREAT_DETAILS_KEY_API_ENDPOINTS","THREAT_DETAILS_KEY_API_ENDPOINTS_PII_DETECTED","THREAT_DETAILS_KEY_API_ENDPOINTS_PII_NOT_DETECTED","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_ALLOWED","THREAT_DETAILS_KEY_THREAT_CAMPAIGNS_BLOCKED","THREAT_DETAILS_KEY_IP_REPUTATION_ALLOWED","THREAT_DETAILS_KEY_IP_REPUTATION_BLOCKED"],"default":"THREAT_DETAILS_KEY_NONE","x-displayname":"Threat Details Key","x-ves-proto-enum":"ves.io.schema.report.ThreatDetailsKey"},"reportWaapReportFieldData":{"type":"object","description":"waap report field data","title":"Waap Report Field Data","x-displayname":"Waap Report Field Data","x-ves-proto-message":"ves.io.schema.report.WaapReportFieldData","properties":{"current_value":{"type":"number","description":" field current value\n\nExample: ` \"16000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"field current value","format":"double","x-displayname":"Current Value","x-ves-example":"16000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"current_value_header":{"type":"string","description":" field value header\n\nExample: ` \"Digital Ocean\"`","title":"field value header","x-displayname":"Field Value Header","x-ves-example":"Digital Ocean"},"current_value_sub_values":{"type":"object","description":" field sub values\n\nExample: ` \"128000 value will be sub-divided further like WAF6100, Bot defense:1500\"`","title":"field value sub values","x-displayname":"Field Sub Values","x-ves-example":"128000 value will be sub-divided further like WAF: 6100, Bot defense:1500"},"current_value_type":{"$ref":"#/components/schemas/reportFieldValueType"},"prev_value":{"type":"number","description":" field previous value, type will be same as current_value_type\n\nExample: ` \"15000\"`","title":"field previous value","format":"double","x-displayname":"Field Previous Value","x-ves-example":"15000"},"prev_value_header":{"type":"string","description":" field previous value header\n\nExample: ` \"ULAYER ASN\"`","title":"field previous value header","x-displayname":"Field Previous Value Header","x-ves-example":"ULAYER ASN"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"reportWaapReportFieldDataList":{"type":"object","description":"waap report field data list","title":"Waap Report Field Data List","x-displayname":"Waap Report Field Data List","x-ves-proto-message":"ves.io.schema.report.WaapReportFieldDataList","properties":{"data":{"type":"array","description":" waap report data field list \n\nExample: ` \"\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"field data list","items":{"$ref":"#/components/schemas/reportWaapReportFieldData"},"x-displayname":"List of Waap Report Data Fields","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"report_configCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of report_config","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.report_config.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/report_configCreateSpecType"}}},"report_configCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.report_config.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemareport_configGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"report_configCreateSpecType":{"type":"object","description":"Report configuration is used to schedule report generation at a later point in time.","title":"Create Report Configuration","x-displayname":"Create Report Configuration","x-ves-oneof-field-report_type":"[\"bot_defense\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report_config.CreateSpecType","properties":{"report_recipients":{"$ref":"#/components/schemas/report_configReportRecipients"},"waap":{"$ref":"#/components/schemas/report_configReportTypeWaap"}}},"report_configCustomAPIListResponseItem":{"type":"object","description":"By default a summary of report is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"CustomAPIListResponseItem is an individual item in a collection of report","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.report_config.CustomAPIListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this report","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this report","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates report is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemareportGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this report","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this report\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"object":{"$ref":"#/components/schemas/schemareportObject"},"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 report\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"report_configDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a report_config","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.report_config.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"}}},"report_configGenerateReportRequest":{"type":"object","description":"Generate report request","title":"Generate Report Request","x-displayname":"Generate Report Request","x-ves-proto-message":"ves.io.schema.report_config.GenerateReportRequest","properties":{"name":{"type":"string","description":" Name of the report config for which report has to be generated.\n\nExample: ` \"test-report\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Name","x-ves-example":"test-report","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace for this request.\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"}}}},"report_configGenerateReportResponse":{"type":"object","description":"Generate report response","title":"Generate Report Response","x-displayname":"Generate Report Response","x-ves-proto-message":"ves.io.schema.report_config.GenerateReportResponse"},"report_configGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read report_config","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.report_config.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/report_configCreateRequest"},"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/report_configReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemareport_configGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/report_configStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"report_configGetResponseFormatCode":{"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"},"report_configListReportsHistoryRequest":{"type":"object","description":"List Reports for the current namespace for the requested report configuration names.","title":"List Reports Request","x-displayname":"List Reports Request","x-ves-oneof-field-report_configuration_names":"[\"include_all\",\"report_config_names\"]","x-ves-proto-message":"ves.io.schema.report_config.ListReportsHistoryRequest","properties":{"include_all":{"type":"boolean","description":"Exclusive with [report_config_names]\n include all configuration names\n\nExample: ` \"true\"`","title":"Include All configuration names","format":"boolean","x-displayname":"Include all configuration names","x-ves-example":"true"},"namespace":{"type":"string","description":" Namespace for this request.\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"}},"report_config_names":{"$ref":"#/components/schemas/report_configReportConfigurationNamesList"}}},"report_configListReportsHistoryResponse":{"type":"object","description":"List of report objects for the given namespace and report configuration names","title":"List Reports History Response","x-displayname":"List Reports History Response","x-ves-proto-message":"ves.io.schema.report_config.ListReportsHistoryResponse","properties":{"items":{"type":"array","description":" Report objects","title":"Report objects","items":{"$ref":"#/components/schemas/report_configCustomAPIListResponseItem"},"x-displayname":"Report Objects"},"reports":{"type":"array","description":" Report objects","title":"Report objects","items":{"$ref":"#/components/schemas/schemareportGlobalSpecType"},"x-displayname":"Report Objects"},"reports_list":{"type":"array","description":" Report objects","title":"Report objects","items":{"$ref":"#/components/schemas/report_configListReportsHistoryResponseItem"},"x-displayname":"Report Objects"}}},"report_configListReportsHistoryResponseItem":{"type":"object","title":"List Reports History Response Item","x-ves-proto-message":"ves.io.schema.report_config.ListReportsHistoryResponseItem","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/schemareportSpecType"}}},"report_configListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of report_config","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.report_config.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/report_configListResponseItem"},"x-displayname":"Items"}}},"report_configListResponseItem":{"type":"object","description":"By default a summary of report_config 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 report_config","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.report_config.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this report_config","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this report_config","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates report_config is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemareport_configGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this report_config","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this report_config\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/report_configStatusObject"},"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 report_config\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"report_configNamespaces":{"type":"object","description":"namespaces","title":"Namespaces","x-displayname":"Namespaces","x-ves-proto-message":"ves.io.schema.report_config.Namespaces","properties":{"namespaces":{"type":"array","description":" list of namespaces for which user wants to generate report\n\nExample: ` \"['test', 'production']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 5\n  ves.io.schema.rules.repeated.unique: true\n","title":"list of namespaces","maxItems":5,"items":{"type":"string"},"x-displayname":"Namespaces","x-ves-example":"['test', 'production']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"5","ves.io.schema.rules.repeated.unique":"true"}}}},"report_configReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a report_config","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.report_config.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/report_configReplaceSpecType"}}},"report_configReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.report_config.ReplaceResponse"},"report_configReplaceSpecType":{"type":"object","description":"Replace Report Configuration.\n\nUpdate the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.","x-displayname":"Replace Report Configuration","x-ves-oneof-field-report_type":"[\"bot_defense\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report_config.ReplaceSpecType","properties":{"report_recipients":{"$ref":"#/components/schemas/report_configReportRecipients"},"waap":{"$ref":"#/components/schemas/report_configReportTypeWaap"}}},"report_configReportConfigurationNamesList":{"type":"object","description":"ReportConfigurationNamesList","title":"ReportConfigurationNamesList because protobuf does not support list inside oneof","x-displayname":"ReportConfigurationNamesList","x-ves-proto-message":"ves.io.schema.report_config.ReportConfigurationNamesList","properties":{"names":{"type":"array","description":"\n\nExample: ` \"test-config-1, test-config-2\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 256\n  ves.io.schema.rules.repeated.unique: true\n","title":"report configuration names list","maxItems":256,"items":{"type":"string"},"x-displayname":"Report configuration names list","x-ves-example":"test-config-1, test-config-2","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"256","ves.io.schema.rules.repeated.unique":"true"}}}},"report_configReportFreqDaily":{"type":"object","description":"create report daily","title":"Report Frequency Daily","x-displayname":"Report Frequency Daily","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqDaily","properties":{"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportFreqMonthly":{"type":"object","description":"create report monthly","title":"Report Frequency Monthly","x-displayname":"Report Frequency Monthly","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqMonthly","properties":{"date":{"$ref":"#/components/schemas/report_configReportGenerationDate"},"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"time report is generated","x-displayname":"Time Report is Generated","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportFreqWeekly":{"type":"object","description":"create report weekly","title":"Report Frequency Weekly","x-displayname":"Report Frequency Weekly","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqWeekly","properties":{"day":{"$ref":"#/components/schemas/report_configReportGenerationWeekday"},"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportGenerationDate":{"type":"string","description":"report generation date\n\nIndicates field not being set\nCreate report on Last day of month","title":"Report Generation Date","enum":["DATE_NONE","DATE_ONE","DATE_TWO","DATE_THREE","DATE_FOUR","DATE_FIVE","DATE_SIX","DATE_SEVEN","DATE_EIGHT","DATE_NINE","DATE_TEN","DATE_ELEVEN","DATE_TWELVE","DATE_THIRTEEN","DATE_FOURTEEN","DATE_FIFTEEN","DATE_SIXTEEN","DATE_SEVENTEEN","DATE_EIGHTEEN","DATE_NINETEEN","DATE_TWENTY","DATE_TWENTYONE","DATE_TWENTYTWO","DATE_TWENTYTHREE","DATE_TWENTYFOUR","DATE_TWENTYFIVE","DATE_TWENTYSIX","DATE_TWENTYSEVEN","DATE_TWENTYEIGHT","DATE_LAST"],"default":"DATE_NONE","x-displayname":"Report Generation Date","x-ves-proto-enum":"ves.io.schema.report_config.ReportGenerationDate"},"report_configReportGenerationWeekday":{"type":"string","description":"report generation weekday\n\nIndicates field not being set","title":"Report Generation Weekday","enum":["WEEKDAY_NONE","WEEKDAY_MONDAY","WEEKDAY_TUESDAY","WEEKDAY_WEDNESDAY","WEEKDAY_THURSDAY","WEEKDAY_FRIDAY","WEEKDAY_SATURDAY","WEEKDAY_SUNDAY"],"default":"WEEKDAY_NONE","x-displayname":"Report Generation Weekday","x-ves-proto-enum":"ves.io.schema.report_config.ReportGenerationWeekday"},"report_configReportRecipients":{"type":"object","description":"Report recipients","title":"Report recipients","x-displayname":"Report recipients","x-ves-proto-message":"ves.io.schema.report_config.ReportRecipients","properties":{"user_groups":{"type":"array","description":" Select one or more user groups, to which the report should be sent via email\n\nExample: ` \"system/user-test\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 5\n  ves.io.schema.rules.repeated.unique: true\n","title":"user groups","maxItems":5,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"User Groups","x-ves-example":"system/user-test","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"5","ves.io.schema.rules.repeated.unique":"true"}}}},"report_configReportTypeBotDefense":{"type":"object","description":"x-displayName: \"Report Type BotDefense\"\nReport Type Bot Defense","title":"Report Type Bot Defense","properties":{"all_namespaces":{"$ref":"#/components/schemas/ioschemaEmpty"},"current_namespace":{"$ref":"#/components/schemas/ioschemaEmpty"},"system_default":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"report_configReportTypeWaap":{"type":"object","description":"Report Type Waap","title":"Report Type Waap","x-displayname":"Report Type Waap","x-ves-oneof-field-report_frequency":"[\"daily\",\"monthly\",\"weekly\"]","x-ves-oneof-field-report_namespaces":"[\"current_namespace\",\"namespaces\"]","x-ves-proto-message":"ves.io.schema.report_config.ReportTypeWaap","properties":{"current_namespace":{"$ref":"#/components/schemas/ioschemaEmpty"},"daily":{"$ref":"#/components/schemas/report_configReportFreqDaily"},"monthly":{"$ref":"#/components/schemas/report_configReportFreqMonthly"},"namespaces":{"$ref":"#/components/schemas/report_configNamespaces"},"weekly":{"$ref":"#/components/schemas/report_configReportFreqWeekly"}}},"report_configStatusObject":{"type":"object","description":"Status of the report status object","title":"Status Object","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.report_config.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":" Reference to the Report configuration object \n\nExample: ` \"123\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Object Reference","x-ves-example":"123","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"report_delivery_status":{"$ref":"#/components/schemas/reportReportDeliveryStatus"},"report_generation_status":{"$ref":"#/components/schemas/reportReportGenerationStatus"},"reports":{"type":"array","description":" list of reports\n\nExample: ` \"123, 456\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"List of Reports","x-ves-example":"123, 456","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"sent_time":{"type":"string","description":" last sent time\n\nExample: ` \"June 3 8PM 2022\"`","title":"report last sent time","format":"date-time","x-displayname":"Report Last sent time","x-ves-example":"June 3 8PM 2022"}}},"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"}}},"schemaObjectMetaType":{"type":"object","description":"ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.\nThe information in this type can be specified by user during create and replace APIs.","title":"ObjectMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.ObjectMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. Object create will fail if\n provided by the client and the value exists in the system. Typically generated by the\n server on successful creation of an object and is not allowed to change once populated.\n Shadowed by SystemObjectMeta's uid field.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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"}}},"schemaSystemObjectMetaType":{"type":"object","description":"SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"value"},"creator_cookie":{"type":"string","description":" This can used by the creator of the object for later audit for e.g. by storing the\n version identifying information of the object so at future it can be determined if\n version present at remote end is current or stale.\n\nExample: ` \"value\"`","title":"creator_cookie","x-displayname":"Creator Cookie","x-ves-example":"value"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"value"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"direct_ref_hash":{"type":"string","description":" A hash of the UIDs of  direct references on this object. This can be used to determine if \n this object hash has had references become resolved/unresolved","title":"direct_ref_hash","x-displayname":"Direct Reference Hash"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"namespace":{"type":"array","description":" The namespace this object belongs to. This is populated by the service based on the\n metadata.namespace field when an object is created.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"namespace","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Namespace Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"revision":{"type":"string","description":" A revision number which always increases with each modification of the object in storage\n This doesn't necessarily increase sequentially, but should always increase.\n This will be 0 when first created, and before any modifications.","title":"revision","format":"int64","x-displayname":"Revision"},"sre_disable":{"type":"boolean","description":" This should be set to true If VES/SRE operator wants to suppress an object from being\n presented to business-logic of a daemon(e.g. due to bad-form/issue-causing Object).\n This is meant only to be used in temporary situations for operational continuity till\n a fix is rolled out in business-logic.\n\nExample: ` \"true\"`","title":"sre_disable","format":"boolean","x-displayname":"SRE Disable","x-ves-example":"true"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"trace_info":{"type":"string","description":" trace_info holds information(<trace-id>:<span-id>:<parent-span-id>) of the request doing\n the object modification. This can be used on the watch side to create subsequent spans.\n This information can be used to co-relate activities across services (modulo state compression)\n for a synchronous API.\n\nExample: ` \"value\"`","title":"trace_info","x-displayname":"Trace Info","x-ves-example":"value"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Indicate origin of this object.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemareportGetSpecType":{"type":"object","description":"Get Report will read the report metadata.","title":"Get Report","x-displayname":"Get Report","x-ves-oneof-field-report_data":"[\"atb\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report.GetSpecType","properties":{"atb":{"$ref":"#/components/schemas/reportReportDataATB"},"report_config":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"report_creator_method":{"$ref":"#/components/schemas/reportReportCreatorMethod"},"report_delivery_status":{"$ref":"#/components/schemas/reportReportDeliveryStatus"},"report_frequency":{"type":"string","description":" report frequency\n\nExample: `  \"Every week Monday 4PM PST\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","x-displayname":"Report Frequency","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_generation_status":{"$ref":"#/components/schemas/reportReportGenerationStatus"},"report_id":{"type":"string","format":"uint64"},"report_status":{"$ref":"#/components/schemas/reportReportStatus"},"sent_time":{"type":"string","description":" sent time\n\nExample: `  \"June 3 2PM 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","format":"date-time","x-displayname":"Report Sent Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"waap":{"$ref":"#/components/schemas/reportReportDataWAAP"}}},"schemareportGlobalSpecType":{"type":"object","description":"Configuration specification for Report Configuration.","title":"GlobalSpecType","x-displayname":"Global Configuration Specification","x-ves-oneof-field-report_data":"[\"atb\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report.GlobalSpecType","properties":{"atb":{"$ref":"#/components/schemas/reportReportDataATB"},"report_config":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"report_creator_method":{"$ref":"#/components/schemas/reportReportCreatorMethod"},"report_delivery_status":{"$ref":"#/components/schemas/reportReportDeliveryStatus"},"report_frequency":{"type":"string","description":" report frequency\n\nExample: `  \"Every week Monday 4PM PST\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report frequency","x-displayname":"Report Frequency","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"report_generation_status":{"$ref":"#/components/schemas/reportReportGenerationStatus"},"sent_time":{"type":"string","description":" sent time\n\nExample: `  \"June 3 2PM 2022\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"report sent time","format":"date-time","x-displayname":"Report Sent Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"waap":{"$ref":"#/components/schemas/reportReportDataWAAP"}}},"schemareportObject":{"type":"object","description":"Report object specification","title":"Report Object","x-displayname":"Report Object","x-ves-proto-message":"ves.io.schema.report.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/schemareportSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"schemareportSpecType":{"type":"object","description":"Shape of the report specification","title":"Site Specification","x-displayname":"Specification","x-ves-proto-message":"ves.io.schema.report.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/schemareportGlobalSpecType"}}},"schemareport_configGetSpecType":{"type":"object","description":"Get Report Configuration will read the configuration","title":"Get Report Configuration","x-displayname":"Get Report Configuration","x-ves-oneof-field-report_type":"[\"bot_defense\",\"waap\"]","x-ves-proto-message":"ves.io.schema.report_config.GetSpecType","properties":{"report_recipients":{"$ref":"#/components/schemas/report_configReportRecipients"},"waap":{"$ref":"#/components/schemas/report_configReportTypeWaap"}}},"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"}}}}}}}