@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.app_firewall","description":"WAF Configuration","version":""},"paths":{"/api/data/namespaces/system/app_firewall/all_ns_metrics":{"post":{"summary":"MetricsAllNamespaces","description":"App Firewall metrics","operationId":"ves.io.schema.app_firewall.CustomDataAPI.MetricsAllNamespaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallMetricsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/app_firewallMetricsRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_firewall-customdataapi-metricsallnamespaces"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.CustomDataAPI.MetricsAllNamespaces"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/app_firewalls":{"post":{"summary":"Create Application Firewall","description":"Create Application Firewall","operationId":"ves.io.schema.app_firewall.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallCreateResponse"}}}},"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/app_firewallCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_firewall-api-create"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.API.Create"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/app_firewalls/{metadata.name}":{"put":{"summary":"Replace Application Firewall","description":"Replace Application Firewall","operationId":"ves.io.schema.app_firewall.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallReplaceResponse"}}}},"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/app_firewallReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_firewall-api-replace"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.API.Replace"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data/namespaces/{namespace}/app_firewall/metrics":{"post":{"summary":"Metrics","description":"App Firewall metrics","operationId":"ves.io.schema.app_firewall.CustomDataAPI.Metrics","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallMetricsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/app_firewallMetricsRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_firewall-customdataapi-metrics"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.CustomDataAPI.Metrics"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/app_firewalls":{"get":{"summary":"List Application Firewall","description":"List the set of app_firewall in a namespace","operationId":"ves.io.schema.app_firewall.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallListResponse"}}}},"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 app_firewall","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-app_firewall-api-list"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.API.List"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/app_firewalls/{name}":{"get":{"summary":"Get Application Firewall","description":"Get Application Firewall","operationId":"ves.io.schema.app_firewall.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallGetResponse"}}}},"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-app_firewall-api-get"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.API.Get"},"delete":{"summary":"Delete Application Firewall","description":"Delete the specified app_firewall","operationId":"ves.io.schema.app_firewall.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/app_firewallDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_firewall-api-delete"},"x-ves-proto-rpc":"ves.io.schema.app_firewall.API.Delete"},"x-displayname":"Application Firewall","x-ves-proto-service":"ves.io.schema.app_firewall.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Application Firewall","x-ves-proto-package":"ves.io.schema.app_firewall","components":{"requestBodies":{"app_firewallMetricsRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_firewallMetricsRequest"}}},"required":true}},"schemas":{"app_firewallAiRiskBasedBlocking":{"type":"object","description":"All Attack Types, including high, medium, and low accuracy signatures, automatic Attack Signature tuning,\nThreat Campaigns, and all Violations will be enabled. AI and ML algorithms will assess request risk, and\nonly high-risk requests will be blocked by default. This feature is in preview mode.","title":"AI Risk Based Blocking","x-displayname":"Risk-Based Blocking (Powered by AI) - Preview","x-ves-proto-message":"ves.io.schema.app_firewall.AiRiskBasedBlocking","properties":{"high_risk_action":{"$ref":"#/components/schemas/app_firewallRiskBasedBlockingAction"},"low_risk_action":{"$ref":"#/components/schemas/app_firewallRiskBasedBlockingAction"},"medium_risk_action":{"$ref":"#/components/schemas/app_firewallRiskBasedBlockingAction"}}},"app_firewallAllowedResponseCodes":{"type":"object","description":"List of HTTP response status codes that are allowed","title":"Allowed Response Codes","x-displayname":"Allowed Response Codes","x-ves-proto-message":"ves.io.schema.app_firewall.AllowedResponseCodes","properties":{"response_code":{"type":"array","description":" List of HTTP response status codes that are allowed\n\nExample: ` \"[200, 201, 204, 300, 302, 400, 403, 404, 500, 501, 503]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.uint32.gte: 100\n  ves.io.schema.rules.repeated.items.uint32.lte: 999\n  ves.io.schema.rules.repeated.max_items: 48\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"response_code","minItems":1,"maxItems":48,"items":{"type":"integer","format":"int64"},"x-displayname":"Response Code","x-ves-example":"[200, 201, 204, 300, 302, 400, 403, 404, 500, 501, 503]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.uint32.gte":"100","ves.io.schema.rules.repeated.items.uint32.lte":"999","ves.io.schema.rules.repeated.max_items":"48","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"app_firewallAnonymizationConfiguration":{"type":"object","description":"Configure anonymization for HTTP headers, parameters or cookies which may contain sensitive data","title":"AnonymizationConfiguration","x-displayname":"Anonymization Configuration","x-ves-oneof-field-anonymization_choice":"[\"cookie\",\"http_header\",\"query_parameter\"]","x-ves-proto-message":"ves.io.schema.app_firewall.AnonymizationConfiguration","properties":{"cookie":{"$ref":"#/components/schemas/app_firewallAnonymizeHttpCookie"},"http_header":{"$ref":"#/components/schemas/app_firewallAnonymizeHttpHeader"},"query_parameter":{"$ref":"#/components/schemas/app_firewallAnonymizeHttpQueryParameter"}}},"app_firewallAnonymizationSetting":{"type":"object","description":"Anonymization settings which is a list of HTTP headers, parameters and cookies","title":"AnonymizationSetting","x-displayname":"Anonymization Configuration","x-ves-proto-message":"ves.io.schema.app_firewall.AnonymizationSetting","properties":{"anonymization_config":{"type":"array","description":" List of HTTP headers, cookies and query parameters whose values will be masked\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"AnonymizationConfiguration","maxItems":64,"items":{"$ref":"#/components/schemas/app_firewallAnonymizationConfiguration"},"x-displayname":"Configuration","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"app_firewallAnonymizeHttpCookie":{"type":"object","description":"Configure anonymization for HTTP Cookies","title":"AnonymizeHttpCookie","x-displayname":"Anonymize HTTP Cookie","x-ves-proto-message":"ves.io.schema.app_firewall.AnonymizeHttpCookie","properties":{"cookie_name":{"type":"string","description":" Masks the cookie value. The setting does not mask the cookie name.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"cookie_name","maxLength":256,"x-displayname":"Cookie Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}}}},"app_firewallAnonymizeHttpHeader":{"type":"object","description":"Configure anonymization for HTTP Headers","title":"AnonymizeHttpHeader","x-displayname":"Anonymize HTTP Header","x-ves-proto-message":"ves.io.schema.app_firewall.AnonymizeHttpHeader","properties":{"header_name":{"type":"string","description":" Masks the HTTP header value. The setting does not mask the HTTP header name.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.http_header_field: true\n","title":"header_name","x-displayname":"Header Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_header_field":"true"}}}},"app_firewallAnonymizeHttpQueryParameter":{"type":"object","description":"Configure anonymization for HTTP Parameters","title":"AnonymizeHttpQueryParameter","x-displayname":"Anonymize HTTP Query Parameter","x-ves-proto-message":"ves.io.schema.app_firewall.AnonymizeHttpQueryParameter","properties":{"query_param_name":{"type":"string","description":" Masks the query parameter value. The setting does not mask the query parameter name.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"query_param_name","maxLength":256,"x-displayname":"Query Parameter Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}}}},"app_firewallAppFirewallViolationType":{"type":"string","description":"List of all supported Violation Types\n\nVIOL_NONE\nVIOL_FILETYPE\nVIOL_METHOD\nVIOL_MANDATORY_HEADER\nVIOL_HTTP_RESPONSE_STATUS\nVIOL_REQUEST_MAX_LENGTH\nVIOL_FILE_UPLOAD\nVIOL_FILE_UPLOAD_IN_BODY\nVIOL_XML_MALFORMED\nVIOL_JSON_MALFORMED\nVIOL_ASM_COOKIE_MODIFIED\nVIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS\nVIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE\nVIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT\nVIOL_HTTP_PROTOCOL_NULL_IN_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION\nVIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START\nVIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING\nVIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS\nVIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER\nVIOL_EVASION_DIRECTORY_TRAVERSALS\nVIOL_MALFORMED_REQUEST\nVIOL_EVASION_MULTIPLE_DECODING\nVIOL_DATA_GUARD\nVIOL_EVASION_APACHE_WHITESPACE\nVIOL_COOKIE_MODIFIED\nVIOL_EVASION_IIS_UNICODE_CODEPOINTS\nVIOL_EVASION_IIS_BACKSLASHES\nVIOL_EVASION_PERCENT_U_DECODING\nVIOL_EVASION_BARE_BYTE_DECODING\nVIOL_EVASION_BAD_UNESCAPE\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING\nVIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST\nVIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS\nVIOL_ENCODING\nVIOL_COOKIE_MALFORMED\nVIOL_GRAPHQL_FORMAT\nVIOL_GRAPHQL_MALFORMED\nVIOL_GRAPHQL_INTROSPECTION_QUERY","title":"App Firewall Violation Type","enum":["VIOL_NONE","VIOL_FILETYPE","VIOL_METHOD","VIOL_MANDATORY_HEADER","VIOL_HTTP_RESPONSE_STATUS","VIOL_REQUEST_MAX_LENGTH","VIOL_FILE_UPLOAD","VIOL_FILE_UPLOAD_IN_BODY","VIOL_XML_MALFORMED","VIOL_JSON_MALFORMED","VIOL_ASM_COOKIE_MODIFIED","VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS","VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE","VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT","VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST","VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION","VIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START","VIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST","VIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING","VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS","VIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER","VIOL_EVASION_DIRECTORY_TRAVERSALS","VIOL_MALFORMED_REQUEST","VIOL_EVASION_MULTIPLE_DECODING","VIOL_DATA_GUARD","VIOL_EVASION_APACHE_WHITESPACE","VIOL_COOKIE_MODIFIED","VIOL_EVASION_IIS_UNICODE_CODEPOINTS","VIOL_EVASION_IIS_BACKSLASHES","VIOL_EVASION_PERCENT_U_DECODING","VIOL_EVASION_BARE_BYTE_DECODING","VIOL_EVASION_BAD_UNESCAPE","VIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING","VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST","VIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS","VIOL_ENCODING","VIOL_COOKIE_MALFORMED","VIOL_GRAPHQL_FORMAT","VIOL_GRAPHQL_MALFORMED","VIOL_GRAPHQL_INTROSPECTION_QUERY"],"default":"VIOL_NONE","x-displayname":"App Firewall Violation Type","x-ves-proto-enum":"ves.io.schema.app_firewall.AppFirewallViolationType"},"app_firewallAttackType":{"type":"string","description":"List of all Attack Types\n\nATTACK_TYPE_NONE\nATTACK_TYPE_NON_BROWSER_CLIENT\nATTACK_TYPE_OTHER_APPLICATION_ATTACKS\nATTACK_TYPE_TROJAN_BACKDOOR_SPYWARE\nATTACK_TYPE_DETECTION_EVASION\nATTACK_TYPE_VULNERABILITY_SCAN\nATTACK_TYPE_ABUSE_OF_FUNCTIONALITY\nATTACK_TYPE_AUTHENTICATION_AUTHORIZATION_ATTACKS\nATTACK_TYPE_BUFFER_OVERFLOW\nATTACK_TYPE_PREDICTABLE_RESOURCE_LOCATION\nATTACK_TYPE_INFORMATION_LEAKAGE\nATTACK_TYPE_DIRECTORY_INDEXING\nATTACK_TYPE_PATH_TRAVERSAL\nATTACK_TYPE_XPATH_INJECTION\nATTACK_TYPE_LDAP_INJECTION\nATTACK_TYPE_SERVER_SIDE_CODE_INJECTION\nATTACK_TYPE_COMMAND_EXECUTION\nATTACK_TYPE_SQL_INJECTION\nATTACK_TYPE_CROSS_SITE_SCRIPTING\nATTACK_TYPE_DENIAL_OF_SERVICE\nATTACK_TYPE_HTTP_PARSER_ATTACK\nATTACK_TYPE_SESSION_HIJACKING\nATTACK_TYPE_HTTP_RESPONSE_SPLITTING\nATTACK_TYPE_FORCEFUL_BROWSING\nATTACK_TYPE_REMOTE_FILE_INCLUDE\nATTACK_TYPE_MALICIOUS_FILE_UPLOAD\nATTACK_TYPE_GRAPHQL_PARSER_ATTACK","title":"AttackType","enum":["ATTACK_TYPE_NONE","ATTACK_TYPE_NON_BROWSER_CLIENT","ATTACK_TYPE_OTHER_APPLICATION_ATTACKS","ATTACK_TYPE_TROJAN_BACKDOOR_SPYWARE","ATTACK_TYPE_DETECTION_EVASION","ATTACK_TYPE_VULNERABILITY_SCAN","ATTACK_TYPE_ABUSE_OF_FUNCTIONALITY","ATTACK_TYPE_AUTHENTICATION_AUTHORIZATION_ATTACKS","ATTACK_TYPE_BUFFER_OVERFLOW","ATTACK_TYPE_PREDICTABLE_RESOURCE_LOCATION","ATTACK_TYPE_INFORMATION_LEAKAGE","ATTACK_TYPE_DIRECTORY_INDEXING","ATTACK_TYPE_PATH_TRAVERSAL","ATTACK_TYPE_XPATH_INJECTION","ATTACK_TYPE_LDAP_INJECTION","ATTACK_TYPE_SERVER_SIDE_CODE_INJECTION","ATTACK_TYPE_COMMAND_EXECUTION","ATTACK_TYPE_SQL_INJECTION","ATTACK_TYPE_CROSS_SITE_SCRIPTING","ATTACK_TYPE_DENIAL_OF_SERVICE","ATTACK_TYPE_HTTP_PARSER_ATTACK","ATTACK_TYPE_SESSION_HIJACKING","ATTACK_TYPE_HTTP_RESPONSE_SPLITTING","ATTACK_TYPE_FORCEFUL_BROWSING","ATTACK_TYPE_REMOTE_FILE_INCLUDE","ATTACK_TYPE_MALICIOUS_FILE_UPLOAD","ATTACK_TYPE_GRAPHQL_PARSER_ATTACK"],"default":"ATTACK_TYPE_NONE","x-displayname":"Attack Types","x-ves-proto-enum":"ves.io.schema.app_firewall.AttackType"},"app_firewallAttackTypeSettings":{"type":"object","description":"Specifies attack-type settings to be used by WAF","title":"Attack Type Settings","x-displayname":"Attack Type Settings","x-ves-proto-message":"ves.io.schema.app_firewall.AttackTypeSettings","properties":{"disabled_attack_types":{"type":"array","description":" List of Attack Types that will be ignored and not trigger a detection\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 22\n  ves.io.schema.rules.repeated.unique: true\n","title":"Disabled Attack Types","maxItems":22,"items":{"$ref":"#/components/schemas/app_firewallAttackType"},"x-displayname":"Disabled Attack Types","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"22","ves.io.schema.rules.repeated.unique":"true"}}}},"app_firewallBotAction":{"type":"string","description":"Action to be performed on the request\n\nLog and block\nLog only\nDisable detection","title":"Bot Action","enum":["BLOCK","REPORT","IGNORE"],"default":"BLOCK","x-displayname":"Bot Action","x-ves-proto-enum":"ves.io.schema.app_firewall.BotAction"},"app_firewallBotProtectionSetting":{"type":"object","description":"Configuration of WAF Bot Protection","title":"BotProtectionSetting","x-displayname":"Bot Protection","x-ves-proto-message":"ves.io.schema.app_firewall.BotProtectionSetting","properties":{"good_bot_action":{"$ref":"#/components/schemas/app_firewallBotAction"},"malicious_bot_action":{"$ref":"#/components/schemas/app_firewallBotAction"},"suspicious_bot_action":{"$ref":"#/components/schemas/app_firewallBotAction"}}},"app_firewallCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of app_firewall","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.app_firewall.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/app_firewallCreateSpecType"}}},"app_firewallCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.app_firewall.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/app_firewallGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"app_firewallCreateSpecType":{"type":"object","description":"Create Application Firewall","title":"Create Application Firewall","x-displayname":"Create Application Firewall","x-ves-oneof-field-allowed_response_codes_choice":"[\"allow_all_response_codes\",\"allowed_response_codes\"]","x-ves-oneof-field-anonymization_setting":"[\"custom_anonymization\",\"default_anonymization\",\"disable_anonymization\"]","x-ves-oneof-field-blocking_page_choice":"[\"blocking_page\",\"use_default_blocking_page\"]","x-ves-oneof-field-bot_protection_choice":"[\"bot_protection_setting\",\"default_bot_setting\"]","x-ves-oneof-field-detection_setting_choice":"[\"ai_risk_based_blocking\",\"default_detection_settings\",\"detection_settings\"]","x-ves-oneof-field-enforcement_mode_choice":"[\"blocking\",\"monitoring\"]","x-ves-proto-message":"ves.io.schema.app_firewall.CreateSpecType","properties":{"ai_risk_based_blocking":{"$ref":"#/components/schemas/app_firewallAiRiskBasedBlocking"},"allow_all_response_codes":{"$ref":"#/components/schemas/ioschemaEmpty"},"allowed_response_codes":{"$ref":"#/components/schemas/app_firewallAllowedResponseCodes"},"blocking":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocking_page":{"$ref":"#/components/schemas/app_firewallCustomBlockingPage"},"bot_protection_setting":{"$ref":"#/components/schemas/app_firewallBotProtectionSetting"},"custom_anonymization":{"$ref":"#/components/schemas/app_firewallAnonymizationSetting"},"default_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_bot_setting":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_detection_settings":{"$ref":"#/components/schemas/ioschemaEmpty"},"detection_settings":{"$ref":"#/components/schemas/app_firewallDetectionSetting"},"disable_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitoring":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_default_blocking_page":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"app_firewallCustomBlockingPage":{"type":"object","description":"Custom blocking response page body","title":"Custom Blocking Page","x-displayname":"Custom Blocking Response Page","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.app_firewall.CustomBlockingPage","properties":{"blocking_page":{"type":"string","description":" Define the content of the response page (e.g., an HTML document or a JSON object), use the\n {{request_id}} placeholder to provide users with a unique\n identifier to be able to trace the blocked request in the logs.\n The maximum allowed size of response body is 4096 bytes after base64 encoding,\n which would be about 3070 bytes in plain text.\n\nExample: ` \"<html><head><title>Request Rejected</title></head><body>The requested URL was rejected. Please consult with your administrator.<br/><br/>Your support ID is{{request_id}}<br/><br/><a href=\\\"javascript:history.back()\\\">[Go Back]</a></body></html>\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n  ves.io.schema.rules.string.uri_ref: true\n","title":"blocking_page","maxLength":4096,"x-displayname":"Blocking Response Page Body","x-ves-example":"<html><head><title>Request Rejected</title></head><body>The requested URL was rejected. Please consult with your administrator.<br/><br/>Your support ID is: {{request_id}}<br/><br/><a href=\\\"javascript:history.back()\\\">[Go Back]</a></body></html>","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096","ves.io.schema.rules.string.uri_ref":"true"}},"response_code":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"app_firewallDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a app_firewall","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.app_firewall.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"}}},"app_firewallDetectionSetting":{"type":"object","description":"Specifies detection settings to be used by WAF","title":"Detection Settings","x-displayname":"Detection Settings","x-ves-displayorder":"1,2,12,5,8,16","x-ves-oneof-field-bot_protection_choice":"[\"bot_protection_setting\",\"default_bot_setting\"]","x-ves-oneof-field-false_positive_suppression":"[\"disable_suppression\",\"enable_suppression\"]","x-ves-oneof-field-signatures_staging_settings":"[\"disable_staging\",\"stage_new_and_updated_signatures\",\"stage_new_signatures\"]","x-ves-oneof-field-threat_campaign_choice":"[\"disable_threat_campaigns\",\"enable_threat_campaigns\"]","x-ves-oneof-field-violation_detection_setting":"[\"default_violation_settings\",\"violation_settings\"]","x-ves-proto-message":"ves.io.schema.app_firewall.DetectionSetting","properties":{"bot_protection_setting":{"$ref":"#/components/schemas/app_firewallBotProtectionSetting"},"default_bot_setting":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_violation_settings":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_staging":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_suppression":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_threat_campaigns":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_suppression":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_threat_campaigns":{"$ref":"#/components/schemas/ioschemaEmpty"},"signature_selection_setting":{"$ref":"#/components/schemas/app_firewallSignatureSelectionSetting"},"stage_new_and_updated_signatures":{"$ref":"#/components/schemas/app_firewallSignaturesStagingSettings"},"stage_new_signatures":{"$ref":"#/components/schemas/app_firewallSignaturesStagingSettings"},"violation_settings":{"$ref":"#/components/schemas/app_firewallViolationSettings"}}},"app_firewallGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read app_firewall","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.app_firewall.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/app_firewallCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/app_firewallReplaceRequest"},"spec":{"$ref":"#/components/schemas/app_firewallGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/app_firewallStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"app_firewallGetResponseFormatCode":{"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"},"app_firewallGetSpecType":{"type":"object","description":"Get Application Firewall","title":"Get Application Firewall","x-displayname":"Get Application Firewall","x-ves-oneof-field-allowed_response_codes_choice":"[\"allow_all_response_codes\",\"allowed_response_codes\"]","x-ves-oneof-field-anonymization_setting":"[\"custom_anonymization\",\"default_anonymization\",\"disable_anonymization\"]","x-ves-oneof-field-blocking_page_choice":"[\"blocking_page\",\"use_default_blocking_page\"]","x-ves-oneof-field-bot_protection_choice":"[\"bot_protection_setting\",\"default_bot_setting\"]","x-ves-oneof-field-detection_setting_choice":"[\"ai_risk_based_blocking\",\"default_detection_settings\",\"detection_settings\"]","x-ves-oneof-field-enforcement_mode_choice":"[\"blocking\",\"monitoring\"]","x-ves-proto-message":"ves.io.schema.app_firewall.GetSpecType","properties":{"ai_risk_based_blocking":{"$ref":"#/components/schemas/app_firewallAiRiskBasedBlocking"},"allow_all_response_codes":{"$ref":"#/components/schemas/ioschemaEmpty"},"allowed_response_codes":{"$ref":"#/components/schemas/app_firewallAllowedResponseCodes"},"blocking":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocking_page":{"$ref":"#/components/schemas/app_firewallCustomBlockingPage"},"bot_protection_setting":{"$ref":"#/components/schemas/app_firewallBotProtectionSetting"},"custom_anonymization":{"$ref":"#/components/schemas/app_firewallAnonymizationSetting"},"default_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_bot_setting":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_detection_settings":{"$ref":"#/components/schemas/ioschemaEmpty"},"detection_settings":{"$ref":"#/components/schemas/app_firewallDetectionSetting"},"disable_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitoring":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_default_blocking_page":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"app_firewallListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of app_firewall","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.app_firewall.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/app_firewallListResponseItem"},"x-displayname":"Items"}}},"app_firewallListResponseItem":{"type":"object","description":"By default a summary of app_firewall 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 app_firewall","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.app_firewall.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this app_firewall","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this app_firewall","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates app_firewall is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/app_firewallGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this app_firewall","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this app_firewall\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/app_firewallStatusObject"},"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 app_firewall\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"app_firewallMetricData":{"type":"object","description":"Metric data contains the metric type and the corresponding metric value","title":"Metric Data","x-displayname":"Metric Data","x-ves-proto-message":"ves.io.schema.app_firewall.MetricData","properties":{"data":{"type":"array","description":" List of metric data ","title":"Data","items":{"$ref":"#/components/schemas/schemaapp_firewallMetricTypeData"},"x-displayname":"Data"},"type":{"$ref":"#/components/schemas/schemaapp_firewallMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"}}},"app_firewallMetricLabel":{"type":"string","description":"Labels in the  Application Firewall metrics.\n\nRule hits counter and the security events counter can be sliced and diced based\non one or more labels listed below.\n\nNamespace in which this App Firewall instance is running\nVirtual host under which this App Firewall instance is running\nName of the BOT CLASSIFICATION\nName of the EVENT TYPE","enum":["NAMESPACE","VIRTUAL_HOST","BOT_CLASSIFICATION","EVENT_TYPE"],"default":"NAMESPACE","x-displayname":"Application Firewall Metric Label","x-ves-proto-enum":"ves.io.schema.app_firewall.MetricLabel"},"app_firewallMetricsRequest":{"type":"object","description":"Request to get the metrics for App Firewall","title":"Metrics Request","x-displayname":"Metrics Request","x-ves-proto-message":"ves.io.schema.app_firewall.MetricsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"type":"array","description":" Select fields to be returned in the response.\n One or more fields in {BOT_DETECTION, ATTACKED_REQUESTS, BLOCKED_REQUESTS, TOTAL_REQUESTS} can be specified.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Selector","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/schemaapp_firewallMetricType"},"x-displayname":"Field Selector","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"filter":{"type":"string","description":" filter is used to specify the list of matchers\n syntax for filter := {[<matcher>]}\n <matcher> := <label><operator>\"<value>\"\n   <label> := string\n   <value> := string\n   <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n     =  : equal to\n     != : not equal to\n     =~ : regex match\n     !~ : not regex match\n\n Optional: If not specified, metric will be aggregated based on the group_by labels. \n\nExample: ` \"{NAMESPACE=\\\"book-info\\\"}\"`","title":"Label Filter","x-displayname":"Filter","x-ves-example":"{NAMESPACE=\\\"book-info\\\"}"},"group_by":{"type":"array","description":" Aggregate data by zero or more labels","title":"Group by","items":{"$ref":"#/components/schemas/app_firewallMetricLabel"},"x-displayname":"Group By"},"is_trend_request":{"type":"boolean","description":" Trend value computation requested by the user\n Optional: default is false\n\nExample: ` \"true\"`","format":"boolean","x-displayname":"Trend calculation requested by the user","x-ves-example":"true"},"namespace":{"type":"string","description":"\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":"\n start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"app_firewallMetricsResponse":{"type":"object","description":"Metrics for DC Cluster Groups","title":"Metrics Response","x-displayname":"Metrics Response","x-ves-proto-message":"ves.io.schema.app_firewall.MetricsResponse","properties":{"data":{"type":"array","description":" Data contains time-series metric data for App Firewall","title":"Data","items":{"$ref":"#/components/schemas/app_firewallMetricData"},"x-displayname":"Data"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"app_firewallReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a app_firewall","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.app_firewall.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/app_firewallReplaceSpecType"}}},"app_firewallReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.app_firewall.ReplaceResponse"},"app_firewallReplaceSpecType":{"type":"object","description":"Replace Application Firewall","title":"Replace Application Firewall","x-displayname":"Replace Application Firewall","x-ves-oneof-field-allowed_response_codes_choice":"[\"allow_all_response_codes\",\"allowed_response_codes\"]","x-ves-oneof-field-anonymization_setting":"[\"custom_anonymization\",\"default_anonymization\",\"disable_anonymization\"]","x-ves-oneof-field-blocking_page_choice":"[\"blocking_page\",\"use_default_blocking_page\"]","x-ves-oneof-field-bot_protection_choice":"[\"bot_protection_setting\",\"default_bot_setting\"]","x-ves-oneof-field-detection_setting_choice":"[\"ai_risk_based_blocking\",\"default_detection_settings\",\"detection_settings\"]","x-ves-oneof-field-enforcement_mode_choice":"[\"blocking\",\"monitoring\"]","x-ves-proto-message":"ves.io.schema.app_firewall.ReplaceSpecType","properties":{"ai_risk_based_blocking":{"$ref":"#/components/schemas/app_firewallAiRiskBasedBlocking"},"allow_all_response_codes":{"$ref":"#/components/schemas/ioschemaEmpty"},"allowed_response_codes":{"$ref":"#/components/schemas/app_firewallAllowedResponseCodes"},"blocking":{"$ref":"#/components/schemas/ioschemaEmpty"},"blocking_page":{"$ref":"#/components/schemas/app_firewallCustomBlockingPage"},"bot_protection_setting":{"$ref":"#/components/schemas/app_firewallBotProtectionSetting"},"custom_anonymization":{"$ref":"#/components/schemas/app_firewallAnonymizationSetting"},"default_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_bot_setting":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_detection_settings":{"$ref":"#/components/schemas/ioschemaEmpty"},"detection_settings":{"$ref":"#/components/schemas/app_firewallDetectionSetting"},"disable_anonymization":{"$ref":"#/components/schemas/ioschemaEmpty"},"monitoring":{"$ref":"#/components/schemas/ioschemaEmpty"},"use_default_blocking_page":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"app_firewallRiskBasedBlockingAction":{"type":"string","description":"Action to be performed on the request\n\nLog and block\nLog only","title":"Risk Based Blocking Action","enum":["AI_BLOCK","AI_REPORT"],"default":"AI_BLOCK","x-displayname":"Risk Based Blocking Action","x-ves-proto-enum":"ves.io.schema.app_firewall.RiskBasedBlockingAction"},"app_firewallSignatureSelectionSetting":{"type":"object","description":"Attack Signatures are patterns that identify attacks on a web application and its components","title":"Attack Signatures","x-displayname":"Attack Signatures","x-ves-displayorder":"5,1","x-ves-oneof-field-attack_type_setting":"[\"attack_type_settings\",\"default_attack_type_settings\"]","x-ves-oneof-field-signature_selection_by_accuracy":"[\"high_medium_accuracy_signatures\",\"high_medium_low_accuracy_signatures\",\"only_high_accuracy_signatures\"]","x-ves-proto-message":"ves.io.schema.app_firewall.SignatureSelectionSetting","properties":{"attack_type_settings":{"$ref":"#/components/schemas/app_firewallAttackTypeSettings"},"default_attack_type_settings":{"$ref":"#/components/schemas/ioschemaEmpty"},"high_medium_accuracy_signatures":{"$ref":"#/components/schemas/ioschemaEmpty"},"high_medium_low_accuracy_signatures":{"$ref":"#/components/schemas/ioschemaEmpty"},"only_high_accuracy_signatures":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"app_firewallSignaturesStagingSettings":{"type":"object","description":"Attack Signatures staging configuration.","title":"Attack Signatures Staging Settings","x-displayname":"Attack Signatures Staging Settings","x-ves-proto-message":"ves.io.schema.app_firewall.SignaturesStagingSettings","properties":{"staging_period":{"type":"integer","description":" Define staging period in days. The default staging period is 7 days and the max supported staging period is\n 20 days.\n\nExample: ` \"7\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 20\n","title":"Staging Period","format":"int64","x-displayname":"Staging Period","x-ves-example":"7","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"20"}}}},"app_firewallStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Application Firewall Status Object","x-displayname":"Application Firewall Status Object","x-ves-proto-message":"ves.io.schema.app_firewall.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"app_firewallViolationSettings":{"type":"object","description":"Specifies violation settings to be used by WAF","title":"Violation Settings","x-displayname":"Violation Settings","x-ves-proto-message":"ves.io.schema.app_firewall.ViolationSettings","properties":{"disabled_violation_types":{"type":"array","description":" List of violations to be excluded\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 40\n  ves.io.schema.rules.repeated.unique: true\n","title":"Disabled Violations","maxItems":40,"items":{"$ref":"#/components/schemas/app_firewallAppFirewallViolationType"},"x-displayname":"Disabled Violations","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"40","ves.io.schema.rules.repeated.unique":"true"}}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"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"}}},"schemaHttpStatusCode":{"type":"string","description":"HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nUri Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHttp Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code","title":"HttpStatusCode","enum":["EmptyStatusCode","Continue","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","UseProxy","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","URITooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HTTPVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"default":"EmptyStatusCode","x-displayname":"HTTP Status Code","x-ves-proto-enum":"ves.io.schema.HttpStatusCode"},"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"}}},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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"}}},"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"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"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"}}},"schemaapp_firewallMetricType":{"type":"string","description":"List of metric types\n","title":"Metric Type","enum":["BOT_DETECTION","ATTACKED_REQUESTS","BLOCKED_REQUESTS","TOTAL_REQUESTS"],"default":"BOT_DETECTION","x-displayname":"Metric Type","x-ves-proto-enum":"ves.io.schema.app_firewall.MetricType"},"schemaapp_firewallMetricTypeData":{"type":"object","description":"Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.","title":"Metric Type Data","x-displayname":"Metric Type Data","x-ves-proto-message":"ves.io.schema.app_firewall.MetricTypeData","properties":{"key":{"type":"object","description":" Key contains the name/value pair.\n \"name\" is the label name defined in \"MetricLabel\"","title":"Key","x-displayname":"Key"},"value":{"type":"array","description":" List of metric values.","title":"Value","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Value"}}}}}}