@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.bot_endpoint_policy","description":"Configures Bot Endpoint Policy","version":""},"paths":{"/api/shape/bot/custom/namespaces/{namespace}/bot_endpoint_policies":{"get":{"summary":"List All Bot Endpoint Policies And Versions","description":"Get all bot endpoint policies and versions","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPoliciesAndVersionsList","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyGetPoliciesAndVersionsListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nnamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-bot_endpoint_policy-customapi-getendpointpoliciesandversionslist"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPoliciesAndVersionsList"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/custom/namespaces/{namespace}/bot_endpoint_policys/{name}":{"put":{"summary":"Custom Replace Bot Endpoint Policy","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.CustomReplace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyCustomReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"value\"\nName of the policy","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyCustomReplaceRequest"}}},"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-bot_endpoint_policy-customapi-customreplace"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.CustomReplace"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{metadata.namespace}/bot_endpoint_policys/{metadata.name}":{"put":{"summary":"Replace Bot Endpoint Policy","description":"Replace Bot Endpoint Policy","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyReplaceResponse"}}}},"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/bot_endpoint_policyReplaceRequest"}}},"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-bot_endpoint_policy-api-replace"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Replace"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_endpoint_policy/{name}/versions":{"get":{"summary":"Bot Endpoint Policy Versions","description":"Get bot endpoint policy versions","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPolicyVersions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyPolicyVersionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nnamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"policy name\n\nx-example: \"web_policy\"\nPolicy name","in":"path","required":true,"x-displayname":"Policy 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-bot_endpoint_policy-customapi-getendpointpolicyversions"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPolicyVersions"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys":{"get":{"summary":"List Bot Endpoint Policy","description":"List the set of bot_endpoint_policy in a namespace","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyListResponse"}}}},"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 bot_endpoint_policy","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-bot_endpoint_policy-api-list"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.List"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys/{name}":{"get":{"summary":"Get Bot Endpoint Policy","description":"Get Bot Endpoint Policy","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyGetResponse"}}}},"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 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_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-bot_endpoint_policy-api-get"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Get"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys/{name}/versions/{number}":{"get":{"summary":"Get Content","description":"Get the content of the specific policy version","operationId":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetContent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_endpoint_policyGetContentResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nNamespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-example: \"value\"\nName of the policy","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"number","description":"Number\n\nx-example: \"v1\"\nVersion of the policy","in":"path","required":true,"x-displayname":"Version number","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-bot_endpoint_policy-customapi-getcontent"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetContent"},"x-displayname":"Bot Endpoint Policy","x-ves-proto-service":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Bot Endpoint Policy","x-ves-proto-package":"ves.io.schema.shape.bot_defense.bot_endpoint_policy","components":{"schemas":{"bot_defenseBlockActionHttpStatusCode":{"type":"string","description":"HTTP response status codes for block action\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nSwitching Protocols status code\nProcessing (WebDAV) 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\n418 I'm a teapot (RFC 2324) status code\nEnhance Your Calm (Twitter) status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nReserved for WebDAV status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nNo Response (Nginx) status code\nRetry With (Microsoft) status code\nRetry With (Microsoft) status code\nUnavailable For Legal Reasons status code\nClient Closed Request (Nginx) 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\nBandwidth Limit Exceeded (Apache) status code\nNot Extended status code\nNetwork Authentication Required status code\nNetwork read timeout error status code\nNetwork Connect Timeout Error status code","title":"HttpStatusCode for block action","enum":["EmptyStatusCode","Continue","SwitchingProtocols","Processing","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","TeaPot","EnhanceYourCalm","UnprocessableEntity","Locked","FailedDependency","ReservedforWebDAV","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","NoResponse","RetryWith","Blockedby","UnavailableForLegalReasons","ClientClosedRequest","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HTTPVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","BandwidthLimitExceeded","NotExtended","NetworkAuthenticationRequired","NetworkReadRimeoutError","NetworkConnectTimeoutError"],"default":"EmptyStatusCode","x-displayname":"HTTP Status Code","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.BlockActionHttpStatusCode"},"bot_defenseBotInfraWithVersion":{"type":"object","description":"x-displayName: \"Bot Infrastructure with in-use policy version\"\nBot Infra Name with its in use version","title":"Bot Infrastructure with in-use version","properties":{"bot_infra_name":{"type":"string","description":"x-displayName: \"Bot Infra name\"\nx-example: \"cluster-1\"\nThe cluster id deployed this policy","title":"Bot Infra Name"},"in_use_version":{"type":"string","description":"x-displayName: \"In Use Version\"\nx-example: \"1.0\"\nThe version of policy deployed to cluster\nThe version format should be X.0","title":"In Use Version"}}},"bot_defenseComparisonOperator":{"type":"string","description":"Select from one of the Comparison Operator.\n\n - EXACT: exact value\n\n - CONTAIN: contain value\n\n - START_WITH: start with value \n\n - END_WITH: end with value \n","title":"Domain Comparison Operator","enum":["EXACT","CONTAIN","START_WITH","END_WITH"],"default":"EXACT","x-displayname":"Comparison Operator","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.ComparisonOperator"},"bot_defenseCookie":{"type":"object","title":"Cookie","x-displayname":"Cookie","x-ves-oneof-field-cookiechoice":"[\"cookie_all\",\"cookie_and\",\"cookie_none\",\"cookie_or\",\"not_present_cookie\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.Cookie","properties":{"cookie_all":{"$ref":"#/components/schemas/bot_defenseGenericEmptyType"},"cookie_and":{"$ref":"#/components/schemas/bot_defenseCookieMatcher"},"cookie_none":{"$ref":"#/components/schemas/bot_defenseCookieMatcher"},"cookie_or":{"$ref":"#/components/schemas/bot_defenseCookieMatcher"},"name":{"type":"string","description":" Operator Name\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Operator Name","x-displayname":"Cookie Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"not_present_cookie":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"bot_defenseCookieMatcher":{"type":"object","description":"Cookie matcher Choice.","title":"Cookie Matcher","x-displayname":"Cookie Matcher","x-ves-proto-message":"ves.io.schema.shape.bot_defense.CookieMatcher","properties":{"cookie_match":{"type":"array","description":"Cookie Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Cookie Matchers","items":{"$ref":"#/components/schemas/bot_defenseCookieMatcherType"},"x-displayname":"Cookie Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseCookieMatcherType":{"type":"object","title":"Cookie Matcher Type","x-displayname":"Cookie Matcher Type","x-ves-oneof-field-compare_type_choice":"[\"contains\",\"ends_with\",\"equals\",\"starts_with\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.CookieMatcherType","properties":{"contains":{"$ref":"#/components/schemas/bot_defenseCookieMatcherValue"},"ends_with":{"$ref":"#/components/schemas/bot_defenseCookieMatcherValue"},"equals":{"$ref":"#/components/schemas/bot_defenseCookieMatcherValue"},"starts_with":{"$ref":"#/components/schemas/bot_defenseCookieMatcherValue"}}},"bot_defenseCookieMatcherValue":{"type":"object","description":"Cookie Matcher Value","title":"Cookie Matcher Value","x-displayname":"Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.CookieMatcherValue","properties":{"case_sensitive":{"type":"boolean","title":"Case sensitive","format":"boolean","x-displayname":"Case Sensitive"},"not_value":{"type":"boolean","title":"Negation","format":"boolean","x-displayname":"Not(!)"},"value":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Response Cookie Matcher Value","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defenseDomainMatcher":{"type":"object","description":"Domain matcher Choice.","title":"Domain Matcher","x-displayname":"Domain Matcher","x-ves-proto-message":"ves.io.schema.shape.bot_defense.DomainMatcher","properties":{"domain_match":{"type":"array","description":"Domain Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Domain Matchers","items":{"$ref":"#/components/schemas/shapebot_defenseDomainMatcherType"},"x-displayname":"Domain Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseDomainOperator":{"type":"object","description":"Domain Operators","title":"Domain Operators","x-displayname":"Operator","x-ves-displayorder":"1","x-ves-oneof-field-domain_operator_choice":"[\"all_domain\",\"domain_and\",\"domain_none\",\"domain_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.DomainOperator","properties":{"all_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"domain_and":{"$ref":"#/components/schemas/bot_defenseDomainMatcher"},"domain_none":{"$ref":"#/components/schemas/bot_defenseDomainMatcher"},"domain_or":{"$ref":"#/components/schemas/bot_defenseDomainMatcher"}}},"bot_defenseGenericEmptyType":{"type":"object","description":"This can be used for the choice where no values are needed","title":"Generic Empty Type","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.shape.bot_defense.GenericEmptyType"},"bot_defenseHeaderMatcher":{"type":"object","description":"A list of Header Matcher","title":"Header Matchers","x-displayname":"Request Body Matcher(s)","x-ves-proto-message":"ves.io.schema.shape.bot_defense.HeaderMatcher","properties":{"header_match":{"type":"array","description":"Header Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Header Matchers","items":{"$ref":"#/components/schemas/bot_defenseMatcherType"},"x-displayname":"Header Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseHeaderNameValuePair":{"type":"object","title":"Header Name and Value Pair","x-displayname":"Header Name and Value Pairs","x-ves-proto-message":"ves.io.schema.shape.bot_defense.HeaderNameValuePair","properties":{"header_name":{"type":"string","description":" Enter the Header Name\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Header Name","x-displayname":"Header","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"header_value":{"type":"string","description":" Enter the Header Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Header Value","x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"bot_defenseHeaderOperator":{"type":"object","description":"Header Operators","title":"Header Operators","x-displayname":"Operator","x-ves-oneof-field-header_operator_choice":"[\"all_header\",\"header_and\",\"header_none\",\"header_or\",\"not_present_header\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.HeaderOperator","properties":{"all_header":{"$ref":"#/components/schemas/bot_defenseHeaderOperatorEmptyType"},"header_and":{"$ref":"#/components/schemas/bot_defenseHeaderMatcher"},"header_none":{"$ref":"#/components/schemas/bot_defenseHeaderMatcher"},"header_or":{"$ref":"#/components/schemas/bot_defenseHeaderMatcher"},"name":{"type":"string","description":" Operator Name\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Operator Name","x-displayname":"Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"not_present_header":{"$ref":"#/components/schemas/bot_defenseHeaderOperatorEmptyType"}}},"bot_defenseHeaderOperatorEmptyType":{"type":"object","description":"This can be used for the header operator choice where no values are needed","title":"Header Operator Empty Type","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.shape.bot_defense.HeaderOperatorEmptyType"},"bot_defenseMatcherType":{"type":"object","description":"Matcher","title":"Matcher Type","x-displayname":"Matcher","x-ves-oneof-field-match_type_choice":"[\"contain_value\",\"end_with_value\",\"exact_value\",\"start_with_value\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.MatcherType","properties":{"contain_value":{"$ref":"#/components/schemas/bot_defenseMatcherValue"},"end_with_value":{"$ref":"#/components/schemas/bot_defenseMatcherValue"},"exact_value":{"$ref":"#/components/schemas/bot_defenseMatcherValue"},"start_with_value":{"$ref":"#/components/schemas/bot_defenseMatcherValue"}}},"bot_defenseMatcherValue":{"type":"object","description":"atcher Value","title":"Matcher Value","x-displayname":"Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.MatcherValue","properties":{"case_insensitive":{"type":"boolean","description":" case insensitive checker","title":"Check case insensitive","format":"boolean","x-displayname":"Case-Insensitive"},"not":{"type":"boolean","description":" not checker","title":"Check not","format":"boolean","x-displayname":"Not(!)"},"value":{"type":"string","description":" Query Matcher Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Query Matcher Value","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defenseNegationOperator":{"type":"string","description":"Select from one of the Negation Operator.\n\n - NO: No\n\n - YES: Yes\n","title":"Domain Negation Operator","enum":["NO","YES"],"default":"NO","x-displayname":"Negation Operator","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.NegationOperator"},"bot_defensePathMatcher":{"type":"object","description":"A list of Path Matcher","title":"Path Matchers","x-displayname":"Path Matcher(s)","x-ves-proto-message":"ves.io.schema.shape.bot_defense.PathMatcher","properties":{"path_match":{"type":"array","description":"Path Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Path Matchers","items":{"$ref":"#/components/schemas/shapebot_defensePathMatcherType"},"x-displayname":"Path Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defensePathMatcherValue":{"type":"object","description":"Path Matcher Value","title":"Path Matcher Value","x-displayname":"Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.PathMatcherValue","properties":{"case_insensitive":{"type":"boolean","description":" case insensitive checker","title":"Check case insensitive","format":"boolean","x-displayname":"Case-Insensitive"},"not":{"type":"boolean","description":" not checker","title":"Check not","format":"boolean","x-displayname":"Not(!)"},"value":{"type":"string","description":" Path Matcher Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 2048\n  ves.io.schema.rules.string.min_len: 1\n","title":"Path Matcher Value","minLength":1,"maxLength":2048,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"2048","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defensePathOperator":{"type":"object","description":"Path Operators","title":"Path Operators","x-displayname":"Operator","x-ves-displayorder":"1","x-ves-oneof-field-path_operator_choice":"[\"all_path\",\"path_and\",\"path_none\",\"path_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.PathOperator","properties":{"all_path":{"$ref":"#/components/schemas/ioschemaEmpty"},"path_and":{"$ref":"#/components/schemas/bot_defensePathMatcher"},"path_none":{"$ref":"#/components/schemas/bot_defensePathMatcher"},"path_or":{"$ref":"#/components/schemas/bot_defensePathMatcher"}}},"bot_defensePolicyVersion":{"type":"object","description":"Policy version","title":"PolicyVersion","x-displayname":"Policy Version","x-ves-proto-message":"ves.io.schema.shape.bot_defense.PolicyVersion","properties":{"bot_infras_name":{"type":"array","description":" Bot Infrastructure Name","title":"Bot Infrastructure Name","items":{"type":"string"},"x-displayname":"Bot Infrastructure"},"update_time":{"type":"string","description":" Policy last updated time\n\nExample: ` \"2021-09-21:44:34.171543432Z\"`","title":"Last Updated","format":"date-time","x-displayname":"Last Updated","x-ves-example":"2021-09-21:44:34.171543432Z"},"update_user":{"type":"string","description":" Last Modified By the user email\n\nExample: ` \"[Services] F5 or user@email.com\"`","title":"Last Modified By","x-displayname":"Last Modified By","x-ves-example":"[Services] F5 or user@email.com"},"version_number":{"type":"string","description":" Policy Version Number","title":"Policy Version Number","x-displayname":"Version"},"version_status":{"type":"string","description":" Version status: in use, published, not published","title":"Policy Version status","x-displayname":"Policy Version Status"}}},"bot_defenseProtectedEndpoints":{"type":"object","description":"Configures Endpoint Policy Content","title":"Endpoint Policy Content","x-displayname":"Protected Endpoint","x-ves-displayorder":"4,1","x-ves-oneof-field-endpoint_type_choice":"[\"protected_mobile_endpoints\",\"protected_web_endpoints\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ProtectedEndpoints","properties":{"js_download_path":{"type":"string","description":" Web client will fetch F5 Client JavaScript from this path.\n This path must not conflict with any other website/application paths.\n\nExample: ` \"/common.js?single\"`","title":"JavaScript Download Path","x-displayname":"Web Client JavaScript Path","x-ves-example":"/common.js?single"},"protected_mobile_endpoints":{"$ref":"#/components/schemas/bot_defenseProtectedMobileEndpointList"},"protected_web_endpoints":{"$ref":"#/components/schemas/bot_defenseProtectedWebEndpointList"}}},"bot_defenseProtectedMobileEndpoint":{"type":"object","description":"Protected Application Endpoint.","title":"ProtectedMobileEndpoint","x-displayname":"Protected Mobile Endpoints","x-ves-displayorder":"1,16,3,4,5,19,21,22,23,8,9","x-ves-oneof-field-mobile_client_action_type":"[\"block\",\"continue\",\"transform\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ProtectedMobileEndpoint","properties":{"block":{"$ref":"#/components/schemas/bot_defenseWebClientBlockMitigationActionType"},"continue":{"$ref":"#/components/schemas/bot_defenseWebClientContinueMitigationActionType"},"domain":{"$ref":"#/components/schemas/bot_defenseDomainOperator"},"flow_label_choice":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelCategoriesChoiceType"},"header":{"type":"array","description":" header matcher","title":"Header","items":{"$ref":"#/components/schemas/bot_defenseHeaderOperator"},"x-displayname":"Header"},"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.max_items: 9\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"HTTP Methods","minItems":1,"maxItems":9,"items":{"$ref":"#/components/schemas/schemaBotPolicyHttpMethod"},"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.max_items":"9","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"path":{"$ref":"#/components/schemas/bot_defensePathOperator"},"query":{"$ref":"#/components/schemas/bot_defenseQueryOperator"},"request_body":{"$ref":"#/components/schemas/bot_defenseRequestBodyOperator"},"transaction_result_criteria":{"$ref":"#/components/schemas/bot_defenseTransactionResult"},"transform":{"$ref":"#/components/schemas/bot_defenseWebClientTransformMitigationActionChoiceType"},"usernames":{"type":"array","description":" Add the condition for fetching the username from the Request Body\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Username Reporting","maxItems":64,"items":{"$ref":"#/components/schemas/bot_defenseUserNameType"},"x-displayname":"Username Reporting","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseProtectedMobileEndpointList":{"type":"object","description":"Protected Mobile Endpoints List","title":"Protected Mobile Endpoints List","x-displayname":"Protected Mobile Endpoints","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ProtectedMobileEndpointList","properties":{"protected_mobile_endpoints":{"type":"array","description":"\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Protected Mobile Endpoints List","items":{"$ref":"#/components/schemas/bot_defenseProtectedMobileEndpoint"},"x-displayname":"Protected Endpoints","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.repeated.unique_metadata_name":"true"}}}},"bot_defenseProtectedWebEndpoint":{"type":"object","description":"Protected Application Endpoint.","title":"ProtectedWebEndpoint","x-displayname":"Protected Web Endpoints","x-ves-displayorder":"1,18,3,4,5,19,20,22,23,8,9","x-ves-oneof-field-web_client_action_type":"[\"block\",\"continue\",\"redirect\",\"transform\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ProtectedWebEndpoint","properties":{"block":{"$ref":"#/components/schemas/bot_defenseWebClientBlockMitigationActionType"},"continue":{"$ref":"#/components/schemas/bot_defenseWebClientContinueMitigationActionType"},"domain":{"$ref":"#/components/schemas/bot_defenseDomainOperator"},"flow_label_choice":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelCategoriesChoiceType"},"header":{"type":"array","description":" header matcher","title":"Header","items":{"$ref":"#/components/schemas/bot_defenseHeaderOperator"},"x-displayname":"Header"},"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.max_items: 9\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"HTTP Methods","minItems":1,"maxItems":9,"items":{"$ref":"#/components/schemas/schemaBotPolicyHttpMethod"},"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.max_items":"9","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"path":{"$ref":"#/components/schemas/bot_defensePathOperator"},"query":{"$ref":"#/components/schemas/bot_defenseQueryOperator"},"redirect":{"$ref":"#/components/schemas/bot_defenseWebClientRedirectMitigationActionType"},"request_body":{"$ref":"#/components/schemas/bot_defenseRequestBodyOperator"},"transaction_result_criteria":{"$ref":"#/components/schemas/bot_defenseTransactionResult"},"transform":{"$ref":"#/components/schemas/bot_defenseWebClientTransformMitigationActionChoiceType"},"usernames":{"type":"array","description":" Add the condition for fetching the username from the Request Body\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Username Reporting","maxItems":64,"items":{"$ref":"#/components/schemas/bot_defenseUserNameType"},"x-displayname":"Username Reporting","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseProtectedWebEndpointList":{"type":"object","description":"Protected Web Endpoints List","title":"Protected Web Endpoints List","x-displayname":"Protected Web Endpoints","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ProtectedWebEndpointList","properties":{"protected_web_endpoints":{"type":"array","description":"\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Protected Web Endpoints List","items":{"$ref":"#/components/schemas/bot_defenseProtectedWebEndpoint"},"x-displayname":"Protected Endpoints","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.repeated.unique_metadata_name":"true"}}}},"bot_defenseQueryMatcher":{"type":"object","description":"A list of Query  Matcher","title":"Query Matchers","x-displayname":"Query Matcher(s)","x-ves-proto-message":"ves.io.schema.shape.bot_defense.QueryMatcher","properties":{"query_match":{"type":"array","description":"Query Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Query Matchers","items":{"$ref":"#/components/schemas/bot_defenseMatcherType"},"x-displayname":"Query Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseQueryOperator":{"type":"object","description":"Query Operators","title":"Query Operators","x-displayname":"Operator","x-ves-displayorder":"1","x-ves-oneof-field-query_operator_choice":"[\"all_query\",\"query_and\",\"query_none\",\"query_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.QueryOperator","properties":{"all_query":{"$ref":"#/components/schemas/ioschemaEmpty"},"query_and":{"$ref":"#/components/schemas/bot_defenseQueryMatcher"},"query_none":{"$ref":"#/components/schemas/bot_defenseQueryMatcher"},"query_or":{"$ref":"#/components/schemas/bot_defenseQueryMatcher"}}},"bot_defenseRequestBodyMatcher":{"type":"object","description":"A list of RequestBody Matcher","title":"RequestBody Matchers","x-displayname":"Request Body Matcher(s)","x-ves-proto-message":"ves.io.schema.shape.bot_defense.RequestBodyMatcher","properties":{"request_body_match":{"type":"array","description":"RequestBody Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"RequestBody Matchers","items":{"$ref":"#/components/schemas/bot_defenseMatcherType"},"x-displayname":"Request Body Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseRequestBodyOperator":{"type":"object","description":"RequestBody Operators","title":"RequestBody Operators","x-displayname":"Operator","x-ves-displayorder":"1","x-ves-oneof-field-request_body_operator_choice":"[\"all_request_body\",\"request_body_and\",\"request_body_none\",\"request_body_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.RequestBodyOperator","properties":{"all_request_body":{"$ref":"#/components/schemas/ioschemaEmpty"},"request_body_and":{"$ref":"#/components/schemas/bot_defenseRequestBodyMatcher"},"request_body_none":{"$ref":"#/components/schemas/bot_defenseRequestBodyMatcher"},"request_body_or":{"$ref":"#/components/schemas/bot_defenseRequestBodyMatcher"}}},"bot_defenseResponseBody":{"type":"object","title":"Response Body","x-displayname":"Response Body","x-ves-displayorder":"1","x-ves-oneof-field-responsebodychoice":"[\"responseBody_all\",\"responseBody_and\",\"responseBody_none\",\"responseBody_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseBody","properties":{"responseBody_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"responseBody_and":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcher"},"responseBody_none":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcher"},"responseBody_or":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcher"}}},"bot_defenseResponseBodyMatcher":{"type":"object","description":"Response Body matcher Choice.","title":"Response Body Matcher","x-displayname":"Response Body Matcher","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseBodyMatcher","properties":{"responseBody_match":{"type":"array","description":"Response Body Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Response Body Matchers","items":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcherType"},"x-displayname":"Response Body Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseResponseBodyMatcherType":{"type":"object","title":"Response Body Matcher Type","x-displayname":"Response Body Matcher Type","x-ves-oneof-field-compare_type_choice":"[\"contains\",\"ends_with\",\"equals\",\"starts_with\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseBodyMatcherType","properties":{"contains":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcherValue"},"ends_with":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcherValue"},"equals":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcherValue"},"starts_with":{"$ref":"#/components/schemas/bot_defenseResponseBodyMatcherValue"}}},"bot_defenseResponseBodyMatcherValue":{"type":"object","title":"Response Body Matcher Value","x-displayname":"Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseBodyMatcherValue","properties":{"case_sensitive":{"type":"boolean","title":"Case sensitive","format":"boolean","x-displayname":"Case Sensitive"},"not_value":{"type":"boolean","title":"Negation","format":"boolean","x-displayname":"Not(!)"},"value":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Response Body Matcher Value","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defenseResponseCode":{"type":"object","title":"response code","x-displayname":"Response Code","x-ves-displayorder":"1","x-ves-oneof-field-responsecodechoice":"[\"responseCode_all\",\"responseCode_and\",\"responseCode_none\",\"responseCode_or\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseCode","properties":{"responseCode_all":{"$ref":"#/components/schemas/ioschemaEmpty"},"responseCode_and":{"$ref":"#/components/schemas/bot_defenseResponseCodeMatcher"},"responseCode_none":{"$ref":"#/components/schemas/bot_defenseResponseCodeMatcher"},"responseCode_or":{"$ref":"#/components/schemas/bot_defenseResponseCodeMatcher"}}},"bot_defenseResponseCodeMatcher":{"type":"object","title":"Response Code Matcher","x-displayname":"Response Code Matcher","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseCodeMatcher","properties":{"responseCode_match":{"type":"array","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Response Code Matchers","items":{"$ref":"#/components/schemas/bot_defenseResponseCodeMatcherType"},"x-displayname":"Response Code Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseResponseCodeMatcherType":{"type":"object","title":"Response Code Matcher Type","x-displayname":"Response Code Matcher Type","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseCodeMatcherType","properties":{"operator":{"$ref":"#/components/schemas/bot_defenseResponseCodeOperator"},"value":{"type":"integer","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n","title":"Response code Matcher Value","format":"int64","x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0"}}}},"bot_defenseResponseCodeOperator":{"type":"string","description":"\n - CODE_EQUALS: EQUALS value\n\n - CODE_NOT_EQUAL_TO: NOT_EQUAL_TO value\n\n - CODE_LESS_THAN: LESS_THAN value \n\n - CODE_GREATER_THAN: GREATER_THAN value \n\n - CODE_LESS_THAN_OR_EQUAlS_TO: LESS_THAN_OR_EQUAlS_TO value \n\n - CODE_GREATER_THAN_OR_EQUAlS_TO: GREATER_THAN_OR_EQUAlS_TO value \n","title":"Response Code Comparison Operator","enum":["CODE_EQUALS","CODE_NOT_EQUAL_TO","CODE_LESS_THAN","CODE_GREATER_THAN","CODE_LESS_THAN_OR_EQUAlS_TO","CODE_GREATER_THAN_OR_EQUAlS_TO"],"default":"CODE_EQUALS","x-displayname":"Comparison Operator","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.ResponseCodeOperator"},"bot_defenseResponseHeader":{"type":"object","description":"Response Header values","title":"Response Header Name Operator Pair","x-displayname":"Response Header Values","x-ves-oneof-field-header_operator_choice":"[\"header_all\",\"header_and\",\"header_none\",\"header_or\",\"not_present_header\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseHeader","properties":{"header_all":{"$ref":"#/components/schemas/bot_defenseGenericEmptyType"},"header_and":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcher"},"header_none":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcher"},"header_or":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcher"},"name":{"type":"string","description":" Operator Name\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Operator Name","x-displayname":"Header Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"not_present_header":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"bot_defenseResponseHeaderMatcher":{"type":"object","description":"Response Header matcher Choice.","title":"Response Header Matcher","x-displayname":"Response Header Matcher","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseHeaderMatcher","properties":{"responseHeader_match":{"type":"array","description":"Response Code Matchers\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"Response Header Matchers","items":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcherType"},"x-displayname":"Response Header Matcher(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseResponseHeaderMatcherType":{"type":"object","title":"Response Header Matcher Type","x-displayname":"Response Header Matcher Type","x-ves-oneof-field-compare_type_choice":"[\"contains\",\"ends_with\",\"equals\",\"starts_with\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseHeaderMatcherType","properties":{"contains":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcherValue"},"ends_with":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcherValue"},"equals":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcherValue"},"starts_with":{"$ref":"#/components/schemas/bot_defenseResponseHeaderMatcherValue"}}},"bot_defenseResponseHeaderMatcherValue":{"type":"object","title":"Response Header Matcher Value","x-displayname":"Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.ResponseHeaderMatcherValue","properties":{"case_sensitive":{"type":"boolean","title":"Case sensitive","format":"boolean","x-displayname":"Case Sensitive"},"not_value":{"type":"boolean","title":"Negation","format":"boolean","x-displayname":"Not(!)"},"value":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Response Header Matcher Value","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defenseTransactionResult":{"type":"object","description":"Transaction Result","title":"Transaction Result","x-displayname":"Transaction Result","x-ves-proto-message":"ves.io.schema.shape.bot_defense.TransactionResult","properties":{"transaction_result_failure":{"$ref":"#/components/schemas/bot_defenseTransactionResultType"},"transaction_result_success":{"$ref":"#/components/schemas/bot_defenseTransactionResultType"}}},"bot_defenseTransactionResultType":{"type":"object","description":"Transaction Result Type","title":"Transaction Result Type","x-displayname":"Transaction Result Type","x-ves-displayorder":"26,27,28,29","x-ves-proto-message":"ves.io.schema.shape.bot_defense.TransactionResultType","properties":{"cookie":{"type":"array","description":" Conditions in Cookie, if any, that would help identify valid Requests to the Origin.","title":"Cookie","items":{"$ref":"#/components/schemas/bot_defenseCookie"},"x-displayname":"Cookie"},"responseBody":{"$ref":"#/components/schemas/bot_defenseResponseBody"},"responseCode":{"$ref":"#/components/schemas/bot_defenseResponseCode"},"responseHeader":{"type":"array","description":" Conditions in Response Header, if any, that would help identify valid Requests to the Origin.","title":"Response Header","items":{"$ref":"#/components/schemas/bot_defenseResponseHeader"},"x-displayname":"Response Header"}}},"bot_defenseUserNameType":{"type":"object","title":"Username Type","x-displayname":"Username Type","x-ves-proto-message":"ves.io.schema.shape.bot_defense.UserNameType","properties":{"username_reporting":{"type":"string","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Username Reporting","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"bot_defenseWebClientAddHeaderToRequest":{"type":"object","description":"Add a header name value pair","title":"WebClientAddHeaderToRequest","x-displayname":"Add Header Name and Value Pair","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientAddHeaderToRequest","properties":{"name_value_pair":{"type":"array","description":" Request  Header Pair\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Request Header","items":{"$ref":"#/components/schemas/bot_defenseHeaderNameValuePair"},"x-displayname":"Add Header Name and Value Pair","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"bot_defenseWebClientBlockMitigationActionType":{"type":"object","description":"Web Client Block request and respond with custom content.","title":"WebClientBlockMitigationActionType","x-displayname":"Block bot mitigation","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientBlockMitigationActionType","properties":{"body":{"type":"string","description":"\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-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"name_value_pair":{"type":"array","description":" Response Header Pair\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Response Header","items":{"$ref":"#/components/schemas/bot_defenseHeaderNameValuePair"},"x-displayname":"Response Header Name and Value Pair","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"status":{"$ref":"#/components/schemas/bot_defenseBlockActionHttpStatusCode"}}},"bot_defenseWebClientContinueMitigationActionType":{"type":"object","description":"Continue mitigation action.","title":"WebClientContinueMitigationActionType","x-displayname":"Continue Bot Mitigation Action","x-ves-oneof-field-send_headers_choice":"[\"append_headers\",\"no_headers\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientContinueMitigationActionType","properties":{"append_headers":{"$ref":"#/components/schemas/bot_defenseWebClientContinueMitigationHeader"},"no_headers":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"bot_defenseWebClientContinueMitigationHeader":{"type":"object","description":"Append flag mitigation headers to forwarded request.","title":"WebClientContinueMitigationHeader","x-displayname":"Append Flag Mitigation Headers","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientContinueMitigationHeader","properties":{"auto_type_header_name":{"type":"string","description":" A case-insensitive HTTP header name.\n\nExample: ` \"Bot-Automation-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","title":"auto_type_header_name","maxLength":256,"x-displayname":"Automation Type Header Name","x-ves-example":"Bot-Automation-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"}}}},"bot_defenseWebClientRedirectMitigationActionType":{"type":"object","description":"Web Client Redirect request to a custom URI.","title":"WebClientRedirectMitigationTypeAction","x-displayname":"Redirect bot mitigation","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientRedirectMitigationActionType","properties":{"status":{"$ref":"#/components/schemas/schemaHttpStatusCode"},"uri":{"type":"string","description":" URI location for redirect may be relative or absolute.\n\nExample: ` \"Enter URI\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.url_or_uri_ref: true\n","title":"URI Location","x-displayname":"Location","x-ves-example":"Enter URI","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.url_or_uri_ref":"true"}}}},"bot_defenseWebClientTransformMitigationActionChoiceType":{"type":"object","description":"Transform mitigation action.","title":"WebClientTransformMitigationActionChoiceType","x-displayname":"Transform Bot Mitigation Action","x-ves-oneof-field-add_headers_choice":"[\"add_headers\",\"no_headers\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.WebClientTransformMitigationActionChoiceType","properties":{"add_headers":{"$ref":"#/components/schemas/bot_defenseWebClientAddHeaderToRequest"},"no_headers":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"bot_endpoint_policyCustomReplaceRequest":{"type":"object","title":"CustomReplaceRequest is used to replace contents of a bot_endpoint_policy","x-displayname":"Custom Replace Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomReplaceRequest","properties":{"name":{"type":"string","description":" Name of the policy\n\nExample: ` \"value\"`","title":"Name","x-displayname":"Name","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"spec":{"$ref":"#/components/schemas/bot_endpoint_policyReplaceSpecType"}}},"bot_endpoint_policyCustomReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomReplaceResponse"},"bot_endpoint_policyGetContentResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetContentResponse","properties":{"endpoint_policy_content":{"$ref":"#/components/schemas/bot_defenseProtectedEndpoints"}}},"bot_endpoint_policyGetPoliciesAndVersionsListResponse":{"type":"object","description":"List All Bot Policies And Versions Response","title":"GetPoliciesAndVersionsListResponse","x-displayname":"List All Bot Policies And Versions Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetPoliciesAndVersionsListResponse","properties":{"policies":{"type":"array","description":" Policy","title":"Policy","items":{"$ref":"#/components/schemas/bot_endpoint_policyPolicy"},"x-displayname":"Policy"}}},"bot_endpoint_policyGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read bot_endpoint_policy","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetResponse","properties":{"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/bot_endpoint_policyReplaceRequest"},"spec":{"$ref":"#/components/schemas/bot_endpoint_policyGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/bot_endpoint_policyStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"bot_endpoint_policyGetResponseFormatCode":{"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_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_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"bot_endpoint_policyGetSpecType":{"type":"object","description":"Get Bot Endpoint Policy","title":"Get Bot Endpoint Policy","x-displayname":"Get Bot Endpoint Policy","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetSpecType","properties":{"endpoint_policy_content":{"$ref":"#/components/schemas/bot_defenseProtectedEndpoints"},"latest_version":{"type":"string","description":" The version number to Endpoint Policy Version for the latest version","x-displayname":"Version"}}},"bot_endpoint_policyListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of bot_endpoint_policy","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.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/bot_endpoint_policyListResponseItem"},"x-displayname":"Items"}}},"bot_endpoint_policyListResponseItem":{"type":"object","description":"By default a summary of bot_endpoint_policy 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 bot_endpoint_policy","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this bot_endpoint_policy","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this bot_endpoint_policy","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates bot_endpoint_policy is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/bot_endpoint_policyGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this bot_endpoint_policy","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this bot_endpoint_policy\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/bot_endpoint_policyStatusObject"},"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 bot_endpoint_policy\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"bot_endpoint_policyPolicy":{"type":"object","description":"Policy name and versions","title":"Policy","x-displayname":"Policy","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.Policy","properties":{"policy_name":{"type":"string","title":"Policy name"},"policy_versions":{"type":"array","description":" Policy Versions","title":"Policy Versions","items":{"$ref":"#/components/schemas/bot_defensePolicyVersion"},"x-displayname":"Policy Versions"}}},"bot_endpoint_policyPolicyVersionsResponse":{"type":"object","description":"Policy versions response","title":"PolicyVersionsResponse","x-displayname":"Policy Versions Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.PolicyVersionsResponse","properties":{"policy_versions":{"type":"array","description":" Policy Versions","title":"Policy Versions","items":{"$ref":"#/components/schemas/bot_defensePolicyVersion"},"x-displayname":"Policy Versions"}}},"bot_endpoint_policyReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a bot_endpoint_policy","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/bot_endpoint_policyReplaceSpecType"}}},"bot_endpoint_policyReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceResponse"},"bot_endpoint_policyReplaceSpecType":{"type":"object","description":"Replace Bot Endpoint Policy","title":"Replace Bot Endpoint Policy","x-displayname":"Replace Bot Endpoint Policy","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceSpecType","properties":{"endpoint_policy_content":{"$ref":"#/components/schemas/bot_defenseProtectedEndpoints"}}},"bot_endpoint_policyStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.shape.bot_defense.bot_endpoint_policy.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"}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBotPolicyFlowLabelAccountManagementChoiceType":{"type":"object","description":"Flow Label Account Management Category","title":"Bot Policy FlowLabelAccountManagementChoiceType","x-displayname":"Account Management Category","x-ves-oneof-field-label_choice":"[\"change_password\",\"check_eligibility\",\"create\",\"exists\",\"password_forgot\",\"password_recover\",\"password_reset\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelAccountManagementChoiceType","properties":{"change_password":{"$ref":"#/components/schemas/ioschemaEmpty"},"check_eligibility":{"$ref":"#/components/schemas/ioschemaEmpty"},"create":{"$ref":"#/components/schemas/ioschemaEmpty"},"exists":{"$ref":"#/components/schemas/ioschemaEmpty"},"password_forgot":{"$ref":"#/components/schemas/ioschemaEmpty"},"password_recover":{"$ref":"#/components/schemas/ioschemaEmpty"},"password_reset":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelAuthenticationChoiceType":{"type":"object","description":"Flow Label Authentication Category","title":"Bot Policy FlowLabelCategoryChoiceType","x-displayname":"Authentication Category","x-ves-oneof-field-label_choice":"[\"login\",\"login_alexa\",\"login_mfa\",\"login_partner\",\"logout\",\"token_refresh\",\"token_validate\",\"zelle_retrieve_token\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelAuthenticationChoiceType","properties":{"login":{"$ref":"#/components/schemas/ioschemaEmpty"},"login_alexa":{"$ref":"#/components/schemas/ioschemaEmpty"},"login_mfa":{"$ref":"#/components/schemas/ioschemaEmpty"},"login_partner":{"$ref":"#/components/schemas/ioschemaEmpty"},"logout":{"$ref":"#/components/schemas/ioschemaEmpty"},"token_refresh":{"$ref":"#/components/schemas/ioschemaEmpty"},"token_validate":{"$ref":"#/components/schemas/ioschemaEmpty"},"zelle_retrieve_token":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelCategoriesChoiceType":{"type":"object","description":"Bot Endpoint Policy Flow Label Category allows to associate traffic with selected category","title":"Bot policy FlowLabelCategoryChoiceType","x-displayname":"Bot Policy Flow Label Category","x-ves-oneof-field-flow_label_choice":"[\"account_management\",\"authentication\",\"credit_card\",\"delivery_services\",\"financial_services\",\"flight\",\"guest_session\",\"loyalty\",\"mailing_list\",\"media\",\"miscellaneous\",\"profile_management\",\"quotes\",\"search\",\"shopping_gift_cards\",\"socials\",\"undefined_flow_label\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelCategoriesChoiceType","properties":{"account_management":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelAccountManagementChoiceType"},"authentication":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelAuthenticationChoiceType"},"credit_card":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelCreditCardChoiceType"},"delivery_services":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelDeliveryServicesChoiceType"},"financial_services":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelFinancialServicesChoiceType"},"flight":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelFlightChoiceType"},"guest_session":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelGuestSessionChoiceType"},"loyalty":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelLoyaltyChoiceType"},"mailing_list":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelMailingListChoiceType"},"media":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelMediaChoiceType"},"miscellaneous":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelMiscellaneousChoiceType"},"profile_management":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelProfileManagementChoiceType"},"quotes":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelQuotesChoiceType"},"search":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelSearchChoiceType"},"shopping_gift_cards":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelShoppingGiftCardsChoiceType"},"socials":{"$ref":"#/components/schemas/schemaBotPolicyFlowLabelSocialsChoiceType"},"undefined_flow_label":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelCreditCardChoiceType":{"type":"object","description":"Flow Label Credit Card Category","title":"Bot Policy FlowLabelCreditCardChoiceType","x-displayname":"Credit Card Category","x-ves-oneof-field-label_choice":"[\"activate\",\"apply\",\"apply_to_account\",\"view_history\",\"view_list\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelCreditCardChoiceType","properties":{"activate":{"$ref":"#/components/schemas/ioschemaEmpty"},"apply":{"$ref":"#/components/schemas/ioschemaEmpty"},"apply_to_account":{"$ref":"#/components/schemas/ioschemaEmpty"},"view_history":{"$ref":"#/components/schemas/ioschemaEmpty"},"view_list":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelDeliveryServicesChoiceType":{"type":"object","description":"Flow Label Delivery Services Category","title":"Bot Policy FlowLabelDeliveryServicesListChoiceType","x-displayname":"Delivery Services Category","x-ves-oneof-field-label_choice":"[\"hold\",\"incorrectly_routed\",\"view_items\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelDeliveryServicesChoiceType","properties":{"hold":{"$ref":"#/components/schemas/ioschemaEmpty"},"incorrectly_routed":{"$ref":"#/components/schemas/ioschemaEmpty"},"view_items":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelFinancialServicesChoiceType":{"type":"object","description":"Flow Label Financial Services Category","title":"Bot Policy FlowLabelFinancialServicesChoiceType","x-displayname":"Financial Services Category","x-ves-oneof-field-label_choice":"[\"account_apply\",\"loan_personal_apply\",\"money_send\",\"money_transfer\",\"ofx\",\"request_credit_score\",\"student_apply\",\"zelle_execute_transaction\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelFinancialServicesChoiceType","properties":{"account_apply":{"$ref":"#/components/schemas/ioschemaEmpty"},"loan_personal_apply":{"$ref":"#/components/schemas/ioschemaEmpty"},"money_send":{"$ref":"#/components/schemas/ioschemaEmpty"},"money_transfer":{"$ref":"#/components/schemas/ioschemaEmpty"},"ofx":{"$ref":"#/components/schemas/ioschemaEmpty"},"request_credit_score":{"$ref":"#/components/schemas/ioschemaEmpty"},"student_apply":{"$ref":"#/components/schemas/ioschemaEmpty"},"zelle_execute_transaction":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelFlightChoiceType":{"type":"object","description":"Flow Label Flight Category","title":"Bot Policy FlowLabelFlightChoiceType","x-displayname":"Flight Category","x-ves-oneof-field-label_choice":"[\"change_flight\",\"checkin\",\"flight_status\",\"submit_travel_documents\",\"time_table\",\"view_flight\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelFlightChoiceType","properties":{"change_flight":{"$ref":"#/components/schemas/ioschemaEmpty"},"checkin":{"$ref":"#/components/schemas/ioschemaEmpty"},"flight_status":{"$ref":"#/components/schemas/ioschemaEmpty"},"submit_travel_documents":{"$ref":"#/components/schemas/ioschemaEmpty"},"time_table":{"$ref":"#/components/schemas/ioschemaEmpty"},"view_flight":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelGuestSessionChoiceType":{"type":"object","description":"Flow Label Guest Session Category","title":"Bot Policy FlowLabelGuestSessionListChoiceType","x-displayname":"Guest Session Category","x-ves-oneof-field-label_choice":"[\"create\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelGuestSessionChoiceType","properties":{"create":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelLoyaltyChoiceType":{"type":"object","description":"Flow Label Loyalty Category","title":"Bot Policy FlowLabelLoyaltyChoiceType","x-displayname":"Loyalty Category","x-ves-oneof-field-label_choice":"[\"conversion\",\"reset_miles\",\"view_account\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelLoyaltyChoiceType","properties":{"conversion":{"$ref":"#/components/schemas/ioschemaEmpty"},"reset_miles":{"$ref":"#/components/schemas/ioschemaEmpty"},"view_account":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelMailingListChoiceType":{"type":"object","description":"Flow Label Mailing List Category","title":"Bot Policy FlowLabelMailingListChoiceType","x-displayname":"Mailing List Category","x-ves-oneof-field-label_choice":"[\"create_password\",\"signup\",\"unsubscribe\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelMailingListChoiceType","properties":{"create_password":{"$ref":"#/components/schemas/ioschemaEmpty"},"signup":{"$ref":"#/components/schemas/ioschemaEmpty"},"unsubscribe":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelMediaChoiceType":{"type":"object","description":"Flow Label Media Category","title":"Bot Policy FlowLabelMediaChoiceType","x-displayname":"Media Category","x-ves-oneof-field-label_choice":"[\"content\",\"play\",\"record\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelMediaChoiceType","properties":{"content":{"$ref":"#/components/schemas/ioschemaEmpty"},"play":{"$ref":"#/components/schemas/ioschemaEmpty"},"record":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelMiscellaneousChoiceType":{"type":"object","description":"Flow Label Miscellaneous Category","title":"Bot Policy FlowLabelMiscellaneousChoiceType","x-displayname":"Miscellaneous Category","x-ves-oneof-field-label_choice":"[\"contact_us\",\"ratings\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelMiscellaneousChoiceType","properties":{"contact_us":{"$ref":"#/components/schemas/ioschemaEmpty"},"ratings":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelProfileManagementChoiceType":{"type":"object","description":"Flow Label Profile Management Category","title":"Bot Policy FlowLabelProfileManagementChoiceType","x-displayname":"Profile Management Category","x-ves-oneof-field-label_choice":"[\"create\",\"update\",\"view\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelProfileManagementChoiceType","properties":{"create":{"$ref":"#/components/schemas/ioschemaEmpty"},"update":{"$ref":"#/components/schemas/ioschemaEmpty"},"view":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelQuotesChoiceType":{"type":"object","description":"Flow Label Quotes Category","title":"Bot Policy FlowLabelQuotesChoiceType","x-displayname":"Quotes Category","x-ves-oneof-field-label_choice":"[\"insurance_fire_request\",\"request\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelQuotesChoiceType","properties":{"insurance_fire_request":{"$ref":"#/components/schemas/ioschemaEmpty"},"request":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelSearchChoiceType":{"type":"object","description":"Flow Label Search Category","title":"Bot Policy FlowLabelSearchChoiceType","x-displayname":"Flow Label Search Category","x-ves-oneof-field-label_choice":"[\"fare_search\",\"find_user\",\"flight_search\",\"location_search\",\"product_search\",\"room_search\",\"shipment_search\",\"ticket_search\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelSearchChoiceType","properties":{"fare_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"find_user":{"$ref":"#/components/schemas/ioschemaEmpty"},"flight_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"location_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"product_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"room_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"shipment_search":{"$ref":"#/components/schemas/ioschemaEmpty"},"ticket_search":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelShoppingGiftCardsChoiceType":{"type":"object","description":"Flow Label Shopping & Gift Cards Category","title":"Bot Policy FlowLabelShoppingGiftCardsChoiceType","x-displayname":"Shopping & Gift Cards Category","x-ves-oneof-field-label_choice":"[\"gift_card_check_balance\",\"gift_card_make_purches_with_card\",\"gift_card_purchase_card\",\"shop_add_to_cart\",\"shop_apply_gift_card\",\"shop_apply_promo_code\",\"shop_checkout\",\"shop_choose_seat\",\"shop_enter_drawing_submission\",\"shop_hold_inventory\",\"shop_make_payment\",\"shop_offer\",\"shop_order\",\"shop_price_inquiry\",\"shop_purchase_gift_card\",\"shop_return\",\"shop_schedule_pickup\",\"shop_track_order\",\"shop_update_quantity\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelShoppingGiftCardsChoiceType","properties":{"gift_card_check_balance":{"$ref":"#/components/schemas/ioschemaEmpty"},"gift_card_make_purches_with_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"gift_card_purchase_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_add_to_cart":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_apply_gift_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_apply_promo_code":{"$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_hold_inventory":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_make_payment":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_offer":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_order":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_price_inquiry":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_purchase_gift_card":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_return":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_schedule_pickup":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_track_order":{"$ref":"#/components/schemas/ioschemaEmpty"},"shop_update_quantity":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyFlowLabelSocialsChoiceType":{"type":"object","description":"Flow Label Socials Category","title":"Bot Policy FlowLabelSocialsChoiceType","x-displayname":"Socials Category","x-ves-oneof-field-label_choice":"[\"follow\",\"like\",\"message\"]","x-ves-proto-message":"ves.io.schema.BotPolicyFlowLabelSocialsChoiceType","properties":{"follow":{"$ref":"#/components/schemas/ioschemaEmpty"},"like":{"$ref":"#/components/schemas/ioschemaEmpty"},"message":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemaBotPolicyHttpMethod":{"type":"string","description":"Specifies the HTTP method used for PC.\n\nGET method for XMLHttpRequest or Fetch\nPOST method\nPUT method\nPATCH method\nDELETE method\nGET method for HTML document\nHEAD method\nOPTIONS method\nTRACE method","title":"BotPolicyHttpMethod","enum":["BP_METHOD_GET","BP_METHOD_POST","BP_METHOD_PUT","BP_METHOD_PATCH","BP_METHOD_DELETE","BP_METHOD_GET_DOCUMENT","BP_METHOD_HEAD","BP_METHOD_OPTIONS","BP_METHOD_TRACE"],"default":"BP_METHOD_GET","x-displayname":"HTTP Method","x-ves-proto-enum":"ves.io.schema.BotPolicyHttpMethod"},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaHttpStatusCode":{"type":"string","description":"HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nUri Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHttp Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code","title":"HttpStatusCode","enum":["EmptyStatusCode","Continue","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","UseProxy","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","URITooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HTTPVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"default":"EmptyStatusCode","x-displayname":"HTTP Status Code","x-ves-proto-enum":"ves.io.schema.HttpStatusCode"},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"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"}}}},"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"}}},"shapebot_defenseDomainMatcherType":{"type":"object","description":"Matcher","title":"Domain Matcher Type","x-displayname":"Domain Matcher Type","x-ves-proto-message":"ves.io.schema.shape.bot_defense.DomainMatcherType","properties":{"negation":{"$ref":"#/components/schemas/bot_defenseNegationOperator"},"operator":{"$ref":"#/components/schemas/bot_defenseComparisonOperator"},"value":{"type":"string","description":" Domain Matcher Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.min_len: 1\n","title":"Domain Matcher Value","minLength":1,"maxLength":256,"x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.min_len":"1"}}}},"shapebot_defensePathMatcherType":{"type":"object","description":"Matcher","title":"Matcher","x-displayname":"Matcher","x-ves-oneof-field-match_type_choice":"[\"contain_value\",\"end_with_value\",\"exact_value\",\"start_with_value\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.PathMatcherType","properties":{"contain_value":{"$ref":"#/components/schemas/bot_defensePathMatcherValue"},"end_with_value":{"$ref":"#/components/schemas/bot_defensePathMatcherValue"},"exact_value":{"$ref":"#/components/schemas/bot_defensePathMatcherValue"},"start_with_value":{"$ref":"#/components/schemas/bot_defensePathMatcherValue"}}}}}}