@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0184.public.ves.io.schema.shape.bot_defense.protected_application.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.protected_application","description":"Configures application protected by Bot Defense","version":""},"paths":{"/api/shape/bot/namespaces/system/apikey":{"get":{"summary":"API Key","description":"Get api key","operationId":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ApiKey","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationApiKeyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-customapi-apikey"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ApiKey"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/system/regions":{"get":{"summary":"Regions","description":"Get protected apps regions list","operationId":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.RegionsList","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationRegionsListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-customapi-regionslist"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.RegionsList"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{metadata.namespace}/protected_applications":{"post":{"summary":"Create Protected Application","description":"Create applications protected by Bot Defense","operationId":"ves.io.schema.shape.bot_defense.protected_application.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationCreateResponse"}}}},"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/protected_applicationCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-api-create"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.API.Create"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{metadata.namespace}/protected_applications/{metadata.name}":{"put":{"summary":"Replace Protected Application","description":"Replace applications protected by Bot Defense","operationId":"ves.io.schema.shape.bot_defense.protected_application.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationReplaceResponse"}}}},"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/protected_applicationReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-api-replace"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.API.Replace"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/protected_applications":{"get":{"summary":"List Protected Application","description":"List the set of protected_application in a namespace","operationId":"ves.io.schema.shape.bot_defense.protected_application.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationListResponse"}}}},"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 protected_application","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-api-list"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.API.List"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/protected_applications/{name}":{"get":{"summary":"Get Protected Application","description":"Get applications protected by Bot Defense","operationId":"ves.io.schema.shape.bot_defense.protected_application.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-api-get"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.API.Get"},"delete":{"summary":"Delete Protected Application","description":"Delete the specified protected_application","operationId":"ves.io.schema.shape.bot_defense.protected_application.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/protected_applicationDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-api-delete"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.API.Delete"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/protected_applications/{name}/config":{"get":{"summary":"Connector Configuration","description":"Get Connector config","operationId":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ConnectorConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationConnectorConfigResponse"}}}},"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 is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Application Name\n\nx-example: \"App 8000\"\nProtected application name","in":"path","required":true,"x-displayname":"Application Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-customapi-connectorconfig"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ConnectorConfig"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/protected_applications/{name}/template":{"get":{"summary":"Template Connector","description":"Get iApp template","operationId":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.TemplateConnector","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/protected_applicationTemplateConnectorResponse"}}}},"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 is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Application Name\n\nx-example: \"billing-app\"\nProtected application name","in":"path","required":true,"x-displayname":"Application Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-protected_application-customapi-templateconnector"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI.TemplateConnector"},"x-displayname":"Protected Application","x-ves-proto-service":"ves.io.schema.shape.bot_defense.protected_application.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Protected Application","x-ves-proto-package":"ves.io.schema.shape.bot_defense.protected_application","components":{"schemas":{"bot_defenseprotected_applicationCreateSpecType":{"type":"object","description":"Create applications protected by Bot Defense","title":"Create protected application","x-displayname":"Create Protected Application","x-ves-oneof-field-connector_type_choice":"[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"salesforce_commerce_connector\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.CreateSpecType","properties":{"adobe_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"big_ip_iapp":{"$ref":"#/components/schemas/ioschemaEmpty"},"cloudflare":{"$ref":"#/components/schemas/cloudflareCloudflareType"},"cloudfront":{"$ref":"#/components/schemas/cloudfrontCloudfrontType"},"custom_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"f5_big_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"region":{"$ref":"#/components/schemas/protected_applicationBotDefenseRegion"},"salesforce_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"bot_defenseprotected_applicationGetSpecType":{"type":"object","description":"Get applications protected by Bot Defense","title":"Get Protected Application","x-displayname":"Get Protected Application","x-ves-oneof-field-connector_type_choice":"[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"not_applicable_connector\",\"salesforce_commerce_connector\",\"xc_mesh\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.GetSpecType","properties":{"adobe_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"app_id":{"type":"string","description":" Protected application ID","x-displayname":"Application ID"},"big_ip_iapp":{"$ref":"#/components/schemas/ioschemaEmpty"},"cloudflare":{"$ref":"#/components/schemas/cloudflareCloudflareType"},"cloudfront":{"$ref":"#/components/schemas/cloudfrontCloudfrontType"},"custom_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"f5_big_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"not_applicable_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"region":{"$ref":"#/components/schemas/protected_applicationBotDefenseRegion"},"reload_header_name":{"type":"string","description":" Protected application Reload Header Name\n Header that is used for SDK configuration sync.","x-displayname":"Reload Header Name"},"salesforce_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"status":{"type":"string","description":" Protected application status","x-displayname":"Status"},"xc_mesh":{"$ref":"#/components/schemas/protected_applicationXCMeshConnector"}}},"bot_defenseprotected_applicationReplaceSpecType":{"type":"object","description":"Replace applications protected by Bot Defense","title":"Replace protected application","x-displayname":"Replace Protected Application","x-ves-oneof-field-connector_type_choice":"[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"not_applicable_connector\",\"salesforce_commerce_connector\",\"xc_mesh\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ReplaceSpecType","properties":{"adobe_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"big_ip_iapp":{"$ref":"#/components/schemas/ioschemaEmpty"},"cloudflare":{"$ref":"#/components/schemas/cloudflareCloudflareType"},"cloudfront":{"$ref":"#/components/schemas/cloudfrontCloudfrontType"},"custom_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"f5_big_ip":{"$ref":"#/components/schemas/ioschemaEmpty"},"not_applicable_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"salesforce_commerce_connector":{"$ref":"#/components/schemas/ioschemaEmpty"},"xc_mesh":{"$ref":"#/components/schemas/protected_applicationXCMeshConnector"}}},"cloudflareCloudflareType":{"type":"object","description":"Bot Defense policy configuration for Cloudflare","title":"CloudflareType","x-displayname":"Cloudflare","x-ves-displayorder":"20,1,2,3,24,35,103,102,100","x-ves-oneof-field-java_script_choice":"[\"disable_js_insert\",\"js_insertion_rules\",\"manual_js_insert\"]","x-ves-oneof-field-mobile_sdk_choice":"[\"disable_mobile_sdk\",\"mobile_sdk_config\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.CloudflareType","properties":{"continue_mitigation_action_hdr":{"type":"string","description":" A case-insensitive HTTP header name for Continue Mitigation Action when add header selected.\n\nExample: ` \"x-f5-bot-inference\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_header_field: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"Continue Header name","maxLength":256,"x-displayname":"Header Name For Continue Mitigation Action","x-ves-example":"x-f5-bot-inference","x-ves-validation-rules":{"ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256"}},"disable_js_insert":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_mobile_sdk":{"$ref":"#/components/schemas/ioschemaEmpty"},"js_insertion_rules":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptInsertType"},"loglevel":{"$ref":"#/components/schemas/protected_applicationcloudflareLogLevel"},"manual_js_insert":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptInsertManualType"},"mobile_sdk_config":{"$ref":"#/components/schemas/protected_applicationcloudflareMobileSDKConfigType"},"protected_endpoints":{"type":"array","description":" List of protected endpoints (max 128 items)\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"protected_endpoints","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareProtectedEndpointType"},"x-displayname":"Protected Endpoints","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"timeout":{"type":"integer","description":" The timeout for the inference check, in milliseconds\n\nExample: ` \"300\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 60000\n","title":"timeout","format":"int64","x-displayname":"Timeout","x-ves-example":"300","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"60000"}},"trusted_clients":{"type":"array","description":" Define your allowlists to skip Bot Defense inference processing\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 256\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Trusted Client Rules","maxItems":256,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareClientBypassRule"},"x-displayname":"Trusted Client Rules","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"256","ves.io.schema.rules.repeated.unique_metadata_name":"true"}}}},"cloudflarePathType":{"type":"object","description":"Uri Path","title":"Path case sensitive","x-displayname":"Path","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.PathType","properties":{"caseinsensitive":{"type":"boolean","description":" Should path be searched case insensitive;","title":"Case insensitive","format":"boolean","x-displayname":"Case insensitive"},"path":{"type":"string","description":" Uri Path\n\nExample: ` \"/not-found\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.pattern: ^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$\n","title":"Path","minLength":1,"maxLength":256,"x-displayname":"Path","x-ves-example":"/not-found","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.pattern":"^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$"}}}},"cloudfrontCloudfrontType":{"type":"object","description":"Bot Defense policy configuration for AWS Cloudfront","title":"CloudfrontType","x-displayname":"Cloudfront","x-ves-displayorder":"19,20,1,2,3,24,35,103,102,100,101","x-ves-oneof-field-aws_configuration_type_choice":"[\"aws_configuration_id_selector\",\"aws_configuration_tag_selector\",\"disable_aws_configuration\"]","x-ves-oneof-field-java_script_choice":"[\"disable_js_insert\",\"js_insertion_rules\",\"manual_js_insert\"]","x-ves-oneof-field-mobile_sdk_choice":"[\"disable_mobile_sdk\",\"mobile_sdk_config\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.CloudfrontType","properties":{"aws_configuration_id_selector":{"$ref":"#/components/schemas/cloudfrontDistributionIDList"},"aws_configuration_tag_selector":{"$ref":"#/components/schemas/cloudfrontDistributionTagList"},"continue_mitigation_action_hdr":{"type":"string","description":" A case-insensitive HTTP header name for Continue Mitigation Action when add header selected.\n\nExample: ` \"x-f5-bot-inference\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_header_field: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"Continue Header name","maxLength":256,"x-displayname":"Header Name For Continue Mitigation Action","x-ves-example":"x-f5-bot-inference","x-ves-validation-rules":{"ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256"}},"data_sample":{"type":"integer","description":" Limit on amount of request-body data (other than f5 telemetry) to send\n for analysis (limit 1,048,576 == 1 MiByte)\n\nExample: ` \"1024\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 1048576\n","title":"DataSample","format":"int64","x-displayname":"Body Sample Size Limit","x-ves-example":"1024","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"1048576"}},"disable_aws_configuration":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_js_insert":{"$ref":"#/components/schemas/ioschemaEmpty"},"disable_mobile_sdk":{"$ref":"#/components/schemas/ioschemaEmpty"},"js_insertion_rules":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptInsertType"},"loglevel":{"$ref":"#/components/schemas/protected_applicationcloudfrontLogLevel"},"manual_js_insert":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptInsertManualType"},"mobile_sdk_config":{"$ref":"#/components/schemas/protected_applicationcloudfrontMobileSDKConfigType"},"protected_endpoints":{"type":"array","description":" List of protected endpoints (max 128 items)\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"protected_endpoints","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontProtectedEndpointType"},"x-displayname":"Protected Endpoints","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"timeout":{"type":"integer","description":" The timeout for the inference check, in milliseconds\n\nExample: ` \"300\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 60000\n","title":"timeout","format":"int64","x-displayname":"Timeout","x-ves-example":"300","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"60000"}},"trusted_clients":{"type":"array","description":" Define your allowlists to skip Bot Defense inference processing\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 256\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Trusted Client Rules","maxItems":256,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontClientBypassRule"},"x-displayname":"Trusted Client Rules","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"256","ves.io.schema.rules.repeated.unique_metadata_name":"true"}}}},"cloudfrontDistributionIDList":{"type":"object","description":"x-example: \"ABCDEFGHI0JKLM\"\nList of CloudFront distributions","title":"DistributionIDList","x-displayname":"ID List","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.DistributionIDList","properties":{"ids":{"type":"array","description":" Add AWS CloudFront distribution ID, e.g. ABCDEFGHI0JKLM\n\nExample: ` \"ABCDEFGHI0JKLM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 32\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.items.string.pattern: ^[A-Z0-9]+$\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"ids","minItems":1,"maxItems":16,"items":{"type":"string","minLength":1,"maxLength":32},"x-displayname":"ID","x-ves-example":"ABCDEFGHI0JKLM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"32","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.items.string.pattern":"^[A-Z0-9]+$","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"cloudfrontDistributionTagList":{"type":"object","description":"CloudFront distribution tag list","title":"DistributionTagList","x-displayname":"Distribution Tag List","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.DistributionTagList","properties":{"tags":{"type":"object","description":" List contains the Cloudfront distribution selection by tags\n key is a AWS tag name, and the value is regular expression to match\n\nExample: ` \"{\"env\"\".*\"}\"`\n\nRequired: YES\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.max_pairs: 20\n  ves.io.schema.rules.map.min_pairs: 1\n  ves.io.schema.rules.map.values.string.max_len: 256\n  ves.io.schema.rules.map.values.string.min_len: 1\n  ves.io.schema.rules.map.values.string.regex: true\n  ves.io.schema.rules.message.required: true\n","title":"tags","x-displayname":"Tags","x-ves-example":"{\"env\": \".*\"}","x-ves-required":"true","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.max_pairs":"20","ves.io.schema.rules.map.min_pairs":"1","ves.io.schema.rules.map.values.string.max_len":"256","ves.io.schema.rules.map.values.string.min_len":"1","ves.io.schema.rules.map.values.string.regex":"true","ves.io.schema.rules.message.required":"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"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"ioschemaPathMatcherType":{"type":"object","description":"Path match of the URI can be either be, Prefix match or exact match or regular expression match","title":"PathMatcherType","x-displayname":"Path to Match","x-ves-displayorder":"4","x-ves-oneof-field-path_match":"[\"path\",\"prefix\",\"regex\"]","x-ves-proto-message":"ves.io.schema.PathMatcherType","properties":{"path":{"type":"string","description":"Exclusive with [prefix regex]\n Exact path value to match\n\nExample: ` \"/logout\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"exact","maxLength":256,"x-displayname":"Exact","x-ves-example":"/logout","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"prefix":{"type":"string","description":"Exclusive with [path regex]\n Path prefix to match (e.g. the value / will match on all paths)\n\nExample: ` \"/register/\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"prefix","maxLength":256,"x-displayname":"Prefix","x-ves-example":"/register/","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"regex":{"type":"string","description":"Exclusive with [path prefix]\n Regular expression of path match (e.g. the value .* will match on all paths)\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.regex: true\n","title":"regex","minLength":1,"maxLength":256,"x-displayname":"Regex","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.regex":"true"}}}},"protected_applicationApiEndpoint":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ApiEndpoint","properties":{"telemetry_prefix":{"type":"string","description":" Telemetry Prefix for a region","title":"Telemetry Prefix","x-displayname":"Telemetry Prefix"},"url":{"type":"string","description":" API hostname for a region","title":"API Hostname","x-displayname":"API Hostname"}}},"protected_applicationApiKeyResponse":{"type":"object","description":"Response for getting API key","title":"ApiKeyResponse","x-displayname":"ApiKey Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ApiKeyResponse","properties":{"api_key":{"type":"string","description":" API Key","title":"api_key","x-displayname":"API Key"}}},"protected_applicationBotDefenseRegion":{"type":"string","description":"Defines a selection for Bot Defense region\n\n - US: US\n\nUnited States of America\n - EU: EU\n\nEuropean Union\n - ASIA: ASIA\n\nAsia\n - CA: CA\n\nCanada","title":"BotDefenseRegion","enum":["US","EU","ASIA","CA"],"default":"US","x-displayname":"Bot Defense Region","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.BotDefenseRegion"},"protected_applicationConnectorConfigResponse":{"type":"object","description":"Connector configuration response.","title":"ConnectorConfigResponse","x-displayname":"Connector Configuration Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ConnectorConfigResponse","properties":{"config":{"type":"string","description":" Connector configuration","title":"Connector Config","x-displayname":"Connector Config"},"name":{"type":"string","description":" Connector config file name","title":"Connector name","x-displayname":"Connector file name"}}},"protected_applicationCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of protected_application","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/bot_defenseprotected_applicationCreateSpecType"}}},"protected_applicationCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/bot_defenseprotected_applicationGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"protected_applicationDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a protected_application","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.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"}}},"protected_applicationGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read protected_application","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/protected_applicationCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/protected_applicationReplaceRequest"},"spec":{"$ref":"#/components/schemas/bot_defenseprotected_applicationGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/protected_applicationStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"protected_applicationGetResponseFormatCode":{"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"},"protected_applicationListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of protected_application","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.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/protected_applicationListResponseItem"},"x-displayname":"Items"}}},"protected_applicationListResponseItem":{"type":"object","description":"By default a summary of protected_application 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 protected_application","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this protected_application","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this protected_application","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates protected_application is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/bot_defenseprotected_applicationGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this protected_application","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this protected_application\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/protected_applicationStatusObject"},"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 protected_application\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"protected_applicationRegion":{"type":"object","description":"Region for protected application","title":"Region Details","x-displayname":"Region Details","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.Region","properties":{"mobile_endpoint":{"$ref":"#/components/schemas/protected_applicationApiEndpoint"},"region":{"$ref":"#/components/schemas/protected_applicationBotDefenseRegion"},"web_endpoint":{"$ref":"#/components/schemas/protected_applicationApiEndpoint"}}},"protected_applicationRegionsListResponse":{"type":"object","description":"Response for getting regions list","title":"RegionsListResponse","x-displayname":"RegionsList Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.RegionsListResponse","properties":{"regions":{"type":"array","description":" List of regions for protected applications","title":"Regions","items":{"$ref":"#/components/schemas/protected_applicationRegion"},"x-displayname":"Regions List"}}},"protected_applicationReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a protected_application","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/bot_defenseprotected_applicationReplaceSpecType"}}},"protected_applicationReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.ReplaceResponse"},"protected_applicationStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"protected_applicationTemplateConnectorResponse":{"type":"object","description":"Response for iApp template connector","title":"TemplateConnectorResponse","x-displayname":"Template Connector Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.TemplateConnectorResponse","properties":{"name":{"type":"string","description":" iApp template connector file name","title":"Template Connector name","x-displayname":"Template connector file name"},"template":{"type":"string","description":" iApp template connector","title":"Template Connector","x-displayname":"Template Connector"}}},"protected_applicationXCMeshConnector":{"type":"object","description":"Configures HTTP Load Balancer connector","title":"XCMeshConnector","x-displayname":"HTTP Load Balancer","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.XCMeshConnector","properties":{"http_load_balancer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"protected_applicationcloudflareBlockMitigationChoiceType":{"type":"object","description":"Block Response.","title":"BlockMitigationChoiceType","x-displayname":"Block Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.BlockMitigationChoiceType","properties":{"body":{"type":"string","description":" Custom body message\n\nExample: ` \"<p> Your request was blocked </p>\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n","title":"body","maxLength":4096,"x-displayname":"Body","x-ves-example":"<p> Your request was blocked </p>","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"content_type":{"type":"string","description":" Content type to use in a block response\n\nExample: ` \"text/html\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"content_type","maxLength":128,"x-displayname":"Content Type","x-ves-example":"text/html","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudflareBlockMobileMitigationChoiceType":{"type":"object","description":"Block Response.","title":"BlockMobileMitigationChoiceType","x-displayname":"Block Response for Mobile","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.BlockMobileMitigationChoiceType","properties":{"body":{"type":"string","description":" Custom body message\n\nExample: ` \"<p> Your request was blocked </p>\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n","title":"body","maxLength":4096,"x-displayname":"Body","x-ves-example":"<p> Your request was blocked </p>","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"content_type":{"type":"string","description":" Content type to use in a block response\n\nExample: ` \"text/html\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"content_type","maxLength":128,"x-displayname":"Content Type","x-ves-example":"text/html","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudflareClientBypassRule":{"type":"object","description":"Client source rule specifies the sources to be trusted","title":"ClientBypassRule","x-displayname":"Client Bypass Rule","x-ves-displayorder":"1,3","x-ves-oneof-field-client_source_choice":"[\"http_header\",\"ip_prefix\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.ClientBypassRule","properties":{"http_header":{"$ref":"#/components/schemas/protected_applicationcloudflareHttpHeaderMatcherList"},"ip_prefix":{"type":"string","description":"Exclusive with [http_header]\n IP prefix string\n\nExample: ` \"192.168.20.0/24\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip_prefix: true\n","title":"ip prefix","x-displayname":"IP Prefix","x-ves-example":"192.168.20.0/24","x-ves-validation-rules":{"ves.io.schema.rules.string.ip_prefix":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"}}},"protected_applicationcloudflareContinueMitigationChoiceType":{"type":"object","description":"Continue mitigation action.","title":"ShapeBotFlagMitigationActionChoiceType","x-displayname":"Select Continue Bot Mitigation Action","x-ves-oneof-field-add_header_choice":"[\"add_header\",\"no_header\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.ContinueMitigationChoiceType","properties":{"add_header":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_header":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"protected_applicationcloudflareHeaderMatcherType":{"type":"object","description":"Header match is done using the name of the header and its value.\nThe value match is done using one of the following\n    regex match on value\n    exact match of value\n    presence of header","title":"HeaderMatcherType","x-displayname":"Header To Match","x-ves-oneof-field-value_match":"[\"exact\",\"regex\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.HeaderMatcherType","properties":{"exact":{"type":"string","description":"Exclusive with [regex]\n Header value to match exactly\n\nExample: ` \"application/json\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"exact","maxLength":256,"x-displayname":"Exact","x-ves-example":"application/json","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"name":{"type":"string","description":" Name of the header\n\nExample: ` \"Content-Type\"`\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  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":256,"x-displayname":"Name","x-ves-example":"Content-Type","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}},"regex":{"type":"string","description":"Exclusive with [exact]\n Regex match of the header value in re2 format\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n  ves.io.schema.rules.string.regex: true\n","title":"regex","maxLength":256,"x-displayname":"Regex","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true","ves.io.schema.rules.string.regex":"true"}}}},"protected_applicationcloudflareHttpHeaderMatcherList":{"type":"object","description":"Request header name and value pairs","title":"HTTP Header","x-displayname":"HTTP Header","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.HttpHeaderMatcherList","properties":{"headers":{"type":"array","description":" List of HTTP header name and value pairs\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"headers","maxItems":16,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareHeaderMatcherType"},"x-displayname":"HTTP Headers","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}}}},"protected_applicationcloudflareJavaScriptExclusionRule":{"type":"object","description":"Define JavaScript insertion exclusion rule","title":"JavaScriptExclusionRule","x-displayname":"JavaScript Insertion Exclusion Rule","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptExclusionRule","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"path":{"$ref":"#/components/schemas/ioschemaPathMatcherType"}}},"protected_applicationcloudflareJavaScriptInsertAllType":{"type":"object","description":"x-displayName: \"Insert Bot Defense JavaScript In All Pages\"\nInsert Bot Defense JavaScript in all pages","title":"JavaScriptInsertAllType","properties":{"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptLocation"},"js_download_path":{"type":"string","description":"x-displayName: \"Web Client JavaScript Path\"\nx-example: \"/common.js\"\nWeb client will fetch F5 Client Java Script from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.","title":"js_download_path"}}},"protected_applicationcloudflareJavaScriptInsertAllWithExceptionsType":{"type":"object","description":"x-displayName: \"Insert JavaScript In All Pages With The Exceptions\"\nInsert Bot Defense JavaScript in all pages  with the exceptions","title":"JavaScriptInsertAllWithExceptionsType","properties":{"exclude_list":{"type":"array","description":"x-displayName: \"Exclude Pages\"\nOptional JavaScript insertions exclude list of domain and path matchers.","title":"exclude_list","items":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptExclusionRule"}},"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptLocation"},"js_download_path":{"type":"string","description":"x-displayName: \"Web Client JavaScript Path\"\nx-example: \"/common.js\"\nWeb client will fetch F5 Client Java Script from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.","title":"js_download_path"}}},"protected_applicationcloudflareJavaScriptInsertManualType":{"type":"object","description":"Insert JavaScript manually","title":"manual_js_insert","x-displayname":"Insert JavaScript Manually","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertManualType","properties":{"js_download_path":{"type":"string","description":" Web client will fetch F5 Client Java Script from this path.\n This path must not conflict with any other website/application paths.\n\n If not specified, default to ‘/common.js’.\n\nExample: ` \"/common.js\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n","title":"js_download_path","x-displayname":"Web Client JavaScript Path","x-ves-example":"/common.js","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true"}}}},"protected_applicationcloudflareJavaScriptInsertType":{"type":"object","description":"This defines custom JavaScript insertion rules for Bot Defense Policy.","title":"JavaScriptInsertType","x-displayname":"JavaScript Custom Insertion Rules","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertType","properties":{"exclude_list":{"type":"array","description":" Optional JavaScript insertions exclude list of domain and path matchers.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique: true\n","title":"exclude_list","maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptExclusionRule"},"x-displayname":"JavaScript Exclude Paths","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.unique":"true"}},"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptLocation"},"js_download_path":{"type":"string","description":" Web client will fetch F5 Client Java Script from this path.\n This path must not conflict with any other website/application paths.\n\n If not specified, default to ‘/common.js’.\n\nExample: ` \"/common.js\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n","title":"js_download_path","x-displayname":"Web Client JavaScript Path","x-ves-example":"/common.js","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true"}},"rules":{"type":"array","description":" Required list of pages to insert Bot Defense client JavaScript.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"rules","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareJavaScriptInsertionRule"},"x-displayname":"JavaScript Insertion Paths","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"protected_applicationcloudflareJavaScriptInsertionRule":{"type":"object","description":"This defines a rule for Bot Defense JavaScript insertion.","title":"JavaScriptInsertionRule","x-displayname":"JavaScript Insertion Rule","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-oneof-field-uri_path":"[\"exact_path\",\"glob\",\"prefix\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertionRule","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"exact_path":{"type":"string","description":"Exclusive with [glob prefix]\n Exact path value to match\n\nExample: ` \"/logout\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"path","maxLength":256,"x-displayname":"Path","x-ves-example":"/logout","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"glob":{"type":"string","description":"Exclusive with [exact_path prefix]\n x-example: \"/id/*\"\n x-example: \"*login\"\n Accepts wildcards * to match multiple characters or ? to match a single character\n\nExample: ` \"/id/1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.pattern: ^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$\n","title":"glob","minLength":1,"maxLength":256,"x-displayname":"Glob","x-ves-example":"/id/1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.pattern":"^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"prefix":{"type":"string","description":"Exclusive with [exact_path glob]\n Path prefix to match (e.g. the value / will match on all paths)\n\nExample: ` \"/register/\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"prefix","maxLength":256,"x-displayname":"Prefix","x-ves-example":"/register/","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}}}},"protected_applicationcloudflareJavaScriptLocation":{"type":"string","description":"All inside networks.\n\n - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED\n\nUndefined\nInsert JavaScript after <head> tag\nInsert JavaScript after </title> tag.\nInsert JavaScript before first <script> tag","title":"JavaScriptLocation","enum":["JAVA_SCRIPT_LOCATION_UNDEFINED","AFTER_HEAD","AFTER_TITLE_END","BEFORE_SCRIPT"],"default":"JAVA_SCRIPT_LOCATION_UNDEFINED","x-displayname":"JavaScript Location","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptLocation"},"protected_applicationcloudflareJavaScriptMode":{"type":"string","description":"x-displayName: \"Web Client JavaScript Mode\"\nWeb Client JavaScript Mode.\n\n - ASYNC_JS_NO_CACHING: x-displayName: \"Async JS with no Caching\"\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable\n - ASYNC_JS_CACHING: x-displayName: \"Async JS with Caching\"\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable\n - SYNC_JS_NO_CACHING: x-displayName: \"Sync JS with no Caching\"\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is non-cacheable\n - SYNC_JS_CACHING: x-displayName: \"Sync JS with Caching\"\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is cacheable","title":"JavaScript Mode","enum":["ASYNC_JS_NO_CACHING","ASYNC_JS_CACHING","SYNC_JS_NO_CACHING","SYNC_JS_CACHING"],"default":"ASYNC_JS_NO_CACHING"},"protected_applicationcloudflareLogLevel":{"type":"string","description":"Select the level of logging desired. Levels are cumulative\n(e.g. Debug includes Error, Warning, and Informational)\n\n - LOG_UNDEFINED: Undefined\n\n - LOG_ERROR: Error\n\nLog only errors\n - LOG_WARNING: Warning\n\nLog malicious requests\n - LOG_INFO: Info\n\nLog all requests\n - LOG_DEBUG: Debug\n\nLog debugging data","title":"loglevel","enum":["LOG_UNDEFINED","LOG_ERROR","LOG_WARNING","LOG_INFO","LOG_DEBUG"],"default":"LOG_UNDEFINED","x-displayname":"Log Level","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.LogLevel"},"protected_applicationcloudflareMobileClientType":{"type":"object","description":"Mobile client configuration options","title":"MobileClientType","x-displayname":"Mobile Client","x-ves-oneof-field-mitigation":"[\"block\",\"continue\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileClientType","properties":{"block":{"$ref":"#/components/schemas/protected_applicationcloudflareBlockMobileMitigationChoiceType"},"continue":{"$ref":"#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType"}}},"protected_applicationcloudflareMobileSDKConfigType":{"type":"object","description":"Mobile SDK configuration.","title":"MobileSDKConfigType","x-displayname":"Mobile SDK Configuration","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileSDKConfigType","properties":{"mobile_identifier":{"$ref":"#/components/schemas/protected_applicationcloudflareMobileTrafficIdentifierType"}}},"protected_applicationcloudflareMobileTrafficIdentifierType":{"type":"object","description":"Mobile traffic identifier type.","title":"MobileTrafficIdentifierType","x-displayname":"Mobile Traffic Identifier","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileTrafficIdentifierType","properties":{"headers":{"type":"array","description":" A list of headers that can be used to identify mobile traffic.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Mobile headers","maxItems":16,"items":{"$ref":"#/components/schemas/protected_applicationcloudflareHeaderMatcherType"},"x-displayname":"Mobile Request Identifier Headers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"protected_applicationcloudflareProtectedEndpointType":{"type":"object","description":"Add the name and description for the protected endpoint","title":"ProtectedEndpointType","x-displayname":"Protected Endpoint","x-ves-displayorder":"1,2,3,4,5,6,7,12,8","x-ves-oneof-field-client_type_choice":"[\"mobile_client\",\"web_client\",\"web_mobile_client\"]","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.ProtectedEndpointType","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"http_methods":{"type":"array","description":" List of HTTP methods.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.in: [1,3,4]\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"HTTP Methods","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/schemaBotHttpMethod"},"x-displayname":"HTTP Methods","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.in":"[1,3,4]","ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"mobile_client":{"$ref":"#/components/schemas/protected_applicationcloudflareMobileClientType"},"path":{"$ref":"#/components/schemas/cloudflarePathType"},"query":{"type":"string","description":" Enter a regular expression to match your query parameters of interest\n\nExample: ` \"(^|[^\\\\w])action=login([^\\\\w]|$)\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.regex: true\n","title":"Query","maxLength":256,"x-displayname":"Query","x-ves-example":"(^|[^\\\\w])action=login([^\\\\w]|$)","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.regex":"true"}},"web_client":{"$ref":"#/components/schemas/protected_applicationcloudflareWebClientType"},"web_mobile_client":{"$ref":"#/components/schemas/protected_applicationcloudflareWebMobileClientType"}}},"protected_applicationcloudflareRedirectMitigationChoiceType":{"type":"object","description":"Redirect.","title":"RedirectMitigationChoiceType","x-displayname":"Redirect","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.RedirectMitigationChoiceType","properties":{"location":{"type":"string","description":" x-example: \"/not-found\"\n URI location for redirect reponse\n\nExample: ` \"https://example.com/landing/page\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 512\n  ves.io.schema.rules.string.url_or_uri_ref: true\n","title":"URI","maxLength":512,"x-displayname":"Location","x-ves-example":"https://example.com/landing/page","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"512","ves.io.schema.rules.string.url_or_uri_ref":"true"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudflareWebClientType":{"type":"object","description":"Web client configuration options","title":"WebClientType","x-displayname":"Web Client","x-ves-oneof-field-mitigation":"[\"block\",\"continue\",\"redirect\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.WebClientType","properties":{"block":{"$ref":"#/components/schemas/protected_applicationcloudflareBlockMitigationChoiceType"},"continue":{"$ref":"#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType"},"redirect":{"$ref":"#/components/schemas/protected_applicationcloudflareRedirectMitigationChoiceType"}}},"protected_applicationcloudflareWebMobileClientType":{"type":"object","description":"Web and Mobile client configuration options","title":"WebMobileClientType","x-displayname":"Web and Mobile Client","x-ves-oneof-field-mobile_mitigation":"[\"block_mobile\",\"continue_mobile\"]","x-ves-oneof-field-web_mitigation":"[\"block_web\",\"continue_web\",\"redirect_web\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudflare.WebMobileClientType","properties":{"block_mobile":{"$ref":"#/components/schemas/protected_applicationcloudflareBlockMobileMitigationChoiceType"},"block_web":{"$ref":"#/components/schemas/protected_applicationcloudflareBlockMitigationChoiceType"},"continue_mobile":{"$ref":"#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType"},"continue_web":{"$ref":"#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType"},"redirect_web":{"$ref":"#/components/schemas/protected_applicationcloudflareRedirectMitigationChoiceType"}}},"protected_applicationcloudfrontBlockMitigationChoiceType":{"type":"object","description":"Block Response.","title":"BlockMitigationChoiceType","x-displayname":"Block Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.BlockMitigationChoiceType","properties":{"body":{"type":"string","description":" Custom body message\n\nExample: ` \"<p> Your request was blocked </p>\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n","title":"body","maxLength":4096,"x-displayname":"Body","x-ves-example":"<p> Your request was blocked </p>","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"content_type":{"type":"string","description":" Content type to use in a block response\n\nExample: ` \"text/html\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"content_type","maxLength":128,"x-displayname":"Content Type","x-ves-example":"text/html","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudfrontBlockMobileMitigationChoiceType":{"type":"object","description":"Block Response.","title":"BlockMobileMitigationChoiceType","x-displayname":"Block Response for Mobile","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.BlockMobileMitigationChoiceType","properties":{"body":{"type":"string","description":" Custom body message\n\nExample: ` \"<p> Your request was blocked </p>\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n","title":"body","maxLength":4096,"x-displayname":"Body","x-ves-example":"<p> Your request was blocked </p>","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"content_type":{"type":"string","description":" Content type to use in a block response\n\nExample: ` \"text/html\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"content_type","maxLength":128,"x-displayname":"Content Type","x-ves-example":"text/html","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudfrontClientBypassRule":{"type":"object","description":"Client source rule specifies the sources to be trusted","title":"ClientBypassRule","x-displayname":"Client Bypass Rule","x-ves-displayorder":"1,3","x-ves-oneof-field-client_source_choice":"[\"http_header\",\"ip_prefix\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.ClientBypassRule","properties":{"http_header":{"$ref":"#/components/schemas/protected_applicationcloudfrontHttpHeaderMatcherList"},"ip_prefix":{"type":"string","description":"Exclusive with [http_header]\n IP prefix string\n\nExample: ` \"192.168.20.0/24\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ip_prefix: true\n","title":"ip prefix","x-displayname":"IP Prefix","x-ves-example":"192.168.20.0/24","x-ves-validation-rules":{"ves.io.schema.rules.string.ip_prefix":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"}}},"protected_applicationcloudfrontContinueMitigationChoiceType":{"type":"object","description":"Continue mitigation action.","title":"ShapeBotFlagMitigationActionChoiceType","x-displayname":"Select Continue Bot Mitigation Action","x-ves-oneof-field-add_header_choice":"[\"add_header\",\"no_header\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.ContinueMitigationChoiceType","properties":{"add_header":{"$ref":"#/components/schemas/ioschemaEmpty"},"no_header":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"protected_applicationcloudfrontHeaderMatcherType":{"type":"object","description":"Header match is done using the name of the header and its value.\nThe value match is done using one of the following\n    regex match on value\n    exact match of value\n    presence of header","title":"HeaderMatcherType","x-displayname":"Header To Match","x-ves-oneof-field-value_match":"[\"exact\",\"regex\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.HeaderMatcherType","properties":{"exact":{"type":"string","description":"Exclusive with [regex]\n Header value to match exactly\n\nExample: ` \"application/json\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n","title":"exact","maxLength":256,"x-displayname":"Exact","x-ves-example":"application/json","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true"}},"name":{"type":"string","description":" Name of the header\n\nExample: ` \"Content-Type\"`\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  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":256,"x-displayname":"Name","x-ves-example":"Content-Type","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}},"regex":{"type":"string","description":"Exclusive with [exact]\n Regex match of the header value in re2 format\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.not_empty: true\n  ves.io.schema.rules.string.regex: true\n","title":"regex","maxLength":256,"x-displayname":"Regex","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.not_empty":"true","ves.io.schema.rules.string.regex":"true"}}}},"protected_applicationcloudfrontHttpHeaderMatcherList":{"type":"object","description":"Request header name and value pairs","title":"HTTP Header","x-displayname":"HTTP Header","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.HttpHeaderMatcherList","properties":{"headers":{"type":"array","description":" List of HTTP header name and value pairs\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"headers","maxItems":16,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontHeaderMatcherType"},"x-displayname":"HTTP Headers","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16"}}}},"protected_applicationcloudfrontJavaScriptExclusionRule":{"type":"object","description":"Define JavaScript insertion exclusion rule","title":"JavaScriptExclusionRule","x-displayname":"JavaScript Insertion Exclusion Rule","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptExclusionRule","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"path":{"$ref":"#/components/schemas/ioschemaPathMatcherType"}}},"protected_applicationcloudfrontJavaScriptInsertAllType":{"type":"object","description":"x-displayName: \"Insert Bot Defense JavaScript In All Pages\"\nInsert Bot Defense JavaScript in all pages","title":"JavaScriptInsertAllType","properties":{"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptLocation"},"js_download_path":{"type":"string","description":"x-displayName: \"Web Client JavaScript Path\"\nx-example: \"/common.js\"\nWeb client will fetch F5 Client Java Script from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.","title":"js_download_path"}}},"protected_applicationcloudfrontJavaScriptInsertAllWithExceptionsType":{"type":"object","description":"x-displayName: \"Insert JavaScript In All Pages With The Exceptions\"\nInsert Bot Defense JavaScript in all pages  with the exceptions","title":"JavaScriptInsertAllWithExceptionsType","properties":{"exclude_list":{"type":"array","description":"x-displayName: \"Exclude Pages\"\nOptional JavaScript insertions exclude list of domain and path matchers.","title":"exclude_list","items":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptExclusionRule"}},"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptLocation"},"js_download_path":{"type":"string","description":"x-displayName: \"Web Client JavaScript Path\"\nx-example: \"/common.js\"\nWeb client will fetch F5 Client Java Script from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.","title":"js_download_path"}}},"protected_applicationcloudfrontJavaScriptInsertManualType":{"type":"object","description":"Insert JavaScript manually","title":"manual_js_insert","x-displayname":"Insert JavaScript Manually","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertManualType","properties":{"javascript_mode":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptMode"},"js_download_path":{"type":"string","description":" Web client will fetch F5 Client Java Script from this path.\n This path must not conflict with any other website/application paths.\n\n If not specified, default to ‘/common.js’.\n\nExample: ` \"/common.js\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n","title":"js_download_path","x-displayname":"Web Client JavaScript Path","x-ves-example":"/common.js","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true"}}}},"protected_applicationcloudfrontJavaScriptInsertType":{"type":"object","description":"This defines custom JavaScript insertion rules for Bot Defense Policy.","title":"JavaScriptInsertType","x-displayname":"JavaScript Custom Insertion Rules","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertType","properties":{"exclude_list":{"type":"array","description":" Optional JavaScript insertions exclude list of domain and path matchers.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique: true\n","title":"exclude_list","maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptExclusionRule"},"x-displayname":"JavaScript Exclude Paths","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.unique":"true"}},"javascript_location":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptLocation"},"javascript_mode":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptMode"},"js_download_path":{"type":"string","description":" Web client will fetch F5 Client Java Script from this path.\n This path must not conflict with any other website/application paths.\n\n If not specified, default to ‘/common.js’.\n\nExample: ` \"/common.js\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n","title":"js_download_path","x-displayname":"Web Client JavaScript Path","x-ves-example":"/common.js","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true"}},"rules":{"type":"array","description":" Required list of pages to insert Bot Defense client JavaScript.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"rules","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontJavaScriptInsertionRule"},"x-displayname":"JavaScript Insertion Paths","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"protected_applicationcloudfrontJavaScriptInsertionRule":{"type":"object","description":"This defines a rule for Bot Defense JavaScript insertion.","title":"JavaScriptInsertionRule","x-displayname":"JavaScript Insertion Rule","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-oneof-field-uri_path":"[\"exact_path\",\"glob\",\"prefix\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertionRule","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"exact_path":{"type":"string","description":"Exclusive with [glob prefix]\n Exact path value to match\n\nExample: ` \"/logout\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"path","maxLength":256,"x-displayname":"Path","x-ves-example":"/logout","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}},"glob":{"type":"string","description":"Exclusive with [exact_path prefix]\n x-example: \"/id/*\"\n x-example: \"*login\"\n Accepts wildcards * to match multiple characters or ? to match a single character\n\nExample: ` \"/id/1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.pattern: ^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$\n","title":"glob","minLength":1,"maxLength":256,"x-displayname":"Glob","x-ves-example":"/id/1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.pattern":"^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"prefix":{"type":"string","description":"Exclusive with [exact_path glob]\n Path prefix to match (e.g. the value / will match on all paths)\n\nExample: ` \"/register/\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"prefix","maxLength":256,"x-displayname":"Prefix","x-ves-example":"/register/","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"256"}}}},"protected_applicationcloudfrontJavaScriptLocation":{"type":"string","description":"All inside networks.\n\n - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED\n\nUndefined\nInsert JavaScript after <head> tag\nInsert JavaScript after </title> tag.\nInsert JavaScript before first <script> tag","title":"JavaScriptLocation","enum":["JAVA_SCRIPT_LOCATION_UNDEFINED","AFTER_HEAD","AFTER_TITLE_END","BEFORE_SCRIPT"],"default":"JAVA_SCRIPT_LOCATION_UNDEFINED","x-displayname":"JavaScript Location","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptLocation"},"protected_applicationcloudfrontJavaScriptMode":{"type":"string","description":"Web Client JavaScript Mode.\n\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is non-cacheable\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is cacheable","title":"JavaScript Mode","enum":["ASYNC_JS_NO_CACHING","ASYNC_JS_CACHING","SYNC_JS_NO_CACHING","SYNC_JS_CACHING"],"default":"ASYNC_JS_NO_CACHING","x-displayname":"Web Client JavaScript Mode","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptMode"},"protected_applicationcloudfrontLogLevel":{"type":"string","description":"Select the level of logging desired. Levels are cumulative\n(e.g. Debug includes Error, Warning, and Informational)\n\n - LOG_UNDEFINED: Undefined\n\n - LOG_ERROR: Error\n\nLog only errors\n - LOG_WARNING: Warning\n\nLog malicious requests\n - LOG_INFO: Info\n\nLog all requests\n - LOG_DEBUG: Debug\n\nLog debugging data","title":"loglevel","enum":["LOG_UNDEFINED","LOG_ERROR","LOG_WARNING","LOG_INFO","LOG_DEBUG"],"default":"LOG_UNDEFINED","x-displayname":"Log Level","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.LogLevel"},"protected_applicationcloudfrontMobileClientType":{"type":"object","description":"Mobile client configuration options","title":"MobileClientType","x-displayname":"Mobile Client","x-ves-oneof-field-mitigation":"[\"block\",\"continue\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileClientType","properties":{"block":{"$ref":"#/components/schemas/protected_applicationcloudfrontBlockMobileMitigationChoiceType"},"continue":{"$ref":"#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType"}}},"protected_applicationcloudfrontMobileSDKConfigType":{"type":"object","description":"Mobile SDK configuration.","title":"MobileSDKConfigType","x-displayname":"Mobile SDK Configuration","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileSDKConfigType","properties":{"mobile_identifier":{"$ref":"#/components/schemas/protected_applicationcloudfrontMobileTrafficIdentifierType"}}},"protected_applicationcloudfrontMobileTrafficIdentifierType":{"type":"object","description":"Mobile traffic identifier type.","title":"MobileTrafficIdentifierType","x-displayname":"Mobile Traffic Identifier","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileTrafficIdentifierType","properties":{"headers":{"type":"array","description":" A list of headers that can be used to identify mobile traffic.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Mobile headers","maxItems":16,"items":{"$ref":"#/components/schemas/protected_applicationcloudfrontHeaderMatcherType"},"x-displayname":"Mobile Request Identifier Headers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"protected_applicationcloudfrontProtectedEndpointType":{"type":"object","description":"Add the name and description for the protected endpoint","title":"ProtectedEndpointType","x-displayname":"Protected Endpoint","x-ves-displayorder":"1,2,3,4,5,6,7,12,8","x-ves-oneof-field-client_type_choice":"[\"mobile_client\",\"web_client\",\"web_mobile_client\"]","x-ves-oneof-field-domain_matcher_choice":"[\"any_domain\",\"domain\"]","x-ves-oneof-field-flow_label_choice":"[\"flow_label\",\"undefined_flow_label\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.ProtectedEndpointType","properties":{"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain":{"$ref":"#/components/schemas/schemaDomainType"},"flow_label":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelCategoriesChoiceType"},"http_methods":{"type":"array","description":" List of HTTP methods.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.in: [1,3,4]\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"HTTP Methods","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/schemaBotHttpMethod"},"x-displayname":"HTTP Methods","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.in":"[1,3,4]","ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"mobile_client":{"$ref":"#/components/schemas/protected_applicationcloudfrontMobileClientType"},"path":{"type":"string","description":" x-example: \"/id/*\"\n x-example: \"*login\"\n Accepts wildcards * to match multiple characters or ? to match a single character\n\nExample: ` \"/id/1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n  ves.io.schema.rules.string.pattern: ^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$\n","title":"Path","minLength":1,"maxLength":256,"x-displayname":"Path","x-ves-example":"/id/1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1","ves.io.schema.rules.string.pattern":"^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$"}},"query":{"type":"string","description":" Enter a regular expression to match your query parameters of interest\n\nExample: ` \"(^|[^\\\\w])action=login([^\\\\w]|$)\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.regex: true\n","title":"Query","maxLength":256,"x-displayname":"Query","x-ves-example":"(^|[^\\\\w])action=login([^\\\\w]|$)","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.regex":"true"}},"undefined_flow_label":{"$ref":"#/components/schemas/ioschemaEmpty"},"web_client":{"$ref":"#/components/schemas/protected_applicationcloudfrontWebClientType"},"web_mobile_client":{"$ref":"#/components/schemas/protected_applicationcloudfrontWebMobileClientType"}}},"protected_applicationcloudfrontRedirectMitigationChoiceType":{"type":"object","description":"Redirect.","title":"RedirectMitigationChoiceType","x-displayname":"Redirect","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.RedirectMitigationChoiceType","properties":{"location":{"type":"string","description":" x-example: \"/not-found\"\n URI location for redirect reponse\n\nExample: ` \"https://example.com/landing/page\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 512\n  ves.io.schema.rules.string.url_or_uri_ref: true\n","title":"URI","maxLength":512,"x-displayname":"Location","x-ves-example":"https://example.com/landing/page","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"512","ves.io.schema.rules.string.url_or_uri_ref":"true"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"protected_applicationcloudfrontWebClientType":{"type":"object","description":"Web client configuration options","title":"WebClientType","x-displayname":"Web Client","x-ves-oneof-field-mitigation":"[\"block\",\"continue\",\"redirect\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.WebClientType","properties":{"block":{"$ref":"#/components/schemas/protected_applicationcloudfrontBlockMitigationChoiceType"},"continue":{"$ref":"#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType"},"redirect":{"$ref":"#/components/schemas/protected_applicationcloudfrontRedirectMitigationChoiceType"}}},"protected_applicationcloudfrontWebMobileClientType":{"type":"object","description":"Web and Mobile client configuration options","title":"WebMobileClientType","x-displayname":"Web and Mobile Client","x-ves-oneof-field-mobile_mitigation":"[\"block_mobile\",\"continue_mobile\"]","x-ves-oneof-field-web_mitigation":"[\"block_web\",\"continue_web\",\"redirect_web\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.protected_application.cloudfront.WebMobileClientType","properties":{"block_mobile":{"$ref":"#/components/schemas/protected_applicationcloudfrontBlockMobileMitigationChoiceType"},"block_web":{"$ref":"#/components/schemas/protected_applicationcloudfrontBlockMitigationChoiceType"},"continue_mobile":{"$ref":"#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType"},"continue_web":{"$ref":"#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType"},"redirect_web":{"$ref":"#/components/schemas/protected_applicationcloudfrontRedirectMitigationChoiceType"}}},"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"}}},"schemaBotDefenseFlowLabelAccountManagementChoiceType":{"type":"object","description":"Bot Defense Flow Label Account Management Category","title":"BotDefenseFlowLabelAccountManagementChoiceType","x-displayname":"Bot Defense Flow Label Account Management Category","x-ves-oneof-field-label_choice":"[\"create\",\"password_reset\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelAccountManagementChoiceType","properties":{"create":{"$ref":"#/components/schemas/ioschemaEmpty"},"password_reset":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelAuthenticationChoiceType":{"type":"object","description":"Bot Defense Flow Label Authentication Category","title":"BotDefenseFlowLabelCategoryChoiceType","x-displayname":"Bot Defense Flow Label Authentication Category","x-ves-oneof-field-label_choice":"[\"login\",\"login_mfa\",\"login_partner\",\"logout\",\"token_refresh\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelAuthenticationChoiceType","properties":{"login":{"$ref":"#/components/schemas/schemaBotDefenseTransactionResult"},"login_mfa":{"$ref":"#/components/schemas/ioschemaEmpty"},"login_partner":{"$ref":"#/components/schemas/ioschemaEmpty"},"logout":{"$ref":"#/components/schemas/ioschemaEmpty"},"token_refresh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelCategoriesChoiceType":{"type":"object","description":"Bot Defense Flow Label Category allows to associate traffic with selected category","title":"BotDefenseFlowLabelCategoryChoiceType","x-displayname":"Bot Defense Flow Label Category","x-ves-oneof-field-flow_label_choice":"[\"account_management\",\"authentication\",\"financial_services\",\"flight\",\"profile_management\",\"search\",\"shopping_gift_cards\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelCategoriesChoiceType","properties":{"account_management":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelAccountManagementChoiceType"},"authentication":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelAuthenticationChoiceType"},"financial_services":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelFinancialServicesChoiceType"},"flight":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelFlightChoiceType"},"profile_management":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelProfileManagementChoiceType"},"search":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelSearchChoiceType"},"shopping_gift_cards":{"$ref":"#/components/schemas/schemaBotDefenseFlowLabelShoppingGiftCardsChoiceType"}}},"schemaBotDefenseFlowLabelFinancialServicesChoiceType":{"type":"object","description":"Bot Defense Flow Label Financial Services Category","title":"BotDefenseFlowLabelFinancialServicesChoiceType","x-displayname":"Bot Defense Flow Label Financial Services Category","x-ves-oneof-field-label_choice":"[\"apply\",\"money_transfer\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelFinancialServicesChoiceType","properties":{"apply":{"$ref":"#/components/schemas/ioschemaEmpty"},"money_transfer":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelFlightChoiceType":{"type":"object","description":"Bot Defense Flow Label Flight Category","title":"BotDefenseFlowLabelFlightChoiceType","x-displayname":"Bot Defense Flow Label Flight Category","x-ves-oneof-field-label_choice":"[\"checkin\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelFlightChoiceType","properties":{"checkin":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelProfileManagementChoiceType":{"type":"object","description":"Bot Defense Flow Label Profile Management Category","title":"BotDefenseFlowLabelProfileManagementChoiceType","x-displayname":"Bot Defense Flow Label Profile Management Category","x-ves-oneof-field-label_choice":"[\"create\",\"update\",\"view\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelProfileManagementChoiceType","properties":{"create":{"$ref":"#/components/schemas/ioschemaEmpty"},"update":{"$ref":"#/components/schemas/ioschemaEmpty"},"view":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelSearchChoiceType":{"type":"object","description":"Bot Defense Flow Label Search Category","title":"BotDefenseFlowLabelSearchChoiceType","x-displayname":"Bot Defense Flow Label Search Category","x-ves-oneof-field-label_choice":"[\"flight_search\",\"product_search\",\"reservation_search\",\"room_search\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelSearchChoiceType","properties":{"flight_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"product_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"reservation_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"room_search":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseFlowLabelShoppingGiftCardsChoiceType":{"type":"object","description":"Bot Defense Flow Label Shopping & Gift Cards Category","title":"BotDefenseFlowLabelShoppingGiftCardsChoiceType","x-displayname":"Bot Defense Flow Label Shopping & Gift Cards Category","x-ves-oneof-field-label_choice":"[\"gift_card_make_purchase_with_gift_card\",\"gift_card_validation\",\"shop_add_to_cart\",\"shop_checkout\",\"shop_choose_seat\",\"shop_enter_drawing_submission\",\"shop_make_payment\",\"shop_order\",\"shop_price_inquiry\",\"shop_promo_code_validation\",\"shop_purchase_gift_card\",\"shop_update_quantity\"]","x-ves-proto-message":"ves.io.schema.BotDefenseFlowLabelShoppingGiftCardsChoiceType","properties":{"gift_card_make_purchase_with_gift_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"gift_card_validation":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_add_to_cart":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_checkout":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_choose_seat":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_enter_drawing_submission":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_make_payment":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_order":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_price_inquiry":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_promo_code_validation":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_purchase_gift_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_update_quantity":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotDefenseTransactionResult":{"type":"object","description":"Bot Defense Transaction Result","title":"BotDefenseTransactionResult","x-displayname":"Bot Defense Transaction Result","x-ves-oneof-field-transaction_result_choice":"[\"disable_transaction_result\",\"transaction_result\"]","x-ves-proto-message":"ves.io.schema.BotDefenseTransactionResult","properties":{"disable_transaction_result":{"$ref":"#/components/schemas/ioschemaEmpty"},"transaction_result":{"$ref":"#/components/schemas/schemaBotDefenseTransactionResultType"}}},"schemaBotDefenseTransactionResultCondition":{"type":"object","description":"Bot Defense Transaction Result Condition","title":"BotDefenseTransactionResultCondition","x-displayname":"Bot Defense Transaction Result Condition","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BotDefenseTransactionResultCondition","properties":{"name":{"type":"string","description":" A case-insensitive HTTP header name.\n\nExample: ` \"Accept-Encoding\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_header_field: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"name","maxLength":256,"x-displayname":"Header Name","x-ves-example":"Accept-Encoding","x-ves-validation-rules":{"ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256"}},"regex_values":{"type":"array","description":" A list of regular expressions to match the input against.\n\nExample: ` \"['^new .*$', 'san f.*', '.* del .*']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.items.string.regex: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"regex values","maxItems":16,"items":{"type":"string","maxLength":256},"x-displayname":"Regex Values","x-ves-example":"['^new .*$', 'san f.*', '.* del .*']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.items.string.regex":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"}}},"schemaBotDefenseTransactionResultType":{"type":"object","description":"Bot Defense Transaction ResultType","title":"BotDefenseTransactionResultType","x-displayname":"Bot Defense Transaction Result Type","x-ves-displayorder":"4,3","x-ves-proto-message":"ves.io.schema.BotDefenseTransactionResultType","properties":{"failure_conditions":{"type":"array","description":" Failure Conditions\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 3\n  ves.io.schema.rules.repeated.unique: true\n","title":"Failure Conditions","maxItems":3,"items":{"$ref":"#/components/schemas/schemaBotDefenseTransactionResultCondition"},"x-displayname":"Failure Conditions","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.unique":"true"}},"success_conditions":{"type":"array","description":" Success Conditions\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 3\n  ves.io.schema.rules.repeated.unique: true\n","title":"Success Conditions","maxItems":3,"items":{"$ref":"#/components/schemas/schemaBotDefenseTransactionResultCondition"},"x-displayname":"Success Conditions","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"3","ves.io.schema.rules.repeated.unique":"true"}}}},"schemaBotHttpMethod":{"type":"string","description":"Specifies the HTTP method used to access a resource.\n\nAny HTTP Method\nGET method for XMLHttpRequest or Fetch\nPOST method\nPUT method\nPATCH method\nDELETE method\nGET method for HTML document","title":"BotHttpMethod","enum":["METHOD_ANY","METHOD_GET","METHOD_POST","METHOD_PUT","METHOD_PATCH","METHOD_DELETE","METHOD_GET_DOCUMENT"],"default":"METHOD_ANY","x-displayname":"HTTP Method","x-ves-proto-enum":"ves.io.schema.BotHttpMethod"},"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\\\"]"}}}},"schemaDomainType":{"type":"object","description":"Domains names","title":"Domains","x-displayname":"Domains","x-ves-oneof-field-domain_choice":"[\"exact_value\",\"regex_value\",\"suffix_value\"]","x-ves-proto-message":"ves.io.schema.DomainType","properties":{"exact_value":{"type":"string","description":"Exclusive with [regex_value suffix_value]\n Exact domain name.\n\nExample: ` \"abc.zyz.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"exact value","minLength":1,"maxLength":256,"x-displayname":"Exact Value","x-ves-example":"abc.zyz.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}},"regex_value":{"type":"string","description":"Exclusive with [exact_value suffix_value]\n Regular Expression value for the domain name\n\nExample: ` \"([a-z]([-a-z0-9]*[a-z0-9])?)\\.com$'\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.regex: true\n","title":"regex values of Domains","minLength":1,"maxLength":256,"x-displayname":"Regex Values of Domains","x-ves-example":"([a-z]([-a-z0-9]*[a-z0-9])?)\\.com$'","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.regex":"true"}},"suffix_value":{"type":"string","description":"Exclusive with [exact_value regex_value]\n Suffix of domain name e.g \"xyz.com\" will match \"*.xyz.com\" and \"xyz.com\"\n\nExample: ` \"xyz.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"suffix value","minLength":1,"maxLength":256,"x-displayname":"Suffix Value","x-ves-example":"xyz.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"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"}}},"schemaMessageMetaType":{"type":"object","description":"MessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","x-displayname":"Message Metadata","x-ves-proto-message":"ves.io.schema.MessageMetaType","properties":{"description":{"type":"string","description":" Human readable description.\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"description","maxLength":256,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"name":{"type":"string","description":" This is the name of the message.\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  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"name","minLength":1,"x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.ves_object_name":"true"}}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"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"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}}}}}