@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.sensitive_data_policy","description":"The sensitive_data_policy is a policy defined by the user to discover the relevant compliances\nand data types to the user.\nthe user can disabled predefined data types, and add custom data types.\nthe user defines the compliance list that he'd like to monitor.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/sensitive_data_policys":{"post":{"summary":"Create Sensitive Data Discovery","description":"Create sensitive_data_policy creates a new object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.sensitive_data_policy.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sensitive_data_policyCreateResponse"}}}},"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/sensitive_data_policyCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-sensitive_data_policy-api-create"},"x-ves-proto-rpc":"ves.io.schema.sensitive_data_policy.API.Create"},"x-displayname":"Sensitive Data Discovery","x-ves-proto-service":"ves.io.schema.sensitive_data_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/sensitive_data_policys/{metadata.name}":{"put":{"summary":"Replace Sensitive Data Discovery","description":"Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.","operationId":"ves.io.schema.sensitive_data_policy.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sensitive_data_policyReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sensitive_data_policyReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-sensitive_data_policy-api-replace"},"x-ves-proto-rpc":"ves.io.schema.sensitive_data_policy.API.Replace"},"x-displayname":"Sensitive Data Discovery","x-ves-proto-service":"ves.io.schema.sensitive_data_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/sensitive_data_policys":{"get":{"summary":"List Sensitive Data Discovery","description":"List the set of sensitive_data_policy in a namespace","operationId":"ves.io.schema.sensitive_data_policy.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sensitive_data_policyListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of sensitive_data_policy","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-sensitive_data_policy-api-list"},"x-ves-proto-rpc":"ves.io.schema.sensitive_data_policy.API.List"},"x-displayname":"Sensitive Data Discovery","x-ves-proto-service":"ves.io.schema.sensitive_data_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/sensitive_data_policys/{name}":{"get":{"summary":"Get Sensitive Data Discovery","description":"Get sensitive_data_policy reads a given object from storage backend for metadata.namespace.","operationId":"ves.io.schema.sensitive_data_policy.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sensitive_data_policyGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in 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-sensitive_data_policy-api-get"},"x-ves-proto-rpc":"ves.io.schema.sensitive_data_policy.API.Get"},"delete":{"summary":"Delete Sensitive Data Discovery","description":"Delete the specified sensitive_data_policy","operationId":"ves.io.schema.sensitive_data_policy.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/sensitive_data_policyDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-sensitive_data_policy-api-delete"},"x-ves-proto-rpc":"ves.io.schema.sensitive_data_policy.API.Delete"},"x-displayname":"Sensitive Data Discovery","x-ves-proto-service":"ves.io.schema.sensitive_data_policy.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Sensitive Data Discovery","x-ves-proto-package":"ves.io.schema.sensitive_data_policy","components":{"schemas":{"data_typeCompliance":{"type":"string","description":"Supported compliances frameworks\n","title":"Compliance","enum":["GDPR","CCPA","PIPEDA","LGPD","DPA_UK","PDPA_SG","APPI","HIPAA","CPRA_2023","CPA_CO","SOC2","PCI_DSS","ISO_IEC_27001","ISO_IEC_27701","EPRIVACY_DIRECTIVE","GLBA","SOX"],"default":"UNSPECIFIED","x-displayname":"Compliance","x-ves-proto-enum":"ves.io.schema.data_type.Compliance"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"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"}}},"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"}}},"schemasensitive_data_policyCreateSpecType":{"type":"object","description":"Create sensitive_data_policy creates a new object in the storage backend for metadata.namespace.","title":"Create sensitive data discovery","x-displayname":"Create Sensitive Data Discovery","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.CreateSpecType","properties":{"compliances":{"type":"array","description":" Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Compliance Frameworks","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"custom_data_types":{"type":"array","description":" Select your custom data types to be monitored in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/sensitive_data_policyCustomDataTypeRef"},"x-displayname":"Defined Custom Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"disabled_predefined_data_types":{"type":"array","description":" Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 64\n","maxItems":100,"items":{"type":"string","maxLength":64},"x-displayname":"Disabled Built-In Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"64"}}}},"schemasensitive_data_policyGetSpecType":{"type":"object","description":"Get sensitive_data_policy reads a given object from storage backend for metadata.namespace.","title":"Get sensitive data discovery","x-displayname":"Get Sensitive Data Discovery","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.GetSpecType","properties":{"compliances":{"type":"array","description":" Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Compliance Frameworks","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"custom_data_types":{"type":"array","description":" Select your custom data types to be monitored in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/sensitive_data_policyCustomDataTypeRef"},"x-displayname":"Defined Custom Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"disabled_predefined_data_types":{"type":"array","description":" Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 64\n","maxItems":100,"items":{"type":"string","maxLength":64},"x-displayname":"Disabled Built-In Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"64"}}}},"schemasensitive_data_policyReplaceSpecType":{"type":"object","description":"Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.","title":"Replace sensitive data discovery","x-displayname":"Replace Sensitive Data Discovery","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.ReplaceSpecType","properties":{"compliances":{"type":"array","description":" Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [0]\n  ves.io.schema.rules.repeated.max_items: 17\n  ves.io.schema.rules.repeated.unique: true\n","maxItems":17,"items":{"$ref":"#/components/schemas/data_typeCompliance"},"x-displayname":"Compliance Frameworks","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[0]","ves.io.schema.rules.repeated.max_items":"17","ves.io.schema.rules.repeated.unique":"true"}},"custom_data_types":{"type":"array","description":" Select your custom data types to be monitored in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/sensitive_data_policyCustomDataTypeRef"},"x-displayname":"Defined Custom Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"disabled_predefined_data_types":{"type":"array","description":" Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 100\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 64\n","maxItems":100,"items":{"type":"string","maxLength":64},"x-displayname":"Disabled Built-In Sensitive Data Types","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"100","ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"64"}}}},"schemasensitive_data_policyStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Status of sensitive_data_policy","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"sensitive_data_policyCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of sensitive_data_policy","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemasensitive_data_policyCreateSpecType"}}},"sensitive_data_policyCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemasensitive_data_policyGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"sensitive_data_policyCustomDataTypeRef":{"type":"object","description":"List of custom data types to monitor","title":"custom_data_type_ref","x-displayname":"Defined Custom Sensitive Data Types","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.CustomDataTypeRef","properties":{"custom_data_type_ref":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"sensitive_data_policyDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a sensitive_data_policy","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.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"}}},"sensitive_data_policyGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read sensitive_data_policy","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/sensitive_data_policyCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/sensitive_data_policyReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemasensitive_data_policyGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/schemasensitive_data_policyStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"sensitive_data_policyGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_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"},"sensitive_data_policyListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of sensitive_data_policy","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/sensitive_data_policyListResponseItem"},"x-displayname":"Items"}}},"sensitive_data_policyListResponseItem":{"type":"object","description":"By default a summary of sensitive_data_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of sensitive_data_policy","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this sensitive_data_policy","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this sensitive_data_policy","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates sensitive_data_policy is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemasensitive_data_policyGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this sensitive_data_policy","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this sensitive_data_policy\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/schemasensitive_data_policyStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this sensitive_data_policy\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"sensitive_data_policyReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a sensitive_data_policy","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemasensitive_data_policyReplaceSpecType"}}},"sensitive_data_policyReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.sensitive_data_policy.ReplaceResponse"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0207.public.ves.io.schema.graph.service.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.graph.service","description":"graph/service api is query used to get monitoring information for service mesh of given application type. Service mesh is defined when ves.io/app_type label\nis added to group of services or virtual_host. It returns graph which is set of nodes and edges. Each node represents service and\nedge is access between services. Edges are directed from client to server. Two edges can be present for a given pair of service.\nOnly method post is supported. Query parameters are present in the request body. It is always scoped by namespace.","version":""},"paths":{"/api/data/namespaces/system/graph/all_ns_service":{"post":{"summary":"Service Graph Query All Namespaces","description":"Request to get monitoring data for a service mesh of a given application.","operationId":"ves.io.schema.graph.service.CustomAPI.QueryAllNamespaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/serviceRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-service-customapi-queryallnamespaces"},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.QueryAllNamespaces"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/lb_cache_content":{"post":{"summary":"Cacheability query Query","description":"Request to get time-series cacheable data for HTTP-LBs.","operationId":"ves.io.schema.graph.service.CustomAPI.LBCacheContent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceLBCacheContentResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope load balancers. Only LB's in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceLBCacheContentRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-service-customapi-lbcachecontent"},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.LBCacheContent"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service":{"post":{"summary":"Service Graph Query","description":"Request to get monitoring data for a service mesh of a given application.","operationId":"ves.io.schema.graph.service.CustomAPI.Query","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/serviceRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-service-customapi-query"},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.Query"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service/app_types":{"get":{"summary":"Application Types","description":"Request to get list of application types for a given namespace.\nFor system namespace, all the application types for the tenant\nwill be returned in the response.","operationId":"ves.io.schema.graph.service.CustomAPI.AppTypeList","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceAppTypeListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the listing of app types\nFor system namespace, all the app_types for the tenant will be returned in the response.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"start_time","description":"x-example: \"1570194000\"\nstart time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|rfc 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\n          If end_time is not specified, then the start_time will be evaluated to <current time>-10m","in":"query","required":false,"x-displayname":"Start Time","schema":{"type":"string"}},{"name":"end_time","description":"x-example: \"1570197600\"\nend time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|rfc 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\n          If start_time is not specified, then the end_time will be evaluated to <current time>","in":"query","required":false,"x-displayname":"End Time","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-service-customapi-apptypelist"},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.AppTypeList"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service/edge":{"post":{"summary":"Service Edge Query","description":"Request to get time-series data for an edge in the service mesh graph.","operationId":"ves.io.schema.graph.service.CustomAPI.EdgeQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceEdgeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the application traffic to a given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceEdgeRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.EdgeQuery"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service/node":{"post":{"summary":"Service Node Query","description":"Request to get time-series data for a node in the service mesh graph.","operationId":"ves.io.schema.graph.service.CustomAPI.NodeQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceNodeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the application traffic to a given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceNodeRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.NodeQuery"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service/node/instance":{"post":{"summary":"Service Instance Query","description":"Request to get time-series data for a service instance.","operationId":"ves.io.schema.graph.service.CustomAPI.InstanceQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceInstanceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope application traffic to a given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceInstanceRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.InstanceQuery"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/service/node/instances":{"post":{"summary":"Service Instances Query","description":"Request to get monitoring data for all instances of a service in the service mesh.","operationId":"ves.io.schema.graph.service.CustomAPI.InstancesQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceInstancesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope application traffic to a given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceInstancesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-service-customapi-instancesquery"},"x-ves-proto-rpc":"ves.io.schema.graph.service.CustomAPI.InstancesQuery"},"x-displayname":"Service Graph","x-ves-proto-service":"ves.io.schema.graph.service.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Service Graph","x-ves-proto-package":"ves.io.schema.graph.service","components":{"requestBodies":{"serviceRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/serviceRequest"}}},"required":true}},"schemas":{"app_typeAPIEPCategory":{"type":"string","description":"The category of an API endpoint.\n\nDiscovered API Endpoint.\nThe API Endpoint is imported from user swagger.\nThe API Endpoint is present at the API Inventory.\nThe API Endpoint is considered as part of Shadow API.\nDeprecated API Endpoint.\nNon-API Endpoint.","title":"APIEP Category","enum":["APIEP_CATEGORY_DISCOVERED","APIEP_CATEGORY_SWAGGER","APIEP_CATEGORY_INVENTORY","APIEP_CATEGORY_SHADOW","APIEP_CATEGORY_DEPRECATED","APIEP_CATEGORY_NON_API"],"default":"APIEP_CATEGORY_DISCOVERED","x-displayname":"Category of the API Endpoint","x-ves-proto-enum":"ves.io.schema.app_type.APIEPCategory"},"app_typeAPIEPDynExample":{"type":"object","description":"List of Examples of expanded URL components for API endpoints that are collapsed with a dynamic component that is identified automatically","title":"API endpoint dynamic example","x-displayname":"Expanded API Endpoints","x-ves-proto-message":"ves.io.schema.app_type.APIEPDynExample","properties":{"component_examples":{"type":"array","description":" List of sample URL(s) that are collapsed\n\nExample: ` \"[d0161a1e-044e-427b-a806-3bad9eac97fc, a74eb844-6d91-474c-9874-f19fa3983f4d]\"`","title":"List of expanded URLs","items":{"type":"string"},"x-displayname":"Expanded URL(s)","x-ves-example":"[d0161a1e-044e-427b-a806-3bad9eac97fc, a74eb844-6d91-474c-9874-f19fa3983f4d]"},"component_identifier":{"type":"string","description":" Dynamic component used to collapse sample URLs given in Expanded URLs\n\nExample: ` \"/api/v1/user_id/DYN\"`","title":"Dynamic component","x-displayname":"Dynamic Component","x-ves-example":"/api/v1/user_id/DYN"}}},"app_typeAPIEPInfo":{"type":"object","description":"Information about automatically identified API endpoint\nEach identified API endpoint has a CollapsedURL and Method.\nCollapsedURL is created by replacing dynamic components in the URL, if any, with the keyword DYN.\nThese dynamic components are automatically identified.\nAdditionally, any API endpoint that has a collapsedURL with automatically identified DYN components,\nwill also have DYN-Examples which show a few examples of the original values of the components that were determined to be DYN.","title":"Identified API","x-displayname":"API Endpoint Info","x-ves-proto-message":"ves.io.schema.app_type.APIEPInfo","properties":{"access_discovery_time":{"type":"string","description":" access_discovery_time is the time when the API endpoint\n was updated from the access logs by the discovery mechanism.\n It is the UTC time and represented in RFC3339 form.","title":"access_discovery_time","format":"date-time","x-displayname":"Access Discovery Time"},"api_groups":{"type":"array","description":" List of API Groups the API Endpoint is a member of.\n\nExample: ` [\"sensitive\", \"read-only\"]`","title":"API Groups membership","items":{"type":"string"},"x-displayname":"API Groups membership"},"api_type":{"$ref":"#/components/schemas/app_typeAPIType"},"attributes":{"type":"array","description":" List of api endpoint attributes.\n\nExample: ` [GraphQL, login etc.]`","title":"attributes","items":{"type":"string"},"x-displayname":"Attributes"},"authentication_state":{"$ref":"#/components/schemas/app_typeAuthenticationState"},"authentication_types":{"type":"array","description":" List of authentication types found in the API endpoint and their locations.","title":"authentication_types","items":{"$ref":"#/components/schemas/app_typeAuthenticationTypeLocPair"},"x-displayname":"Authentication Types and Locations"},"avg_latency":{"type":"number","description":" Average latency observed for the API Endpoint.\n\nExample: ` 2.34`","title":"avg_latency","format":"float","x-displayname":"Average Latency"},"base_path":{"type":"string","description":" The base path for this Endpoint.\n\nExample: ` \"/v1\"`","title":"base_path","x-displayname":"Base Path","x-ves-example":"/v1"},"category":{"type":"array","description":" The category of the API Endpoint relative to API Inventory.\n\nExample: ` APIEP_CATEGORY_DISCOVERED, APIEP_CATEGORY_INVENTORY`","title":"Category","items":{"$ref":"#/components/schemas/app_typeAPIEPCategory"},"x-displayname":"Category"},"collapsed_url":{"type":"string","description":" URL for automatically identified API\n\nExample: ` \"/api/v1/user_id/DYN/vehicle_id/DYN\"`","title":"Identified API","x-displayname":"API endpoint URL","x-ves-example":"/api/v1/user_id/DYN/vehicle_id/DYN"},"compliances":{"type":"array","description":" List of compliance frameworks of the Endpoint.\n\nExample: ` [\"GDPR\", \"HIPAA\", \"CCPA\"]`","title":"compliances","items":{"type":"string"},"x-displayname":"Compliances"},"domains":{"type":"array","description":" List of Domains of the API endpoint\n\nExample: ` \"[www.example1.com\", \"www.example2.com]\"`","title":"List of domains","items":{"type":"string"},"x-displayname":"List of Domains","x-ves-example":"[www.example1.com\", \"www.example2.com]"},"dyn_examples":{"type":"array","description":" For example -\n {\"dyn_examples\": [\n  {\n    \"component_identifier\": \"api/v1/user_id/DYN\",\n    \"component_examples\": [\n      \"cmenomo007\",\n      \"marcusaurelius\"\n      \"artattacksince1947\",\n      \"johndoe83\",\n    ]\n  },\n  {\n    \"component_identifier\": \"api/v1/user_id/DYN/vehicle_id/DYN\",\n    \"component_examples\": [\n      \"JN1CV6AR3AM458367\",\n      \"1GBCS10AXP2917522\",\n      \"JM1DE1KY9D0155647\",\n      \"JN1CA31D5YT533780\"\n    ]\n  }\n ]}\n List  of sample URL(s) that are collapsed and dynamic components to collapse them\n\nExample: ` \"{component_identifierapi/v1/user_id/DYN,component_examples: [cmenomo007]}\"`","title":"Expanded URL(s)","items":{"$ref":"#/components/schemas/app_typeAPIEPDynExample"},"x-displayname":"Expanded URL(s)","x-ves-example":"{component_identifier: api/v1/user_id/DYN,component_examples: [cmenomo007]}"},"engines":{"type":"array","description":" List of engines that detected the endpoint.\n\nExample: ` [\"TRAFFIC_INSPECTION\", \"CODE_ANALYSIS\", \"CRAWLER\"]`","title":"engines","items":{"type":"string"},"x-displayname":"Engines"},"err_rsp_count":{"type":"string","description":" Number of request with 4xx or 5xx response for the API Endpoint\n\nExample: ` 1234`","title":"error status code count","format":"uint64","x-displayname":"Error Count"},"has_learnt_schema":{"type":"boolean","description":"Has Learnt Schema flag for request API endpoint.\n\nExample: ` true`","title":"Has Learnt Schema","format":"boolean","x-displayname":"Has Learnt Schema"},"last_tested":{"type":"string","description":" api testing last tested time is the time when the API endpoint\n was last tested","title":"last api testing","format":"date-time","x-displayname":"Last tested"},"max_latency":{"type":"number","description":" Maximum latency observed for the API Endpoint.\n\nExample: ` 9.87`","title":"max_latency","format":"float","x-displayname":"Max Latency"},"method":{"type":"string","description":" HTTP method for the API.\n\nExample: ` \"GET\"`","title":"HTTP method","x-displayname":"HTTP Method","x-ves-example":"GET"},"pdf_info":{"$ref":"#/components/schemas/app_typeAPIEPPDFInfo"},"pii_level":{"$ref":"#/components/schemas/app_typeAPIEPPIILevel"},"req_rate":{"type":"number","description":" Request rate for the API Endpoint.\n\nExample: ` 10.5`","title":"req_rate","format":"float","x-displayname":"Request Rate"},"request_percentage":{"type":"number","description":" Percentage of requests that were directed to this API Endpoint\n\nExample: ` \"78.5789\"`","title":"Request percentage","format":"float","x-displayname":"Request Percentage","x-ves-example":"78.5789"},"requests_count":{"type":"integer","description":" Number of requests seen for this API Endpoint for the specified time-range.\n\nExample: ` \"1234\"`","title":"requests_count","format":"int32","x-displayname":"Number Of Total Requests","x-ves-example":"1234"},"risk_score":{"$ref":"#/components/schemas/app_typeRiskScore"},"schema_status":{"type":"string","description":" Schema status indicates the API Endpoint's schema origin and if it's outdated.\n\nExample: ` \"Discovered Not-Updated\"`","title":"schema_status","x-displayname":"Schema Status","x-ves-example":"Discovered Not-Updated"},"sec_events_count":{"type":"integer","description":" Number of sec_events seen for this API Endpoint for the specified time-range.\n\nExample: ` \"1234\"`","title":"sec_events_count","format":"int32","x-displayname":"Number Of Total Security Events","x-ves-example":"1234"},"security_risk":{"$ref":"#/components/schemas/app_typeAPIEPSecurityRisk"},"sensitive_data":{"type":"array","description":" List of Sensitive Data found in the API endpoint\n\nExample: ` \"[SENSITIVE_DATA_TYPE_CCN, SENSITIVE_DATA_TYPE_SSN, SENSITIVE_DATA_TYPE_IP]\"`","title":"List of Sensitive Data","items":{"$ref":"#/components/schemas/app_typeSensitiveDataType"},"x-displayname":"List of Sensitive Data","x-ves-example":"[SENSITIVE_DATA_TYPE_CCN, SENSITIVE_DATA_TYPE_SSN, SENSITIVE_DATA_TYPE_IP]"},"sensitive_data_location":{"type":"array","description":" Sensitive data location for the API Endpoint.\n\nExample: ` Request`","title":"sensitive data location","items":{"type":"string"},"x-displayname":"Sensitive Data Location"},"sensitive_data_types":{"type":"array","description":" List of Sensitive Data found in the API endpoint\n\nExample: ` \"[Social-Security-Number, Credit-Card-Number]\"`","title":"List of Sensitive Data","items":{"type":"string"},"x-displayname":"List of Sensitive Data","x-ves-example":"[Social-Security-Number, Credit-Card-Number]"}}},"app_typeAPIEPPDFInfo":{"type":"object","description":"Metrics supported currently are request_size response_size latency_with_data, latency_no_data.\nPDF is calculated for each combination of (Tenant, App type, API endpoint).\nAPI endpoint is determined from automatically identified API (collapsed_url) and method.\nIn the univariate case PDFSpec for each metric is repeated num_pdf_samples times.\nnum_pdf_samples is a parameter is system wide parameter currently set to 200.","title":"Probability Density Function","x-displayname":"PDF(Value)","x-ves-displayorder":"1,2,4,3,5,6,7","x-ves-proto-message":"ves.io.schema.app_type.APIEPPDFInfo","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp represents the time when this PDF was created\n It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"error_rate":{"type":"array","description":" List of Probability density points for PDF for error rate","title":"PDF(error rate)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Error Rate)"},"error_rate_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"latency_no_data":{"type":"array","description":" List of Probability density points for PDF for latency of response begin","title":"PDF(response latency to first byte)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Latency Begin)"},"latency_no_data_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"latency_with_data":{"type":"array","description":" List of Probability density points for PDF for latency of response end","title":"PDF(response latency)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Latency End)"},"latency_with_data_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"request_rate":{"type":"array","description":" List of Probability density points for PDF for request rate","title":"PDF(request rate)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Request Rate)"},"request_rate_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"request_size":{"type":"array","description":" List of Probability density points for PDF for request size","title":"PDF(request_size)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Request)"},"request_size_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"response_size":{"type":"array","description":" List of Probability density points for PDF for response size","title":"PDF(response_size)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Response)"},"response_size_stat":{"$ref":"#/components/schemas/app_typePDFStat"},"response_throughput":{"type":"array","description":" List of Probability density points for PDF for response throughput","title":"PDF(response throughput)","items":{"$ref":"#/components/schemas/app_typePDFSpec"},"x-displayname":"PDF(Response Throughput)"},"response_throughput_stat":{"$ref":"#/components/schemas/app_typePDFStat"}}},"app_typeAPIEPPIILevel":{"type":"string","description":"API Endpoint's PII Level.\n\nNo PII data detected for the given API Endpoint.\nDetected PII data for a given API Endpoint.","title":"APIEP PII Level","enum":["APIEP_PII_NOT_DETECTED","APIEP_PII_DETECTED"],"default":"APIEP_PII_NOT_DETECTED","x-displayname":"API EP PII Level","x-ves-proto-enum":"ves.io.schema.app_type.APIEPPIILevel"},"app_typeAPIEPSecurityRisk":{"type":"string","description":"Signifies API Endpoint Security Risk Level\n\nSecurity risk is not detected (for example, when no traffic).\nAPI Endpoint has low security risk.\nAPI Endpoint has medium security risk.\nAPI Endpoint has high security risk.\nAPI Endpoint has critical security risk.","title":"APIEP Security Risk","enum":["APIEP_SEC_RISK_NONE","APIEP_SEC_RISK_LOW","APIEP_SEC_RISK_MED","APIEP_SEC_RISK_HIGH","APIEP_SEC_RISK_CRITICAL"],"default":"APIEP_SEC_RISK_NONE","x-displayname":"API Endpoint Security Risk","x-ves-proto-enum":"ves.io.schema.app_type.APIEPSecurityRisk"},"app_typeAPIType":{"type":"string","description":"List of possible types of api that can be discovered for an APIEP.\n\nThe API Type detected as unknown.\nThe API Type detected as GraphQL.\nThe API Type detected as REST.\nThe API Type detected as gRPC.","title":"APIType","enum":["API_TYPE_UNKNOWN","API_TYPE_GRAPHQL","API_TYPE_REST","API_TYPE_GRPC"],"default":"API_TYPE_UNKNOWN","x-displayname":"API Type","x-ves-proto-enum":"ves.io.schema.app_type.APIType"},"app_typeAuthenticationLocation":{"type":"string","description":"API Endpoint's Authentication Location.\n\nThe API Endpoint authentication location is header.\nThe API Endpoint authentication location is query parameter.\nThe API Endpoint authentication location is request body.\nThe API Endpoint authentication location is cookie.","title":"APIEP Authentication Location","enum":["AUTH_LOCATION_HEADER","AUTH_LOCATION_QUERY","AUTH_LOCATION_BODY","AUTH_LOCATION_COOKIE"],"default":"AUTH_LOCATION_HEADER","x-displayname":"API EP Authentication Location","x-ves-proto-enum":"ves.io.schema.app_type.AuthenticationLocation"},"app_typeAuthenticationState":{"type":"string","description":"API Endpoint's Authentication State.\n\nThe API Endpoint authentication state is unknown.\nThe API Endpoint is authenticated\nThe API Endpoint is unauthenticated","title":"APIEP Authentication State","enum":["AUTH_STATE_UNKNOWN","AUTH_STATE_AUTHENTICATED","AUTH_STATE_UNAUTHENTICATED"],"default":"AUTH_STATE_UNKNOWN","x-displayname":"API EP Authentication State","x-ves-proto-enum":"ves.io.schema.app_type.AuthenticationState"},"app_typeAuthenticationType":{"type":"string","description":"API Endpoint's Authentication Type.\n\nThe API Endpoint authentication type is Basic.\nThe API Endpoint authentication type is Bearer.\nThe API Endpoint authentication type is JWT.\nThe API Endpoint authentication type is API Key.\nThe API Endpoint authentication type is OAuth 2.0.\nThe API Endpoint authentication type is OpenID Connect Discovery.\nThe API Endpoint authentication type is HTTP.\nThe API Endpoint authentication type is OAuth 1.0.\nThe API Endpoint authentication type is Digest.\nThe API Endpoint authentication type is Negotiate.","title":"APIEP Authentication Type","enum":["AUTH_TYPE_BASIC","AUTH_TYPE_BEARER","AUTH_TYPE_JWT","AUTH_TYPE_API_KEY","AUTH_TYPE_OAUTH2","AUTH_TYPE_OPENID","AUTH_TYPE_HTTP","AUTH_TYPE_OAUTH1","AUTH_TYPE_DIGEST","AUTH_TYPE_NEGOTIATE"],"default":"AUTH_TYPE_BASIC","x-displayname":"API EP Authentication Type","x-ves-proto-enum":"ves.io.schema.app_type.AuthenticationType"},"app_typeAuthenticationTypeLocPair":{"type":"object","description":"API Endpoint's Authentication Type and Location.","title":"APIEP Authentication Type and Location Pair","x-displayname":"API EP Authentication Type and Location Pair","x-ves-proto-message":"ves.io.schema.app_type.AuthenticationTypeLocPair","properties":{"auth_type":{"type":"string","description":" The detected authentication type by string format\n\nExample: ` \"Basic\"`","title":"auth_type","x-displayname":"Authentication Type","x-ves-example":"Basic"},"location":{"$ref":"#/components/schemas/app_typeAuthenticationLocation"},"type":{"$ref":"#/components/schemas/app_typeAuthenticationType"}}},"app_typePDFSpec":{"type":"object","description":"Probability Density point in (PDF(x)) of the metric.\nx is the value of the metric, probability is the corresponding PDF(x).\nIn the univariate case (current configuration), the value x of the metrics is a scaler.\nAs PDFSpec is repeated (see below), the x values are linearly spaced monotonically from minimum to maximum.","title":"Probability Density Point(x,y)","x-displayname":"Point(Value, Probability)","x-ves-proto-message":"ves.io.schema.app_type.PDFSpec","properties":{"probability":{"type":"number","description":" Probability of given Value of the metric that can be plotted on y-axis\n\nExample: ` \"0.078\"`","title":"Probability","format":"float","x-displayname":"Probability","x-ves-example":"0.078"},"x":{"type":"number","description":" Value of the metric that can be plotted on x-axis\n\nExample: ` \"121.316\"`","title":"Metric Value","format":"float","x-displayname":"Value","x-ves-example":"121.316"}}},"app_typePDFStat":{"type":"object","description":"Probability Density Function statistics of the metric.\npdf_mean is the mean PDF of the metric, pdf_95 is the 95th percentile PDF of the metric.\nIn the univariate case PDFStat for each metric consists of pdf_mean and pdf_95.","title":"Probability Density Function Statistics","x-displayname":"PDF(Statistics)","x-ves-proto-message":"ves.io.schema.app_type.PDFStat","properties":{"pdf_95":{"type":"number","description":" pdf_95 represents the 95th percentile of PDF\n\nExample: ` \"0.078\"`","title":"PDF 95th Percentile","format":"float","x-displayname":"PDF(95th Percentile)","x-ves-example":"0.078"},"pdf_mean":{"type":"number","description":" pdf_mean represents the mean of PDF","title":"PDF Mean","format":"float","x-displayname":"PDF(Mean)"}}},"app_typeRiskScore":{"type":"object","description":"Risk score of the vulnerabilities found for this API Endpoint.","title":"RiskScore","x-displayname":"Risk score","x-ves-proto-message":"ves.io.schema.app_type.RiskScore","properties":{"score":{"type":"number","description":" Score of the vulnerabilities found for this API Endpoint.","title":"score","format":"float","x-displayname":"Score"},"severity":{"$ref":"#/components/schemas/app_typeAPIEPSecurityRisk"}}},"app_typeSensitiveDataType":{"type":"string","description":"List of possible types of sensitive data that can be discovered for an APIEP.\n\nThe Sensitive Data detected as credit card number.\nThe sensitive data detected as social security number.\nThe sensitive data detected as IP address.\nThe sensitive data detected as email address.\nThe sensitive data detected as phone number.\nThe sensitive data detected as credentials info(e.g password, username etc).\nThe sensitive data detected as information leakage.\nThe sensitive data detected as masked PII (CCN, SSN)\nThe sensitive data detected as Location.","title":"SensitiveDataType","enum":["SENSITIVE_DATA_TYPE_CCN","SENSITIVE_DATA_TYPE_SSN","SENSITIVE_DATA_TYPE_IP","SENSITIVE_DATA_TYPE_EMAIL","SENSITIVE_DATA_TYPE_PHONE","SENSITIVE_DATA_TYPE_CREDENTIALS","SENSITIVE_DATA_TYPE_APP_INFO_LEAKAGE","SENSITIVE_DATA_TYPE_MASKED_PII","SENSITIVE_DATA_TYPE_LOCATION"],"default":"SENSITIVE_DATA_TYPE_CCN","x-displayname":"Sensitive Data Type","x-ves-proto-enum":"ves.io.schema.app_type.SensitiveDataType"},"graphEdgeMetricData":{"type":"object","description":"EdgeMetricData contains requested metric data for an edge","title":"Edge Metric Data","x-displayname":"Edge Metric Data","x-ves-proto-message":"ves.io.schema.graph.EdgeMetricData","properties":{"data":{"type":"array","description":" List of metric specified in the request for an edge","title":"Data","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Data"}}},"graphEdgeMetricSelector":{"type":"object","description":"EdgeMetricSelector is used to select the metrics that should be returned for an edge.","title":"Edge Metric Selector","x-displayname":"Edge Metric Selector","x-ves-proto-message":"ves.io.schema.graph.EdgeMetricSelector","properties":{"features":{"type":"array","description":" Specify list of timeseries features that should be returned for each metric type\n in the request.","title":"Features","items":{"$ref":"#/components/schemas/timeseriesTimeseriesFeature"},"x-displayname":"Features"},"types":{"type":"array","description":" Specify list of metrics that should be returned for each edge in the connectivity graph.","title":"Types","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Types"}}},"graphHealthscoreData":{"type":"object","description":"Contains the list of healthscores requested by the user.","title":"Healthscore Data","x-displayname":"Healthscore Data","x-ves-proto-message":"ves.io.schema.graph.HealthscoreData","properties":{"data":{"type":"array","description":" List of healthscores specified in the request.","title":"Data","items":{"$ref":"#/components/schemas/graphHealthscoreTypeData"},"x-displayname":"Data"}}},"graphHealthscoreSelector":{"type":"object","description":"Healthscore Selector is used to specify the healthscore types to be returned in the response.","title":"Healthscore Selector","x-displayname":"Healthscore Selector","x-ves-proto-message":"ves.io.schema.graph.HealthscoreSelector","properties":{"types":{"type":"array","description":" Healthscore types to be returned in the response.","title":"Types","items":{"$ref":"#/components/schemas/graphHealthscoreType"},"x-displayname":"Types"}}},"graphHealthscoreType":{"type":"string","description":"Healthscore for a site or service calculated based on SLAs and KPIs for the application\n\nHealthscore not requested\nx-unit: \"percentage\"\nConnectivity Healthscore\nx-unit: \"percentage\"\nPerformance Healthscore\nx-unit: \"percentage\"\nSecurity Healthscore\nx-unit: \"percentage\"\nReliability Healthscore\nx-unit: \"percentage\"\nOverall Healthscore","title":"Healthscore Type","enum":["HEALTHSCORE_NONE","HEALTHSCORE_CONNECTIVITY","HEALTHSCORE_PERFORMANCE","HEALTHSCORE_SECURITY","HEALTHSCORE_RELIABILITY","HEALTHSCORE_OVERALL"],"default":"HEALTHSCORE_NONE","x-displayname":"Healthscore Type","x-ves-proto-enum":"ves.io.schema.graph.HealthscoreType"},"graphHealthscoreTypeData":{"type":"object","description":"HealthScoreTypeData contains healthscore type and the corresponding value","title":"Healthscore Type Data","x-displayname":"Healthscore Type Data","x-ves-proto-message":"ves.io.schema.graph.HealthscoreTypeData","properties":{"reason":{"type":"string","description":" A human readable string explaining the reason in case of bad healthscore\n\nExample: ` \"Only one healthy RE connected\"`","title":"Reason","x-displayname":"Reason","x-ves-example":"Only one healthy RE connected"},"type":{"$ref":"#/components/schemas/graphHealthscoreType"},"value":{"type":"array","description":" Healthscore value","title":"Value","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Value"}}},"graphMetricData":{"type":"object","description":"MetricData contains the metric type and the corresponding metric value(s)","title":"Metric Data","x-displayname":"Metric Data","x-ves-proto-message":"ves.io.schema.graph.MetricData","properties":{"type":{"$ref":"#/components/schemas/schemagraphMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"},"value":{"$ref":"#/components/schemas/graphMetricFeatureData"}}},"graphMetricFeatureData":{"type":"object","description":"Contains metric values for timeseries features specified in the request.","title":"Metric Feature Data","x-displayname":"Metric Feature Data","x-ves-proto-message":"ves.io.schema.graph.MetricFeatureData","properties":{"anomaly":{"type":"array","description":" Number of anomalies for the given time range.","title":"Anomaly","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Anomaly"},"confidence_lower_bound":{"type":"array","description":" Lower Bound of the metric value","title":"Confidence Lower Bound","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Confidence Lower Bound"},"confidence_upper_bound":{"type":"array","description":" Upper Bound of the metric value","title":"Confidence Upper Bound","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Confidence Upper Bound"},"healthscore":{"type":"array","description":" Healscore of the metric calculated based on the number of anomalies\n and the value of the anomalies for the time range.","title":"Healthscore","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Healthscore"},"raw":{"type":"array","description":" List of metric values for a given metric type","title":"Raw","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Raw"},"trend":{"type":"array","description":" Indicates the metric trend","title":"Trend","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Trend"}}},"graphNodeMetricData":{"type":"object","description":"NodeMetricData contains the upstream and downstream metrics for a node.","title":"Node Metric Data","x-displayname":"Node Metric Data","x-ves-proto-message":"ves.io.schema.graph.NodeMetricData","properties":{"downstream":{"type":"array","description":" Metric data for the source site/service","title":"Downstream","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Downstream"},"upstream":{"type":"array","description":" Metric data for the destination site/service","title":"Upstream","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Upstream"}}},"graphNodeMetricSelector":{"type":"object","description":"NodeMetricSelector is used to select the metrics that should be returned for a node.","title":"Node Metric Selector","x-displayname":"Node Metric Selector","x-ves-proto-message":"ves.io.schema.graph.NodeMetricSelector","properties":{"downstream":{"type":"array","description":" Downstream refers to the service that sends requests and receives response.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Downstream","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Downstream","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"features":{"type":"array","description":" Specify list of timeseries features that should be returned for each metric type\n in the request.","title":"Features","items":{"$ref":"#/components/schemas/timeseriesTimeseriesFeature"},"x-displayname":"Features"},"upstream":{"type":"array","description":" Upstream refers to the service that receives requests and sends response.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Upstream","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Upstream","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"graphQueryOp":{"type":"string","description":"Match operators supported on a label\n\nIndicates that the field is not set\nSelect timeseries whose label value exactly matches the specified string\nSelect timeseries whose label value does not match the specified string","title":"Label Operator","enum":["NOP","EQ","NEQ"],"default":"NOP","x-displayname":"Label Operator","x-ves-proto-enum":"ves.io.schema.graph.QueryOp"},"graphserviceLabel":{"type":"string","description":"Metrics used to construct the service graph are tagged with these labels and therefore\nthe service metrics can be sliced and diced based on one or more of these labels.\n\nIndicates the field not being set\nIdentifies the source or destination site\nIdentifies the application type associated with the virtual host\nIdentifies the source or destination service.\nFor north-south traffic, source service is a network name (indicated by prefix \"N:\") and\nvirtual-service (indicated by prefix \"S:\") for east-west traffic; destination service is\nalways virtual-service.\nIdentifies the virtual host type.\nIdentifies the virtual host.\nVirtual host should always be specified along with the type.\nIdentifies the VIP associated with a virtual host\nIdentifies the Cacheability associated with a virtual host","title":"Label","enum":["LABEL_NONE","LABEL_SITE","LABEL_APP_TYPE","LABEL_SERVICE","LABEL_VHOST_TYPE","LABEL_VHOST","LABEL_VIP","LABEL_VHOST_CACHE"],"default":"LABEL_NONE","x-displayname":"Label","x-ves-proto-enum":"ves.io.schema.graph.service.Label"},"instanceInstanceId":{"type":"object","description":"Instance Id uniquely identifies a service instance.","title":"Instance ID","x-displayname":"Instance ID","x-ves-proto-message":"ves.io.schema.graph.service.instance.InstanceId","properties":{"app_type":{"type":"string","description":" Identifies the application type associated with the service instance\n\nExample: ` \"myapp\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"myapp"},"instance":{"type":"string","description":" Name of the service instance\n\nExample: ` \"productpage-abc\"`","title":"Instance","x-displayname":"Instance","x-ves-example":"productpage-abc"},"namespace":{"type":"string","description":" Identifies the workspace where the service instance is deployed\n\nExample: ` \"staging\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"staging"},"service":{"type":"string","description":" Identifies the source or destination service\n\nExample: ` \"`N:public` or `S:productpage`\"`","title":"Service","x-displayname":"Service","x-ves-example":"`N:public` or `S:productpage`"},"site":{"type":"string","description":" Identifies the site, where the service instance is deployed\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"},"virtual_host":{"type":"string","description":" Identifier for the virtual host\n\nExample: ` \"productpage\"`","title":"Virtual Host","x-displayname":"Virtual Host","x-ves-example":"productpage"}}},"instanceInstanceIdField":{"type":"string","description":"InstanceId Field is used to select one or more fields that uniquely identifies\nan instance or a set of instances.\n\nIndicates the field not being set\nIdentifies the workspace where the service is deployed\nIdentifies the source or destination site\nIdentifies the application type associated with the virtual host\nIdentifies the source or destination service.\nFor north-south traffic, source service is a network name (indicated by prefix \"N:\") and\nvirtual-service (indicated by prefix \"S:\") for east-west traffic; destination service is\nalways virtual-service.\nIdentifier for the instance.\nIdentifies the virtual host.","title":"InstanceId Field","enum":["NONE","NAMESPACE","SITE","APP_TYPE","SERVICE","INSTANCE","VIRTUAL_HOST"],"default":"NONE","x-displayname":"InstanceId Field","x-ves-proto-enum":"ves.io.schema.graph.service.instance.InstanceIdField"},"instanceInstanceRequestId":{"type":"object","description":"Instance request ID to fetch metric from a specific service instance.","title":"Instance Request ID","x-displayname":"Instance Request ID","x-ves-proto-message":"ves.io.schema.graph.service.instance.InstanceRequestId","properties":{"app_type":{"type":"string","description":" Application type associated with the service instance\n\nExample: ` \"myapp\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"App Type","x-displayname":"App Type","x-ves-example":"myapp","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"instance":{"type":"string","description":" Name of the service instance\n\nExample: ` \"productpage-abc\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Instance","x-displayname":"Instance","x-ves-example":"productpage-abc","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"service":{"type":"string","description":" Network name or name of the virtual service\n\nExample: ` \"S:productpage\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service","x-displayname":"Service","x-ves-example":"S:productpage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"site":{"type":"string","description":" Site name where the service instance is running.\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"},"virtual_host":{"type":"string","description":" virtual host associated with the service instance\n\nExample: ` \"productpage\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host","x-displayname":"Virtual Host","x-ves-example":"productpage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"schemagraphMetricType":{"type":"string","description":"List of metric types that are supported for application site and service graph\n\nIndicates field not being set\nx-unit: \"per second\"\nNumber of requests per second\nDeprecated by HTTP_REQUEST_RATE, TCP_CONNECTION_RATE\nx-unit: \"per second\"\nNumber of errors per second\nDeprecated by HTTP_ERROR_RATE, TCP_ERROR_RATE\nx-unit: \"seconds\"\nAverage latency per request\nDeprecated by HTTP_RESPONSE_LATENCY and TCP_CONNECTION_DURATION\nx-unit: \"bits per second (bps)\"\nRequest Throughput\nx-unit: \"bits per second (bps)\"\nResponse Throughput\nx-unit: \"per second\"\nNumber of errors with response code 3XX\nDeprecated\nx-unit: \"per second\"\nNumber of errors with response code 4XX\nDeprecated by HTTP_ERROR_RATE_4XX\nx-unit: \"per second\"\nNumber of errors with response code 5XX\nDeprecated by HTTP_ERROR_RATE_5XX\nx-unit: \"seconds\"\nMax time taken to complete 50% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_50\nx-unit: \"seconds\"\nMax time taken to complete 90% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_90\nx-unit: \"seconds\"\nMax time taken to complete 99% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_99\nDeprecated\nx-unit: \"seconds\"\nAverage Round Trip Time for the client\nx-unit: \"seconds\"\nAverage Round Trip Time for the server\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nDeprecated by HTTP_SERVER_DATA_TRANSFER_TIME\nx-unit: \"seconds\"\nAverage time taken by the application to service the request\nDeprecated by HTTP_APP_LATENCY\nx-unit: \"per second\"\nNumber of requests to origin (good requests) per second\nx-unit: \"requests per second\"\nNumber of HTTP requests per second\nx-unit: \"errors per second\"\nNumber of HTTP errors per second\nx-unit: \"errors per second\"\nNumber of HTTP client errors per second\nx-unit: \"errors per second\"\nNumber of HTTP server errors per second\nx-unit: \"seconds\"\nAverage latency per HTTP request\nx-unit: \"seconds\"\nMax time taken to complete 50% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 90% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 99% of the HTTP requests\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nx-unit: \"seconds\"\nAverage time taken by the application to service the HTTP request\nx-unit: \"connections per second\"\nNumber of TCP connections per second\nx-unit: \"errors per second\"\nNumber of TCP connection errors per second\nx-unit: \"errors per second\"\nNumber of TCP client errors per second\nx-unit: \"errors per second\"\nNumber of TCP server/upstream errors per second\nx-unit: \"seconds\"\nAverage connection duration","title":"Metric Type","enum":["METRIC_TYPE_NONE","REQUEST_RATE","ERROR_RATE","RESPONSE_LATENCY","REQUEST_THROUGHPUT","RESPONSE_THROUGHPUT","ERROR_RATE_3XX","ERROR_RATE_4XX","ERROR_RATE_5XX","RESPONSE_LATENCY_PERCENTILE_50","RESPONSE_LATENCY_PERCENTILE_90","RESPONSE_LATENCY_PERCENTILE_99","RESPONSE_DATA_TRANSFER_DURATION","CLIENT_RTT","SERVER_RTT","SERVER_DATA_TRANSFER_TIME","APP_LATENCY","REQUEST_TO_ORIGIN_RATE","HTTP_REQUEST_RATE","HTTP_ERROR_RATE","HTTP_ERROR_RATE_4XX","HTTP_ERROR_RATE_5XX","HTTP_RESPONSE_LATENCY","HTTP_RESPONSE_LATENCY_PERCENTILE_50","HTTP_RESPONSE_LATENCY_PERCENTILE_90","HTTP_RESPONSE_LATENCY_PERCENTILE_99","HTTP_SERVER_DATA_TRANSFER_TIME","HTTP_APP_LATENCY","TCP_CONNECTION_RATE","TCP_ERROR_RATE","TCP_ERROR_RATE_CLIENT","TCP_ERROR_RATE_UPSTREAM","TCP_CONNECTION_DURATION"],"default":"METRIC_TYPE_NONE","x-displayname":"Metric Type","x-ves-proto-enum":"ves.io.schema.graph.MetricType"},"schemagraphMetricValue":{"type":"object","description":"Each metric value consists of a timestamp and a value.\nTimestamp in the Metric Value is based on the start_time, end_time and step in the request.\nValid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ... tn=tn-1+step, where tn <= end_time.\nResponse may not contain values for all timestamps between start_time and end_time.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.graph.MetricValue","properties":{"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":" Metric value\n\nExample: ` \"10.6\"`","title":"Value","x-displayname":"Value","x-ves-example":"10.6"}}},"serviceAppTypeInfo":{"type":"object","description":"List of application types for a namespace","title":"AppTypeInfo","x-displayname":"Application Type Information","x-ves-proto-message":"ves.io.schema.graph.service.AppTypeInfo","properties":{"app_types":{"type":"array","description":" List of app types running in the given namespace\n\nExample: ` \"value\"`","title":"App Types","items":{"type":"string"},"x-displayname":"App Types","x-ves-example":"value"},"namespace":{"type":"string","description":" workspace where the applications are deployed\n\nExample: ` \"ns1\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"serviceAppTypeListResponse":{"type":"object","description":"Response for graph/service/app_types API that returns the list of app_types scoped by\nnamespace in the request. For system namespace, the response will contain the list of app types\nfor all namespaces.","title":"AppTypeListResponse","x-displayname":"App Type List Response","x-ves-proto-message":"ves.io.schema.graph.service.AppTypeListResponse","properties":{"data":{"type":"array","description":" App Type data for a given namespace.","title":"Data","items":{"$ref":"#/components/schemas/serviceAppTypeInfo"},"x-displayname":"Data"}}},"serviceCacheableData":{"type":"object","description":"Cacheable Content Data wraps all the response data for a load balancer","title":"Cacheable Content Data","x-displayname":"Cacheable Content Data","x-ves-proto-message":"ves.io.schema.graph.service.CacheableData","properties":{"id":{"$ref":"#/components/schemas/serviceId"},"metric":{"type":"array","description":" List of metric specified in the request for a load balancer","title":"Metric","items":{"$ref":"#/components/schemas/serviceCdnMetricData"},"x-displayname":"Metric"}}},"serviceCdnMetricData":{"type":"object","description":"CdnMetricData contains the metric type and the corresponding metric value(s)","title":"CDN Metric Data","x-displayname":"CDN Metric Data","x-ves-proto-message":"ves.io.schema.graph.service.CdnMetricData","properties":{"type":{"$ref":"#/components/schemas/schemagraphMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"},"value":{"type":"array","description":" Cacheability value","title":"Value","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Value"}}},"serviceEdgeAPIEPData":{"type":"object","description":"Details about the discovered API Endpoints between services.\nEach discovered Endpoint has a collapsed URL and the associated method.\nProbablity Density Function of request size, response size and latency\nper API Endpoint is also returned.","title":"Edge API Endpoint","x-displayname":"Edge API Endpoint","x-ves-proto-message":"ves.io.schema.graph.service.EdgeAPIEPData","properties":{"api_ep":{"$ref":"#/components/schemas/app_typeAPIEPInfo"},"pdf_info":{"$ref":"#/components/schemas/app_typeAPIEPPDFInfo"}}},"serviceEdgeAPIEPSelector":{"type":"object","description":"Selector for API Endpoints","title":"Edge APIEP Selector","x-displayname":"Edge APIEP Selector","x-ves-proto-message":"ves.io.schema.graph.service.EdgeAPIEPSelector"},"serviceEdgeData":{"type":"object","description":"EdgeData wraps all the response data for an edge in the site graph response.","title":"Edge Data","x-displayname":"Edge Data","x-ves-proto-message":"ves.io.schema.graph.service.EdgeData","properties":{"data":{"$ref":"#/components/schemas/serviceEdgeFieldData"},"dst_id":{"$ref":"#/components/schemas/serviceId"},"src_id":{"$ref":"#/components/schemas/serviceId"}}},"serviceEdgeFieldData":{"type":"object","description":"EdgeFieldData wraps all the metric and the healthscore data for an edge.","title":"Edge Field data","x-displayname":"Edge Field Data","x-ves-proto-message":"ves.io.schema.graph.service.EdgeFieldData","properties":{"api_endpoints":{"type":"array","description":" Discovered API Endpoints between two services","title":"API Endpoints","items":{"$ref":"#/components/schemas/serviceEdgeAPIEPData"},"x-displayname":"API Endpoints"},"healthscore":{"$ref":"#/components/schemas/graphHealthscoreData"},"metric":{"$ref":"#/components/schemas/graphEdgeMetricData"}}},"serviceEdgeFieldSelector":{"type":"object","description":"EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.","title":"Edge Field Selector","x-displayname":"Edge Field Selector","x-ves-proto-message":"ves.io.schema.graph.service.EdgeFieldSelector","properties":{"api_endpoint":{"$ref":"#/components/schemas/serviceEdgeAPIEPSelector"},"healthscore":{"$ref":"#/components/schemas/graphHealthscoreSelector"},"metric":{"$ref":"#/components/schemas/graphEdgeMetricSelector"}}},"serviceEdgeRequest":{"type":"object","description":"While graph/service API is used to get the service mesh for an app_type,\nwhere each node and edge contains the aggregated value for each field;\ngraph/service/edge API is used to get the time-series data (drill-down of aggregated data)\nfor each field.","title":"Service Edge Request","x-displayname":"Service Edge  Request","x-ves-proto-message":"ves.io.schema.graph.service.EdgeRequest","properties":{"dst_id":{"$ref":"#/components/schemas/serviceServiceRequestId"},"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/serviceEdgeFieldSelector"},"namespace":{"type":"string","description":" namespace is used to scope the application traffic to a given namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"src_id":{"$ref":"#/components/schemas/serviceServiceRequestId"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceEdgeResponse":{"type":"object","description":"Response for graph/service/edge API returns the time-series data for the service edge\nspecified in the request.","title":"Service Edge Response","x-displayname":"Service Edge Response","x-ves-proto-message":"ves.io.schema.graph.service.EdgeResponse","properties":{"data":{"$ref":"#/components/schemas/serviceEdgeFieldData"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceFieldSelector":{"type":"object","description":"FieldSelector is used to specify the list of fields to be returned in the response for site graph.","title":"Field Selector","x-displayname":"Field Selector","x-ves-proto-message":"ves.io.schema.graph.service.FieldSelector","properties":{"edge":{"$ref":"#/components/schemas/serviceEdgeFieldSelector"},"node":{"$ref":"#/components/schemas/serviceNodeFieldSelector"}}},"serviceGraphData":{"type":"object","description":"GraphData wraps the response for the service graph request that contains\nall the nodes and the edges. Each node contains the application traffic\nflowing from/to service and each edge contains the application traffic flowing\nfrom/to the source service and the destination service.","title":"Graph Data","x-displayname":"Graph Data","x-ves-proto-message":"ves.io.schema.graph.service.GraphData","properties":{"edges":{"type":"array","description":" List of edges in the service graph. Each edge contains the application traffic\n flowing from/to the source service and the destination service.","title":"Edges","items":{"$ref":"#/components/schemas/serviceEdgeData"},"x-displayname":"Edges"},"nodes":{"type":"array","description":" List of nodes in the service graph. Each node contains the application traffic\n flowing from/to the service.","title":"Nodes","items":{"$ref":"#/components/schemas/serviceNodeData"},"x-displayname":"Nodes"}}},"serviceId":{"type":"object","description":"Id uniquely identifies a node or an edge in the service graph.","title":"Id","x-displayname":"Id","x-ves-proto-message":"ves.io.schema.graph.service.Id","properties":{"app_type":{"type":"string","description":" Identifies the application type associated with the virtual host\n\nExample: ` \"myapp\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"myapp"},"cacheability":{"type":"string","description":" Identifies the Cacheability associated with the Virtual Host\n\nExample: ` \"Cacheability\"`","title":"CACHEABILITY","x-displayname":"CACHEABILITY","x-ves-example":"Cacheability"},"namespace":{"type":"string","description":" Identifies the workspace where the service is deployed\n\nExample: ` \"staging\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"staging"},"service":{"type":"string","description":" Identifies the source or destination service\n\nExample: ` \"N:public or S:productpage\"`","title":"Service","x-displayname":"Service","x-ves-example":"N:public or S:productpage"},"site":{"type":"string","description":" Identifies the source or destination site\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"},"vhost":{"type":"string","description":" Identifies the virtual host\n\nExample: ` \"productpage\"`","title":"Virtual Host","x-displayname":"Virtual Host","x-ves-example":"productpage"},"vip":{"type":"string","description":" Identifies the VIP associated with the Virtual Host\n\nExample: ` \"192.168.1.1\"`","title":"VIP","x-displayname":"VIP","x-ves-example":"192.168.1.1"},"virtual_host_type":{"type":"string","description":" Identifies the Virtual host type\n\nExample: ` \"HTTP_LOAD_BALANCER\"`","title":"Virtual Host Type","x-displayname":"Virtual Host Type","x-ves-example":"HTTP_LOAD_BALANCER"}}},"serviceIdField":{"type":"string","description":"IdField is used to select one or more fields that uniquely identifies\na node or an edge in the service graph.\n\nIndicates the field not being set\nIdentifies the workspace where the service is deployed\nIdentifies the source or destination site\nIdentifies the application type associated with the virtual host\nIdentifies the source or destination service.\nFor north-south traffic, source service is a network name (indicated by prefix \"N:\") and\nvirtual-service (indicated by prefix \"S:\") for east-west traffic; destination service is\nalways virtual-service.\nIdentifies the virtual host.\nIdentifies the virtual host type.\nIdentifies the VIP associated with the Virtual Host.\nIdentifies the Cacheability associated with the Virtual Host.","title":"Id Field","enum":["NONE","NAMESPACE","SITE","APP_TYPE","SERVICE","VHOST","VIRTUAL_HOST_TYPE","VIP","CACHEABILITY"],"default":"NONE","x-displayname":"Id Field","x-ves-proto-enum":"ves.io.schema.graph.service.IdField"},"serviceInstanceData":{"type":"object","description":"InstanceData wraps all the response data for an instance in the graph response","title":"Instance Data","x-displayname":"Instance Data","x-ves-proto-message":"ves.io.schema.graph.service.InstanceData","properties":{"data":{"$ref":"#/components/schemas/serviceNodeFieldData"},"id":{"$ref":"#/components/schemas/instanceInstanceId"}}},"serviceInstanceRequest":{"type":"object","description":"Request to get the time-series data for an instance in the service node.","title":"Service Instance Request","x-displayname":"Service Instance Request","x-ves-proto-message":"ves.io.schema.graph.service.InstanceRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/serviceNodeFieldSelector"},"id":{"$ref":"#/components/schemas/instanceInstanceRequestId"},"namespace":{"type":"string","description":" namespace is used to scope application traffic to a given namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceInstanceResponse":{"type":"object","description":"Response for graph/service/node/instance API that returns the time-series data for a\nservice instance specified in the request.","title":"Service Instance Response","x-displayname":"Service Instance Response","x-ves-proto-message":"ves.io.schema.graph.service.InstanceResponse","properties":{"data":{"$ref":"#/components/schemas/serviceNodeFieldData"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceInstancesData":{"type":"object","description":"List of service instances that matched the request","title":"Instances Data","x-displayname":"Instances Data","x-ves-proto-message":"ves.io.schema.graph.service.InstancesData","properties":{"instances":{"type":"array","description":" List of service instances","title":"Instances","items":{"$ref":"#/components/schemas/serviceInstanceData"},"x-displayname":"Instances"}}},"serviceInstancesRequest":{"type":"object","description":"Request to get instances data for a node in the service graph.","title":"Service Instances Request","x-displayname":"Service Instances Request","x-ves-proto-message":"ves.io.schema.graph.service.InstancesRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/serviceNodeFieldSelector"},"group_by":{"type":"array","description":" Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST\n\n Optional: If not specified, then the data is aggregated/grouped by all fields.","title":"Group by","items":{"$ref":"#/components/schemas/instanceInstanceIdField"},"x-displayname":"Group By"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label key\" QueryOp \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n\n Optional: To get the instances for an (app_type, service), user should specify LABEL_APP_TYPE and\n           LABEL_SERVICE in the label_filter.","title":"Label Filter","items":{"$ref":"#/components/schemas/serviceLabelFilter"},"x-displayname":"Label Filter"},"namespace":{"type":"string","description":" namespace is used to scope application traffic to a given namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceInstancesResponse":{"type":"object","description":"Response for graph/service/node/instances API that returns the instances data\nfor a node in the service graph.","title":"Service Instances Response","x-displayname":"Service Instances Response","x-ves-proto-message":"ves.io.schema.graph.service.InstancesResponse","properties":{"data":{"$ref":"#/components/schemas/serviceInstancesData"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceLBCacheContentRequest":{"type":"object","description":"graph/cacheable_content API is used to get data for CDN services.","title":"Cacheable Content Request","x-displayname":"Cacheable Content Request","x-ves-proto-message":"ves.io.schema.graph.service.LBCacheContentRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"type":"array","description":" Select fields to be returned in the response. \n Optional: If not specified, only the following fields are returned in the response.\n REQUEST_RATE,  RESPONSE_THROUGHPUT.\n\nValidation Rules:\n  ves.io.schema.rules.enum.in: [1,5]\n","title":"Field Selector","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Field Selector","x-ves-validation-rules":{"ves.io.schema.rules.enum.in":"[1,5]"}},"group_by":{"type":"array","description":" Aggregate data by any or all of namespace, cacheability, vhost.\n\n Optional: If not specified, then the data is aggregated/grouped by vh_name.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 4\n  ves.io.schema.rules.repeated.unique: true\n","title":"Group by","maxItems":4,"items":{"$ref":"#/components/schemas/serviceIdField"},"x-displayname":"Group By","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"4","ves.io.schema.rules.repeated.unique":"true"}},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label key\" QueryOp \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n For cacheable content, user should specify LABEL_VHOST_CACHE & LABEL_VHOST in the label_filter\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Label Filter","minItems":1,"maxItems":16,"items":{"$ref":"#/components/schemas/serviceLabelFilter"},"x-displayname":"Label Filter","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"namespace":{"type":"string","description":" namespace is used to scope load balancers. Only LB's in given namespace will be considered.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceLBCacheContentResponse":{"type":"object","description":"Response for graph/cacheable_content request contains a list of nodes","title":"Cacheable Content Response","x-displayname":"Cacheable Content Response","x-ves-proto-message":"ves.io.schema.graph.service.LBCacheContentResponse","properties":{"nodes":{"type":"array","description":" List of LB's in requested for Cacheable Content Data","title":"Nodes","items":{"$ref":"#/components/schemas/serviceCacheableData"},"x-displayname":"Nodes"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceLabelFilter":{"type":"object","description":"Metrics used to render the service graph are tagged with labels listed in the enum Label.\nLabel Filter is used to filter the timeseries that match the specified label key/value\nand the operator.","title":"Label Filter","x-displayname":"Label Filter","x-ves-proto-message":"ves.io.schema.graph.service.LabelFilter","properties":{"label":{"$ref":"#/components/schemas/graphserviceLabel"},"op":{"$ref":"#/components/schemas/graphQueryOp"},"value":{"type":"string","description":" Value of the label\n\nExample: ` \"ce01\"`","title":"Value","x-displayname":"Value","x-ves-example":"ce01"}}},"serviceNodeData":{"type":"object","description":"NodeData wraps all the response data for a node in the site graph response.","title":"Node Data","x-displayname":"Node Data","x-ves-proto-message":"ves.io.schema.graph.service.NodeData","properties":{"data":{"$ref":"#/components/schemas/serviceNodeFieldData"},"id":{"$ref":"#/components/schemas/serviceId"}}},"serviceNodeFieldData":{"type":"object","description":"NodeFieldData wraps all the metric and the healthscore data for a node.","title":"Node Field data","x-displayname":"Node Field Data","x-ves-proto-message":"ves.io.schema.graph.service.NodeFieldData","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreData"},"metric":{"$ref":"#/components/schemas/graphNodeMetricData"}}},"serviceNodeFieldSelector":{"type":"object","description":"NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.","title":"Node Field Selector","x-displayname":"Node Field Selector","x-ves-proto-message":"ves.io.schema.graph.service.NodeFieldSelector","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreSelector"},"metric":{"$ref":"#/components/schemas/graphNodeMetricSelector"}}},"serviceNodeRequest":{"type":"object","description":"Request to get time-series data for a node in the service graph.\nWhile graph/service API is used to get the service mesh for an app_type,\nwhere each node and edge contains the aggregated value for each field;\ngraph/service/node API is used to get the time-series data (drill-down of aggregated data)\nfor each field.","title":"Service Node Request","x-displayname":"Service Node Request","x-ves-proto-message":"ves.io.schema.graph.service.NodeRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/serviceNodeFieldSelector"},"id":{"$ref":"#/components/schemas/serviceServiceRequestId"},"namespace":{"type":"string","description":" namespace is used to scope the application traffic to a given namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceNodeResponse":{"type":"object","description":"Response for graph/service/node request returns the time-series data for the service node\nspecified in the request.","title":"Service Node Response","x-displayname":"Service Node Response","x-ves-proto-message":"ves.io.schema.graph.service.NodeResponse","properties":{"data":{"$ref":"#/components/schemas/serviceNodeFieldData"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceRequest":{"type":"object","description":"graph/service API is used to get service mesh graph of related services.","title":"Service Graph Request","x-displayname":"Service Graph Request","x-ves-proto-message":"ves.io.schema.graph.service.Request","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/serviceFieldSelector"},"group_by":{"type":"array","description":" Aggregate data by any or all of namespace, site, service, app_type and vhost.\n\n Optional: If not specified, then the data is aggregated/grouped by namespace and service.","title":"Group by","items":{"$ref":"#/components/schemas/serviceIdField"},"x-displayname":"Group By"},"is_trend_request":{"type":"boolean","description":" Trend value computation requested by the user\n Optional: default is false\n\nExample: ` \"true\"`","format":"boolean","x-displayname":"Trend calculation requested by the user","x-ves-example":"true"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label key\" QueryOp \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n\n Optional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid\n           aggregation across all app_types for the given namespace.","title":"Label Filter","items":{"$ref":"#/components/schemas/serviceLabelFilter"},"x-displayname":"Label Filter"},"namespace":{"type":"string","description":" namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"serviceResponse":{"type":"object","description":"Response for graph/service request contains a list of nodes and edges.\nEach node represents unique combination of fields specified in group_by in the Request.\nEach node respresents a service, if the group_by field in the Request is empty.\nEach edge represents access between the nodes.","title":"Service Graph Response","x-displayname":"Service Graph Response","x-ves-proto-message":"ves.io.schema.graph.service.Response","properties":{"data":{"$ref":"#/components/schemas/serviceGraphData"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"serviceServiceRequestId":{"type":"object","description":"Service request ID to fetch metric for a specific service.","title":"Service Request ID","x-displayname":"Service Request ID","x-ves-proto-message":"ves.io.schema.graph.service.ServiceRequestId","properties":{"app_type":{"type":"string","description":" Application type associated with the service\n\nExample: ` \"myapp\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"myapp"},"service":{"type":"string","description":" Network name or name of the virtual service\n\nExample: ` \"S:productpage\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Service","x-displayname":"Service","x-ves-example":"S:productpage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"site":{"type":"string","description":" Site name where the service is running. If the service is deployed\n in multiple sites, only the metric from this site will be returned\n in the response.\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"},"vip":{"type":"string","description":" VIP associated with the Virtual Host\n\nExample: ` \"192.160.1.1\"`","title":"VIP","x-displayname":"VIP","x-ves-example":"192.160.1.1"},"virtual_host":{"type":"string","description":" virtual host associated with the service\n\nExample: ` \"productpage\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host","x-displayname":"Virtual Host","x-ves-example":"productpage","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"timeseriesTimeseriesFeature":{"type":"string","description":"Various Timeseries Features that can be enabled\n\nDo not enable any feature\nEnable calculating confidence interval, upper and lower bound time series where metric is expected to vary.\ndetect anomalies and generate alarm when metric goes out of confidence interval\ndetect trend of the metric\nIndicate a score between 0 to 100 which indicates if the metric is healthy","title":"Timeseries","enum":["TIMESERIES_FEATURE_NONE","CONFIDENCE_INTERVAL","ANOMALY_DETECTION","TREND","HEALTHSCORE"],"default":"TIMESERIES_FEATURE_NONE","x-displayname":"Timeseries","x-ves-proto-enum":"ves.io.schema.timeseries.TimeseriesFeature"}}}}