@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0123.public.ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.observability.synthetic_monitor.v1_http_monitor","description":"\nHTTP Monitor defines an HTTP synthetic monitor.","version":""},"paths":{"/api/observability/synthetic_monitor/namespaces/{metadata.namespace}/v1_http_monitors":{"post":{"summary":"Create HTTP Monitor","description":"Create HTTP Monitor","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-observability-synthetic_monitor-v1_http_monitor-api-create"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Create"},"x-displayname":"HTTP Monitor","x-ves-proto-service":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/observability/synthetic_monitor/namespaces/{metadata.namespace}/v1_http_monitors/{metadata.name}":{"put":{"summary":"Update HTTP Monitor","description":"Update HTTP Monitor","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorReplaceResponse"}}}},"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/v1_http_monitorReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-observability-synthetic_monitor-v1_http_monitor-api-replace"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Replace"},"x-displayname":"HTTP Monitor","x-ves-proto-service":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/observability/synthetic_monitor/namespaces/{namespace}/filtered-http-monitor-list":{"get":{"summary":"Get Filtered HTTP Monitor List","description":"List v1_http_monitor in a namespace based on filter","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CustomAPI.GetFilteredHTTPMonitorList","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorGetFilteredHTTPMonitorListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"namespace","schema":{"type":"string"}},{"name":"filter","description":"monitor filter. x-example: \"monitor_name eq 'tester-name'\"\nFilter on monitor name or application name.","in":"query","required":false,"x-displayname":"filter","schema":{"type":"string"}},{"name":"page","description":"page. x-example: 5\nThe number of page to return. Ignore if limit parameter is absent.","in":"query","required":false,"x-displayname":"page","schema":{"type":"integer","format":"int32"}},{"name":"limit","description":"limit. x-example: 10\nLimits the number of items to return per page. (default: 100)","in":"query","required":false,"x-displayname":"limit","schema":{"type":"integer","format":"int32"}},{"name":"sort","description":"sort. x-example: \"-name, id\"\nReturn data should by ORDER BY the sort field.","in":"query","required":false,"x-displayname":"sort","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-observability-synthetic_monitor-v1_http_monitor-customapi-getfilteredhttpmonitorlist"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CustomAPI.GetFilteredHTTPMonitorList"},"x-displayname":"HTTP Monitor","x-ves-proto-service":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/observability/synthetic_monitor/namespaces/{namespace}/v1_http_monitors":{"get":{"summary":"List HTTP Monitor","description":"List the set of v1_http_monitor in a namespace","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorListResponse"}}}},"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 v1_http_monitor","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-observability-synthetic_monitor-v1_http_monitor-api-list"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.List"},"x-displayname":"HTTP Monitor","x-ves-proto-service":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/observability/synthetic_monitor/namespaces/{namespace}/v1_http_monitors/{name}":{"get":{"summary":"Get HTTP Monitor","description":"Get HTTP Monitor","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-observability-synthetic_monitor-v1_http_monitor-api-get"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Get"},"delete":{"summary":"Delete HTTP Monitor","description":"Delete the specified v1_http_monitor","operationId":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_http_monitorDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-observability-synthetic_monitor-v1_http_monitor-api-delete"},"x-ves-proto-rpc":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API.Delete"},"x-displayname":"HTTP Monitor","x-ves-proto-service":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"HTTP Monitor","x-ves-proto-package":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectMetaType":{"type":"object","description":"ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.\nThe information in this type can be specified by user during create and replace APIs.","title":"ObjectMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.ObjectMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. Object create will fail if\n provided by the client and the value exists in the system. Typically generated by the\n server on successful creation of an object and is not allowed to change once populated.\n Shadowed by SystemObjectMeta's uid field.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaSystemObjectMetaType":{"type":"object","description":"SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"value"},"creator_cookie":{"type":"string","description":" This can used by the creator of the object for later audit for e.g. by storing the\n version identifying information of the object so at future it can be determined if\n version present at remote end is current or stale.\n\nExample: ` \"value\"`","title":"creator_cookie","x-displayname":"Creator Cookie","x-ves-example":"value"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"value"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"direct_ref_hash":{"type":"string","description":" A hash of the UIDs of  direct references on this object. This can be used to determine if \n this object hash has had references become resolved/unresolved","title":"direct_ref_hash","x-displayname":"Direct Reference Hash"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"namespace":{"type":"array","description":" The namespace this object belongs to. This is populated by the service based on the\n metadata.namespace field when an object is created.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"namespace","maxItems":1,"items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Namespace Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"revision":{"type":"string","description":" A revision number which always increases with each modification of the object in storage\n This doesn't necessarily increase sequentially, but should always increase.\n This will be 0 when first created, and before any modifications.","title":"revision","format":"int64","x-displayname":"Revision"},"sre_disable":{"type":"boolean","description":" This should be set to true If VES/SRE operator wants to suppress an object from being\n presented to business-logic of a daemon(e.g. due to bad-form/issue-causing Object).\n This is meant only to be used in temporary situations for operational continuity till\n a fix is rolled out in business-logic.\n\nExample: ` \"true\"`","title":"sre_disable","format":"boolean","x-displayname":"SRE Disable","x-ves-example":"true"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"trace_info":{"type":"string","description":" trace_info holds information(<trace-id>:<span-id>:<parent-span-id>) of the request doing\n the object modification. This can be used on the watch side to create subsequent spans.\n This information can be used to co-relate activities across services (modulo state compression)\n for a synchronous API.\n\nExample: ` \"value\"`","title":"trace_info","x-displayname":"Trace Info","x-ves-example":"value"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Indicate origin of this object.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"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"}}},"synthetic_monitorAWSRegions":{"type":"object","description":"x-example: \"us-east-1\"\nA specific source location within AWS","title":"AWS Regions","x-displayname":"Regions","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.AWSRegions","properties":{"regions":{"type":"array","description":" A specific source location within AWS\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"AWS Regions","items":{"type":"string"},"x-displayname":"Regions","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.not_empty":"true"}}}},"synthetic_monitorAWSRegionsExternal":{"type":"object","description":"x-example: \"us-east-1\"\nA specific source location within AWS","title":"AWS Regions","x-displayname":"Regions","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.AWSRegionsExternal","properties":{"regions":{"type":"array","description":" A specific source location within AWS\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"AWS Regions","items":{"type":"string"},"x-displayname":"Regions","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.not_empty":"true"}}}},"synthetic_monitorDynamicThreshold":{"type":"object","title":"DynamicThreshold","x-displayname":"Dynamic Threshold","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.DynamicThreshold","properties":{"eval_period":{"$ref":"#/components/schemas/synthetic_monitorEvalPeriod"},"std_dev_val":{"$ref":"#/components/schemas/synthetic_monitorStdDevVal"}}},"synthetic_monitorEvalPeriod":{"type":"string","description":"\n - EVAL_PERIOD_3_MINS: EVAL_PERIOD_3_MINS\n\n - EVAL_PERIOD_5_MINS: EVAL_PERIOD_5_MINS\n\n - EVAL_PERIOD_10_MINS: EVAL_PERIOD_10_MINS\n\n - EVAL_PERIOD_15_MINS: EVAL_PERIOD_15_MINS\n","title":"EvalPeriod","enum":["EVAL_PERIOD_3_MINS","EVAL_PERIOD_5_MINS","EVAL_PERIOD_10_MINS","EVAL_PERIOD_15_MINS"],"default":"EVAL_PERIOD_3_MINS","x-displayname":"Evaluation Period","x-ves-proto-enum":"ves.io.schema.observability.synthetic_monitor.EvalPeriod"},"synthetic_monitorHealthPolicy":{"type":"object","title":"HealthPolicy","x-displayname":"Health Policy","x-ves-oneof-field-dynamic_threshold_policy":"[\"dynamic_threshold\",\"dynamic_threshold_disabled\"]","x-ves-oneof-field-static_max_threshold_policy":"[\"static_max_threshold\",\"static_max_threshold_disabled\"]","x-ves-oneof-field-static_min_threshold_policy":"[\"static_min_threshold\",\"static_min_threshold_disabled\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.HealthPolicy","properties":{"dynamic_threshold":{"$ref":"#/components/schemas/synthetic_monitorDynamicThreshold"},"dynamic_threshold_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_max_threshold":{"$ref":"#/components/schemas/synthetic_monitorStaticMaxThreshold"},"static_max_threshold_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"static_min_threshold":{"$ref":"#/components/schemas/synthetic_monitorStaticMinThreshold"},"static_min_threshold_disabled":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"synthetic_monitorRegionalEdgeExternal":{"type":"object","description":"A specific source location within F5 Distributed Cloud","title":"F5 Distributed Cloud Regions","x-displayname":"Regions","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.RegionalEdgeExternal","properties":{"regions":{"type":"array","description":" A specific source location within F5 Distributed Cloud\n\nExample: ` \"ves-io-us\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"F5 Distributed Cloud Regions","items":{"type":"string"},"x-displayname":"Regions","x-ves-example":"ves-io-us","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.not_empty":"true"}}}},"synthetic_monitorRegionalEdgeRegions":{"type":"object","description":"A specific source location within F5 Distributed Cloud","title":"F5 Distributed Cloud Regions","x-displayname":"Regions","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.RegionalEdgeRegions","properties":{"regions":{"type":"array","description":" A specific source location within F5 Distributed Cloud\n\nExample: ` \"ves-io-us\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.not_empty: true\n","title":"F5 Distributed Cloud Regions","items":{"type":"string"},"x-displayname":"Regions","x-ves-example":"ves-io-us","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.not_empty":"true"}}}},"synthetic_monitorSource":{"type":"object","description":"A location where a monitor runs","title":"Source","x-displayname":"Source","x-ves-oneof-field-source_choice":"[\"aws\",\"f5xc\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.Source","properties":{"aws":{"$ref":"#/components/schemas/synthetic_monitorAWSRegions"},"f5xc":{"$ref":"#/components/schemas/synthetic_monitorRegionalEdgeRegions"}}},"synthetic_monitorSourceExternal":{"type":"object","description":"A location where a monitor runs","title":"Source","x-displayname":"Source","x-ves-oneof-field-source_choice":"[\"aws\",\"f5xc\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.SourceExternal","properties":{"aws":{"$ref":"#/components/schemas/synthetic_monitorAWSRegionsExternal"},"f5xc":{"$ref":"#/components/schemas/synthetic_monitorRegionalEdgeExternal"}}},"synthetic_monitorStaticMaxThreshold":{"type":"object","title":"StaticMaxThreshold","x-displayname":"Static Max Threshold","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.StaticMaxThreshold","properties":{"eval_period":{"$ref":"#/components/schemas/synthetic_monitorEvalPeriod"},"max_response_time":{"type":"integer","description":" The maximum response time value that must be exceeded before the monitor turns critical.\n\nExample: ` \"1000\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 10\n  ves.io.schema.rules.uint32.lte: 10000\n","title":"max_response_time","format":"int64","x-displayname":"Max Response Time","x-ves-example":"1000","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"10","ves.io.schema.rules.uint32.lte":"10000"}}}},"synthetic_monitorStaticMinThreshold":{"type":"object","title":"StaticMaxThreshold","x-displayname":"Static Max Threshold","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.StaticMinThreshold","properties":{"eval_period":{"$ref":"#/components/schemas/synthetic_monitorEvalPeriod"},"min_response_time":{"type":"integer","description":" The minimum value that response time must fall below before the monitor turns critical.\n\nExample: ` \"50\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 250\n","title":"min_response_time","format":"int64","x-displayname":"Min Response Time","x-ves-example":"50","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"250"}}}},"synthetic_monitorStdDevVal":{"type":"string","description":"\n - STD_DEV_VAL_3: STD_DEV_VAL_3\n\n - STD_DEV_VAL_4: STD_DEV_VAL_4\n\n - STD_DEV_VAL_5: STD_DEV_VAL_5\n\n - STD_DEV_VAL_6: STD_DEV_VAL_6\n","title":"StdDevVal","enum":["STD_DEV_VAL_3","STD_DEV_VAL_4","STD_DEV_VAL_5","STD_DEV_VAL_6"],"default":"STD_DEV_VAL_3","x-displayname":"Standard Deviation Value","x-ves-proto-enum":"ves.io.schema.observability.synthetic_monitor.StdDevVal"},"v1_http_monitorCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of v1_http_monitor","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/v1_http_monitorCreateSpecType"}}},"v1_http_monitorCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/v1_http_monitorGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"v1_http_monitorCreateSpecType":{"type":"object","description":"Create HTTP Monitor","title":"Create HTTP Monitor","x-displayname":"Create HTTP Monitor","x-ves-oneof-field-interval_choice":"[\"interval_12_hours\",\"interval_15_mins\",\"interval_1_day\",\"interval_1_hour\",\"interval_1_min\",\"interval_30_mins\",\"interval_30_secs\",\"interval_5_mins\",\"interval_6_hours\"]","x-ves-oneof-field-method":"[\"delete\",\"get\",\"head\",\"options\",\"patch\",\"post\",\"put\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.CreateSpecType","properties":{"delete":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"external_sources":{"type":"array","description":" Internet facing monitor sources\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/synthetic_monitorSourceExternal"},"x-displayname":"External Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"follow_redirects":{"type":"boolean","description":" Controls if the monitor will follow redirects while determining health\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Follow Redirects","x-ves-example":"false"},"get":{"$ref":"#/components/schemas/ioschemaEmpty"},"head":{"$ref":"#/components/schemas/ioschemaEmpty"},"health_policy":{"$ref":"#/components/schemas/synthetic_monitorHealthPolicy"},"ignore_cert_errors":{"type":"boolean","description":" Controls if an SSL error will result in a change of health status\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Ignore Cert Errors","x-ves-example":"false"},"interval_12_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_15_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_day":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_hour":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_min":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_secs":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_5_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_6_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"on_failure_count":{"type":"integer","description":" The number of times a monitor must fail before the global monitor changes health\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 1000\n","format":"int64","x-displayname":"Number of Consecutive Test Failures","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"1000"}},"options":{"$ref":"#/components/schemas/ioschemaEmpty"},"patch":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"post":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"put":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"receive":{"type":"string","description":" The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.\n Note, headers are not considered in the matching.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 2048\n  ves.io.schema.rules.string.regex: true\n","maxLength":2048,"x-displayname":"Receive String","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"2048","ves.io.schema.rules.string.regex":"true"}},"request_headers":{"type":"array","description":"\n\nExample: ` \"['contentType''application/json']\"`","items":{"$ref":"#/components/schemas/v1_http_monitorHTTPMonitorHeader"},"x-displayname":"Request Headers","x-ves-example":"['contentType': 'application/json']"},"response_codes":{"type":"array","description":" HTTP response codes which will result in a healthy monitor. Use \"*\" as a wildcard character.\n\nExample: ` \"[\"2**\", \"3**\"]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.pattern: ^[1-5*][0-9*]{2}$\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"items":{"type":"string"},"x-displayname":"Valid Response Codes","x-ves-example":"[\"2**\", \"3**\"]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.pattern":"^[1-5*][0-9*]{2}$","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"response_timeout":{"type":"integer","description":" The amount of time in milliseconds before the monitor considers a pending request to be a failure\n\nExample: ` \"10000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 10\n  ves.io.schema.rules.uint32.lte: 60000\n","format":"int64","x-displayname":"Response Timeout","x-ves-example":"10000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"10","ves.io.schema.rules.uint32.lte":"60000"}},"sni_host":{"type":"string","description":" A string value which will override the default SNI host\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 253\n","maxLength":253,"x-displayname":"SNI Host Override","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"253"}},"source_critical_threshold":{"type":"integer","description":" The number of provider-regions a monitor must fail from before the global monitor changes health\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 256\n","format":"int64","x-displayname":"Number of Failed Locations","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"256"}},"url":{"type":"string","description":"\nExample: ` \"https://www.f5.com\"`\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.uri: true\n","maxLength":2048,"x-displayname":"URL","x-ves-example":"https://www.f5.com","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.uri":"true"}}}},"v1_http_monitorDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a v1_http_monitor","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"v1_http_monitorGetFilteredHTTPMonitorListResponse":{"type":"object","description":"Response body of GetFilteredHTTPMonitorList request","title":"GetFilteredHTTPMonitorListResponse","x-displayname":"Response for GetFilteredHTTPMonitorList","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.GetFilteredHTTPMonitorListResponse","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/v1_http_monitorObject"},"x-displayname":"Items"}}},"v1_http_monitorGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read v1_http_monitor","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/v1_http_monitorCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/v1_http_monitorReplaceRequest"},"spec":{"$ref":"#/components/schemas/v1_http_monitorGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/v1_http_monitorStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"v1_http_monitorGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"v1_http_monitorGetSpecType":{"type":"object","description":"Get HTTP Monitor","title":"Get HTTP Monitor","x-displayname":"Get HTTP Monitor","x-ves-oneof-field-interval_choice":"[\"interval_12_hours\",\"interval_15_mins\",\"interval_1_day\",\"interval_1_hour\",\"interval_1_min\",\"interval_30_mins\",\"interval_30_secs\",\"interval_5_mins\",\"interval_6_hours\"]","x-ves-oneof-field-method":"[\"delete\",\"get\",\"head\",\"options\",\"patch\",\"post\",\"put\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.GetSpecType","properties":{"delete":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"external_sources":{"type":"array","description":" Internet facing monitor sources\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/synthetic_monitorSourceExternal"},"x-displayname":"External Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"follow_redirects":{"type":"boolean","description":" Controls if the monitor will follow redirects while determining health\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Follow Redirects","x-ves-example":"false"},"get":{"$ref":"#/components/schemas/ioschemaEmpty"},"head":{"$ref":"#/components/schemas/ioschemaEmpty"},"health_policy":{"$ref":"#/components/schemas/synthetic_monitorHealthPolicy"},"ignore_cert_errors":{"type":"boolean","description":" Controls if an SSL error will result in a change of health status\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Ignore Cert Errors","x-ves-example":"false"},"interval_12_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_15_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_day":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_hour":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_min":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_secs":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_5_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_6_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"on_failure_count":{"type":"integer","description":" The number of times a monitor must fail before the global monitor changes health\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 1000\n","format":"int64","x-displayname":"Number of Consecutive Test Failures","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"1000"}},"options":{"$ref":"#/components/schemas/ioschemaEmpty"},"patch":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"post":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"put":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"receive":{"type":"string","description":" The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.\n Note, headers are not considered in the matching.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 2048\n  ves.io.schema.rules.string.regex: true\n","maxLength":2048,"x-displayname":"Receive String","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"2048","ves.io.schema.rules.string.regex":"true"}},"request_headers":{"type":"array","description":"\n\nExample: ` \"['contentType''application/json']\"`","items":{"$ref":"#/components/schemas/v1_http_monitorHTTPMonitorHeader"},"x-displayname":"Request Headers","x-ves-example":"['contentType': 'application/json']"},"response_codes":{"type":"array","description":" HTTP response codes which will result in a healthy monitor. Use \"*\" as a wildcard character.\n\nExample: ` \"[\"2**\", \"3**\"]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.pattern: ^[1-5*][0-9*]{2}$\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"items":{"type":"string"},"x-displayname":"Valid Response Codes","x-ves-example":"[\"2**\", \"3**\"]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.pattern":"^[1-5*][0-9*]{2}$","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"response_timeout":{"type":"integer","description":" The amount of time in milliseconds before the monitor considers a pending request to be a failure\n\nExample: ` \"10000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 10\n  ves.io.schema.rules.uint32.lte: 60000\n","format":"int64","x-displayname":"Response Timeout","x-ves-example":"10000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"10","ves.io.schema.rules.uint32.lte":"60000"}},"sni_host":{"type":"string","description":" A string value which will override the default SNI host\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 253\n","maxLength":253,"x-displayname":"SNI Host Override","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"253"}},"source_critical_threshold":{"type":"integer","description":" The number of provider-regions a monitor must fail from before the global monitor changes health\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 256\n","format":"int64","x-displayname":"Number of Failed Locations","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"256"}},"url":{"type":"string","description":"\nExample: ` \"https://www.f5.com\"`\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.uri: true\n","maxLength":2048,"x-displayname":"URL","x-ves-example":"https://www.f5.com","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.uri":"true"}}}},"v1_http_monitorGlobalSpecType":{"type":"object","description":"HTTP Monitor spec","title":"GlobalSpecType","x-displayname":"Specification","x-ves-oneof-field-interval_choice":"[\"interval_12_hours\",\"interval_15_mins\",\"interval_1_day\",\"interval_1_hour\",\"interval_1_min\",\"interval_30_mins\",\"interval_30_secs\",\"interval_5_mins\",\"interval_6_hours\"]","x-ves-oneof-field-method":"[\"delete\",\"get\",\"head\",\"options\",\"patch\",\"post\",\"put\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.GlobalSpecType","properties":{"delete":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"external_sources":{"type":"array","description":" Internet facing monitor sources\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"External Sources","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/synthetic_monitorSource"},"x-displayname":"External Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"follow_redirects":{"type":"boolean","description":" Controls if the monitor will follow redirects while determining health\n\nExample: ` \"false\"`","title":"follow_redirects","format":"boolean","x-displayname":"Follow Redirects","x-ves-example":"false"},"get":{"$ref":"#/components/schemas/ioschemaEmpty"},"head":{"$ref":"#/components/schemas/ioschemaEmpty"},"health_policy":{"$ref":"#/components/schemas/synthetic_monitorHealthPolicy"},"ignore_cert_errors":{"type":"boolean","description":" Controls if an SSL error will result in a change of health status\n\nExample: ` \"false\"`","title":"ignore_cert_errors","format":"boolean","x-displayname":"Ignore Cert Errors","x-ves-example":"false"},"interval_12_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_15_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_day":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_hour":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_min":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_secs":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_5_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_6_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"on_failure_count":{"type":"integer","description":" The number of times a monitor must fail before the global monitor changes health\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 1000\n","title":"on_failure_count","format":"int64","x-displayname":"Number of Consecutive Test Failures","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"1000"}},"options":{"$ref":"#/components/schemas/ioschemaEmpty"},"patch":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"post":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"put":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"receive":{"type":"string","description":" The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.\n Note, headers are not considered in the matching.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 2048\n  ves.io.schema.rules.string.regex: true\n","title":"receive","maxLength":2048,"x-displayname":"Receive String","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"2048","ves.io.schema.rules.string.regex":"true"}},"request_headers":{"type":"array","description":"\n\nExample: ` \"['contentType''application/json']\"`","title":"request_headers","items":{"$ref":"#/components/schemas/v1_http_monitorHTTPMonitorHeader"},"x-displayname":"Request Headers","x-ves-example":"['contentType': 'application/json']"},"response_codes":{"type":"array","description":" HTTP response codes which will result in a healthy monitor. Use \"*\" as a wildcard character.\n\nExample: ` \"[\"2**\", \"3**\"]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.pattern: ^[1-5*][0-9*]{2}$\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"response_codes","minItems":1,"items":{"type":"string"},"x-displayname":"Valid Response Codes","x-ves-example":"[\"2**\", \"3**\"]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.pattern":"^[1-5*][0-9*]{2}$","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"response_timeout":{"type":"integer","description":" The amount of time in milliseconds before the monitor considers a pending request to be a failure\n\nExample: ` \"10000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 10\n  ves.io.schema.rules.uint32.lte: 60000\n","title":"response_timeout","format":"int64","x-displayname":"Response Timeout","x-ves-example":"10000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"10","ves.io.schema.rules.uint32.lte":"60000"}},"sni_host":{"type":"string","description":" A string value which will override the default SNI host\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 253\n","title":"SNI Host Override","maxLength":253,"x-displayname":"SNI Host Override","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"253"}},"source_critical_threshold":{"type":"integer","description":" The number of provider-regions a monitor must fail from before the global monitor changes health\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 256\n","title":"source_critical_threshold","format":"int64","x-displayname":"Number of Failed Locations","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"256"}},"url":{"type":"string","description":"\nExample: ` \"https://www.f5.com\"`\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.uri: true\n","title":"url","maxLength":2048,"x-displayname":"URL","x-ves-example":"https://www.f5.com","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.uri":"true"}}}},"v1_http_monitorHTTPMonitorHeader":{"type":"object","title":"HTTPMonitorHeader","x-displayname":"HTTP Monitor Header","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.HTTPMonitorHeader","properties":{"key":{"type":"string","description":"\nExample: ` \"\"`\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_len: 2048\n","title":"Key","maxLength":2048,"x-displayname":"Key","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_len":"2048"}},"value":{"type":"string","description":"\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 8192\n","title":"Value","maxLength":8192,"x-displayname":"Value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"8192"}}}},"v1_http_monitorListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of v1_http_monitor","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.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/v1_http_monitorListResponseItem"},"x-displayname":"Items"}}},"v1_http_monitorListResponseItem":{"type":"object","description":"By default a summary of v1_http_monitor 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 v1_http_monitor","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this v1_http_monitor","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this v1_http_monitor","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates v1_http_monitor is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/v1_http_monitorGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this v1_http_monitor","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this v1_http_monitor\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/v1_http_monitorStatusObject"},"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 v1_http_monitor\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"v1_http_monitorObject":{"type":"object","description":"HTTP Monitor Object","title":"HTTP Monitor domain object","x-displayname":"HTTP Monitor Object","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.Object","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectMetaType"},"spec":{"$ref":"#/components/schemas/v1_http_monitorSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectMetaType"}}},"v1_http_monitorReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a v1_http_monitor","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/v1_http_monitorReplaceSpecType"}}},"v1_http_monitorReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ReplaceResponse"},"v1_http_monitorReplaceSpecType":{"type":"object","description":"Update HTTP Monitor","title":"Update HTTP Monitor","x-displayname":"Update HTTP Monitor","x-ves-oneof-field-interval_choice":"[\"interval_12_hours\",\"interval_15_mins\",\"interval_1_day\",\"interval_1_hour\",\"interval_1_min\",\"interval_30_mins\",\"interval_30_secs\",\"interval_5_mins\",\"interval_6_hours\"]","x-ves-oneof-field-method":"[\"delete\",\"get\",\"head\",\"options\",\"patch\",\"post\",\"put\"]","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.ReplaceSpecType","properties":{"delete":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"external_sources":{"type":"array","description":" Internet facing monitor sources\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/synthetic_monitorSourceExternal"},"x-displayname":"External Sources","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"follow_redirects":{"type":"boolean","description":" Controls if the monitor will follow redirects while determining health\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Follow Redirects","x-ves-example":"false"},"get":{"$ref":"#/components/schemas/ioschemaEmpty"},"head":{"$ref":"#/components/schemas/ioschemaEmpty"},"health_policy":{"$ref":"#/components/schemas/synthetic_monitorHealthPolicy"},"ignore_cert_errors":{"type":"boolean","description":" Controls if an SSL error will result in a change of health status\n\nExample: ` \"false\"`","format":"boolean","x-displayname":"Ignore Cert Errors","x-ves-example":"false"},"interval_12_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_15_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_day":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_hour":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_1_min":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_30_secs":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_5_mins":{"$ref":"#/components/schemas/ioschemaEmpty"},"interval_6_hours":{"$ref":"#/components/schemas/ioschemaEmpty"},"on_failure_count":{"type":"integer","description":" The number of times a monitor must fail before the global monitor changes health\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 1000\n","format":"int64","x-displayname":"Number of Consecutive Test Failures","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"1000"}},"options":{"$ref":"#/components/schemas/ioschemaEmpty"},"patch":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"post":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"put":{"$ref":"#/components/schemas/v1_http_monitorRequestBody"},"receive":{"type":"string","description":" The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.\n Note, headers are not considered in the matching.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 2048\n  ves.io.schema.rules.string.regex: true\n","maxLength":2048,"x-displayname":"Receive String","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"2048","ves.io.schema.rules.string.regex":"true"}},"request_headers":{"type":"array","description":"\n\nExample: ` \"['contentType''application/json']\"`","items":{"$ref":"#/components/schemas/v1_http_monitorHTTPMonitorHeader"},"x-displayname":"Request Headers","x-ves-example":"['contentType': 'application/json']"},"response_codes":{"type":"array","description":" HTTP response codes which will result in a healthy monitor. Use \"*\" as a wildcard character.\n\nExample: ` \"[\"2**\", \"3**\"]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.pattern: ^[1-5*][0-9*]{2}$\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","minItems":1,"items":{"type":"string"},"x-displayname":"Valid Response Codes","x-ves-example":"[\"2**\", \"3**\"]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.pattern":"^[1-5*][0-9*]{2}$","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"response_timeout":{"type":"integer","description":" The amount of time in milliseconds before the monitor considers a pending request to be a failure\n\nExample: ` \"10000\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 10\n  ves.io.schema.rules.uint32.lte: 60000\n","format":"int64","x-displayname":"Response Timeout","x-ves-example":"10000","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"10","ves.io.schema.rules.uint32.lte":"60000"}},"sni_host":{"type":"string","description":" A string value which will override the default SNI host\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostname: true\n  ves.io.schema.rules.string.max_len: 253\n","maxLength":253,"x-displayname":"SNI Host Override","x-ves-validation-rules":{"ves.io.schema.rules.string.hostname":"true","ves.io.schema.rules.string.max_len":"253"}},"source_critical_threshold":{"type":"integer","description":" The number of provider-regions a monitor must fail from before the global monitor changes health\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 256\n","format":"int64","x-displayname":"Number of Failed Locations","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"256"}},"url":{"type":"string","description":"\nExample: ` \"https://www.f5.com\"`\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.uri: true\n","maxLength":2048,"x-displayname":"URL","x-ves-example":"https://www.f5.com","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.uri":"true"}}}},"v1_http_monitorRequestBody":{"type":"object","title":"RequestBody","x-displayname":"RequestBody","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.RequestBody","properties":{"request_body":{"type":"string","description":" Ensure appropriate request headers are added based on the content type added here\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 65535\n","title":"content","maxLength":65535,"x-displayname":"Body Content","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"65535"}}}},"v1_http_monitorSpecType":{"type":"object","description":"Shape of the v1_http_monitor specification","title":"Specification of HTTP Monitor","x-displayname":"Specification","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.SpecType","properties":{"gc_spec":{"$ref":"#/components/schemas/v1_http_monitorGlobalSpecType"}}},"v1_http_monitorStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.observability.synthetic_monitor.v1_http_monitor.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/schemaObjectRefType"},"x-displayname":"Config Object"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.healthcheck","description":"Health check configuration for a given cluster.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/healthchecks":{"post":{"summary":"Create Health Check","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","operationId":"ves.io.schema.healthcheck.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-healthcheck-api-create"},"x-ves-proto-rpc":"ves.io.schema.healthcheck.API.Create"},"x-displayname":"Health Check","x-ves-proto-service":"ves.io.schema.healthcheck.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/healthchecks/{metadata.name}":{"put":{"summary":"Replace Health Check","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","operationId":"ves.io.schema.healthcheck.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckReplaceResponse"}}}},"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/healthcheckReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-healthcheck-api-replace"},"x-ves-proto-rpc":"ves.io.schema.healthcheck.API.Replace"},"x-displayname":"Health Check","x-ves-proto-service":"ves.io.schema.healthcheck.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/healthchecks":{"get":{"summary":"List Health Check","description":"List the set of healthcheck in a namespace","operationId":"ves.io.schema.healthcheck.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckListResponse"}}}},"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 healthcheck","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-healthcheck-api-list"},"x-ves-proto-rpc":"ves.io.schema.healthcheck.API.List"},"x-displayname":"Health Check","x-ves-proto-service":"ves.io.schema.healthcheck.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/healthchecks/{name}":{"get":{"summary":"Get Health Check","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","operationId":"ves.io.schema.healthcheck.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-healthcheck-api-get"},"x-ves-proto-rpc":"ves.io.schema.healthcheck.API.Get"},"delete":{"summary":"Delete Health Check","description":"Delete the specified healthcheck","operationId":"ves.io.schema.healthcheck.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthcheckDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-healthcheck-api-delete"},"x-ves-proto-rpc":"ves.io.schema.healthcheck.API.Delete"},"x-displayname":"Health Check","x-ves-proto-service":"ves.io.schema.healthcheck.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Health Check","x-ves-proto-package":"ves.io.schema.healthcheck","components":{"schemas":{"healthcheckCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of healthcheck","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.healthcheck.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/healthcheckCreateSpecType"}}},"healthcheckCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.healthcheck.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/healthcheckGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"healthcheckCreateSpecType":{"type":"object","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","title":"Create healthcheck","x-displayname":"Create Health Check","x-ves-oneof-field-health_check":"[\"http_health_check\",\"tcp_health_check\",\"udp_icmp_health_check\"]","x-ves-proto-message":"ves.io.schema.healthcheck.CreateSpecType","properties":{"healthy_threshold":{"type":"integer","description":" Number of successful responses before declaring healthy. In other words, this is\n the number of healthy health checks required before a host is marked\n healthy. Note that during startup, only a single successful health check is\n required to mark a host healthy.\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Healthy Threshold","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}},"http_health_check":{"$ref":"#/components/schemas/healthcheckHttpHealthCheck"},"interval":{"type":"integer","description":" Time interval in seconds between two healthcheck requests.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Interval","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"jitter_percent":{"type":"integer","description":" Add a random amount of time as a percent value to the interval between successive healthcheck requests.\n\nExample: ` \"25\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,10-50\n","format":"int64","x-displayname":"Jitter Percent","x-ves-example":"25","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,10-50"}},"tcp_health_check":{"$ref":"#/components/schemas/healthcheckTcpHealthCheck"},"timeout":{"type":"integer","description":" Timeout in seconds to wait for successful response. In other words, it is\n the time to wait for a health check response. If the timeout is reached the\n health check attempt will be considered a failure.\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Timeout","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"udp_icmp_health_check":{"$ref":"#/components/schemas/ioschemaEmpty"},"unhealthy_threshold":{"type":"integer","description":" Number of failed responses before declaring unhealthy. In other words, this is\n the number of unhealthy health checks required before a host is marked\n unhealthy. Note that for http health checking if a host responds with 503\n this threshold is ignored and the host is considered unhealthy immediately.\n\nExample: ` \"5\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Unhealthy Threshold","x-ves-example":"5","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}}}},"healthcheckDNSQueryType":{"type":"string","description":"x-displayName: \"DNS Query Type\"\nDNS Query Type\n\n - DNS_QTYPE_A: Query Type A\n\nx-displayName: \"Query Type A\"\n - DNS_QTYPE_AAAA: Query Type AAAA\n\nx-displayName: \"Query Type AAAA\"","title":"DNS Query Type","enum":["DNS_QTYPE_A","DNS_QTYPE_AAAA"],"default":"DNS_QTYPE_A"},"healthcheckDNSResponseRcodeType":{"type":"string","description":"x-displayName: \"DNS Response Rcode Type\"\nExpected DNS Response Rcode Type\n\n - DNS_RES_RCODE_NOERROR: Rcode NOERROR\n\nx-displayName: \"Rcode NOERROR\"\n - DNS_RES_RCODE_ANY: RCODE ANY\n\nx-displayName: \"Any Rcode\"","title":"Expected DNS Response Rcode Type","enum":["DNS_RES_RCODE_NOERROR","DNS_RES_RCODE_ANY"],"default":"DNS_RES_RCODE_NOERROR"},"healthcheckDNSResponseRecordType":{"type":"string","description":"x-displayName: \"DNS Response Record Type\"\nDNS Response Record Type\n\n - DNS_REQUESTED_QUERY_TYPE: Requested Query Type\n\nx-displayName: \"Same as Requested Query Type\"\n - DNS_RES_RECORD_TYPE_ANY: Any Record Type\n\nx-displayName: \"Any Record Type\"","title":"DNS Response Record Type","enum":["DNS_REQUESTED_QUERY_TYPE","DNS_RES_RECORD_TYPE_ANY"],"default":"DNS_REQUESTED_QUERY_TYPE"},"healthcheckDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a healthcheck","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.healthcheck.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"healthcheckDnsHealthCheck":{"type":"object","description":"x-displayName: \"DNS Health Check\"\nDNS health check reports healthy if DNS query is successful and response header and answer matches the given value","title":"DNS Health Check","properties":{"expected_rcode":{"$ref":"#/components/schemas/healthcheckDNSResponseRcodeType"},"expected_record_type":{"$ref":"#/components/schemas/healthcheckDNSResponseRecordType"},"expected_response":{"type":"string","description":"x-displayName: \"Expected Response Content\"\nx-example: \"10.0.0.1\"\nx-required\nSpecifies an IPv4 or IPv6 address in the answer section of DNS Response","title":"Expected Response Content"},"query_name":{"type":"string","description":"x-displayName: \"Query Name\"\nx-example: \"www.example.com\"\nx-required\nThe query name that the monitor sends a DNS query for.","title":"Query Name"},"query_type":{"$ref":"#/components/schemas/healthcheckDNSQueryType"},"reverse":{"type":"boolean","description":"x-displayName: \"Use Reverse mode\"\nx-example: false\nEnable the monitor operation in reverse mode. \nWhen the monitor is in reverse mode, a successful receive\nstring match marks the monitored object down instead of up.","title":"Use Reverse mode","format":"boolean"}}},"healthcheckDnsProxyTcpHealthCheck":{"type":"object","description":"x-displayName: \"TCP Health Check\"\nMonitor reports healthy status if UDP connection is successful and response payload matches expected response pattern","title":"DnsProxyTcpHealthCheck","properties":{"expected_response":{"type":"string","description":"x-displayName: \"Expected Response pattern\"\nx-example: \".*\"\nx-required\nSpecifies a regular expression pattern which will be matched against response payload","title":"expected response"},"send_payload":{"type":"string","description":"x-displayName: \"Send string\"\nx-example: \"\"\nx-required\nText string sent in the request","title":"send string"}}},"healthcheckDnsProxyUdpHealthCheck":{"type":"object","description":"x-displayName: \"UDP Health Check\"\nMonitor reports healthy status if TCP connection is successful and response payload matches expected response pattern","title":"DnsProxyUdpHealthCheck","properties":{"expected_response":{"type":"string","description":"x-displayName: \"Expected Response pattern\"\nx-example: \".*\"\nx-required\nSpecifies a regular expression pattern which will be matched against response payload","title":"expected response"},"send_payload":{"type":"string","description":"x-displayName: \"Send string\"\nx-example: \"\"\nx-required\nText string sent in the request","title":"send string"}}},"healthcheckGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read healthcheck","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.healthcheck.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/healthcheckCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/healthcheckReplaceRequest"},"spec":{"$ref":"#/components/schemas/healthcheckGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/healthcheckStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"healthcheckGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"healthcheckGetSpecType":{"type":"object","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","title":"Get healthcheck","x-displayname":"Get Health Check","x-ves-oneof-field-health_check":"[\"http_health_check\",\"tcp_health_check\",\"udp_icmp_health_check\"]","x-ves-proto-message":"ves.io.schema.healthcheck.GetSpecType","properties":{"healthy_threshold":{"type":"integer","description":" Number of successful responses before declaring healthy. In other words, this is\n the number of healthy health checks required before a host is marked\n healthy. Note that during startup, only a single successful health check is\n required to mark a host healthy.\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Healthy Threshold","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}},"http_health_check":{"$ref":"#/components/schemas/healthcheckHttpHealthCheck"},"interval":{"type":"integer","description":" Time interval in seconds between two healthcheck requests.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Interval","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"jitter_percent":{"type":"integer","description":" Add a random amount of time as a percent value to the interval between successive healthcheck requests.\n\nExample: ` \"25\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,10-50\n","format":"int64","x-displayname":"Jitter Percent","x-ves-example":"25","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,10-50"}},"tcp_health_check":{"$ref":"#/components/schemas/healthcheckTcpHealthCheck"},"timeout":{"type":"integer","description":" Timeout in seconds to wait for successful response. In other words, it is\n the time to wait for a health check response. If the timeout is reached the\n health check attempt will be considered a failure.\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Timeout","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"udp_icmp_health_check":{"$ref":"#/components/schemas/ioschemaEmpty"},"unhealthy_threshold":{"type":"integer","description":" Number of failed responses before declaring unhealthy. In other words, this is\n the number of unhealthy health checks required before a host is marked\n unhealthy. Note that for http health checking if a host responds with 503\n this threshold is ignored and the host is considered unhealthy immediately.\n\nExample: ` \"5\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Unhealthy Threshold","x-ves-example":"5","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}}}},"healthcheckHttpHealthCheck":{"type":"object","description":"Healthy if \"get\" method on URL \"http(s)://<host>/<path>\" with optional \"<header>\" returns success.\n\"host\" is not used for DNS resolution. It is used as HTTP Header in the request.","title":"HttpHealthCheck","x-displayname":"HTTP Health Check","x-ves-displayorder":"6,2,5,3,4,8","x-ves-oneof-field-host_header_choice":"[\"host_header\",\"use_origin_server_name\"]","x-ves-proto-message":"ves.io.schema.healthcheck.HttpHealthCheck","properties":{"expected_status_codes":{"type":"array","description":" Specifies a list of HTTP response status codes considered healthy. To treat default HTTP expected\n status code 200 as healthy, user has to configure it explicitly. This is a list of strings, each\n of which is single HTTP status code or a range with start and end values separated by \"-\".\n\nExample: ` \"200-250\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.http_status_range: true\n  ves.io.schema.rules.repeated.items.string.max_len: 10\n  ves.io.schema.rules.repeated.items.string.min_len: 3\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"Expected Status Codes","maxItems":16,"items":{"type":"string","minLength":3,"maxLength":10},"x-displayname":"Expected Status Codes","x-ves-example":"200-250","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.http_status_range":"true","ves.io.schema.rules.repeated.items.string.max_len":"10","ves.io.schema.rules.repeated.items.string.min_len":"3","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"headers":{"type":"object","description":" Specifies a list of HTTP headers that should be added to each request that is sent to the\n health checked cluster. This is a list of key-value pairs.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 256\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 16\n  ves.io.schema.rules.map.values.string.max_len: 2048\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"Headers to add in health check request","x-displayname":"Request Headers to Add","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"256","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"16","ves.io.schema.rules.map.values.string.max_len":"2048","ves.io.schema.rules.map.values.string.min_len":"1"}},"host_header":{"type":"string","description":"Exclusive with [use_origin_server_name]\n The value of the host header.\n\nExample: ` \"one.volterra.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hostport: true\n  ves.io.schema.rules.string.max_len: 262\n","title":"host_header","maxLength":262,"x-displayname":"Host Header Value","x-ves-example":"one.volterra.com","x-ves-validation-rules":{"ves.io.schema.rules.string.hostport":"true","ves.io.schema.rules.string.max_len":"262"}},"path":{"type":"string","description":" Specifies the HTTP path that will be requested during health checking.\n\nExample: ` \"/healthcheck\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 2048\n","title":"path","maxLength":2048,"x-displayname":"Path","x-ves-example":"/healthcheck","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"2048"}},"request_headers_to_remove":{"type":"array","description":" Specifies a list of HTTP headers that should be removed from each request that is sent to the\n health checked cluster. This is a list of keys of headers.\n\nExample: ` \"user-agent\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_len: 256\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"Headers to be removed from health check request","maxItems":16,"items":{"type":"string","maxLength":256},"x-displayname":"Request Headers to Remove","x-ves-example":"user-agent","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_len":"256","ves.io.schema.rules.repeated.max_items":"16"}},"use_http2":{"type":"boolean","description":" If set, health checks will be made using http/2.\n\nExample: ` false`","title":"Use HTTP2","format":"boolean","x-displayname":"Use HTTP2"},"use_origin_server_name":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"healthcheckListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of healthcheck","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.healthcheck.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/healthcheckListResponseItem"},"x-displayname":"Items"}}},"healthcheckListResponseItem":{"type":"object","description":"By default a summary of healthcheck 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 healthcheck","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.healthcheck.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this healthcheck","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this healthcheck","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates healthcheck is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/healthcheckGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this healthcheck","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this healthcheck\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/healthcheckStatusObject"},"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 healthcheck\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"healthcheckReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a healthcheck","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.healthcheck.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/healthcheckReplaceSpecType"}}},"healthcheckReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.healthcheck.ReplaceResponse"},"healthcheckReplaceSpecType":{"type":"object","description":"Healthcheck object defines method to determine if the given Endpoint is healthy.\nSingle Healthcheck object can be referred to by one or many Cluster objects.","title":"replace healthcheck","x-displayname":"Replace Health Check","x-ves-oneof-field-health_check":"[\"http_health_check\",\"tcp_health_check\",\"udp_icmp_health_check\"]","x-ves-proto-message":"ves.io.schema.healthcheck.ReplaceSpecType","properties":{"healthy_threshold":{"type":"integer","description":" Number of successful responses before declaring healthy. In other words, this is\n the number of healthy health checks required before a host is marked\n healthy. Note that during startup, only a single successful health check is\n required to mark a host healthy.\n\nExample: ` \"2\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Healthy Threshold","x-ves-example":"2","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}},"http_health_check":{"$ref":"#/components/schemas/healthcheckHttpHealthCheck"},"interval":{"type":"integer","description":" Time interval in seconds between two healthcheck requests.\n\nExample: ` \"10\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Interval","x-ves-example":"10","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"jitter_percent":{"type":"integer","description":" Add a random amount of time as a percent value to the interval between successive healthcheck requests.\n\nExample: ` \"25\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 0,10-50\n","format":"int64","x-displayname":"Jitter Percent","x-ves-example":"25","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"0,10-50"}},"tcp_health_check":{"$ref":"#/components/schemas/healthcheckTcpHealthCheck"},"timeout":{"type":"integer","description":" Timeout in seconds to wait for successful response. In other words, it is\n the time to wait for a health check response. If the timeout is reached the\n health check attempt will be considered a failure.\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 600\n","format":"int64","x-displayname":"Timeout","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"600"}},"udp_icmp_health_check":{"$ref":"#/components/schemas/ioschemaEmpty"},"unhealthy_threshold":{"type":"integer","description":" Number of failed responses before declaring unhealthy. In other words, this is\n the number of unhealthy health checks required before a host is marked\n unhealthy. Note that for http health checking if a host responds with 503\n this threshold is ignored and the host is considered unhealthy immediately.\n\nExample: ` \"5\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 16\n","format":"int64","x-displayname":"Unhealthy Threshold","x-ves-example":"5","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"16"}}}},"healthcheckStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Healthcheck Status","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.healthcheck.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"healthcheckTcpHealthCheck":{"type":"object","description":"Healthy if TCP connection is successful and response payload matches <expected_response>","title":"TcpHealthCheck","x-displayname":"TCP Health Check","x-ves-proto-message":"ves.io.schema.healthcheck.TcpHealthCheck","properties":{"expected_response":{"type":"string","description":" raw bytes expected in the request. Describes the encoding of the payload bytes in the payload.\n Hex encoded payload.\n\nExample: ` \"00000034\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hex: true\n  ves.io.schema.rules.string.max_len: 2048\n","title":"expected response","maxLength":2048,"x-displayname":"Expected Response","x-ves-example":"00000034","x-ves-validation-rules":{"ves.io.schema.rules.string.hex":"true","ves.io.schema.rules.string.max_len":"2048"}},"send_payload":{"type":"string","description":" raw bytes sent in the request. Empty payloads imply a connect-only health check.\n Describes the encoding of the payload bytes in the payload.\n Hex encoded payload.\n\nExample: ` \"000000FF\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.hex: true\n  ves.io.schema.rules.string.max_len: 2048\n","title":"send payload","maxLength":2048,"x-displayname":"Send Payload","x-ves-example":"000000FF","x-ves-validation-rules":{"ves.io.schema.rules.string.hex":"true","ves.io.schema.rules.string.max_len":"2048"}}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"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"}}}}}}