@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.app_type","description":"App Type object defines a application profile type from an advanced monitoring/security point of view.\nAn App type is a set of (micro) services that interact with one another and function as an application.\nServices can be made members of a particular AppType set by adding label ves.io/app_type=app_type.metadata.name to services.\nApp type object is the profile for one such application label. One can define various AI/ML features that can\nbe enabled for a given application in this object. All services in a given namespace that are labeled with\nsame ves.io/app_type label are assumed to be a single application. In a different namespace as two different\ninstances of same application.\napp_type object is recommended per tenant and present only in shared namespace.\nThis way AI/ML modeled developed for a given application can be shared across namespaces or deployments.\napp_setting object can be used to enable a app_type monitoring profile in a given namespace.","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/app_types":{"post":{"summary":"Create App Type","description":"Create App type will create the configuration in namespace metadata.namespace","operationId":"ves.io.schema.app_type.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-api-create"},"x-ves-proto-rpc":"ves.io.schema.app_type.API.Create"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/app_types/{metadata.name}":{"put":{"summary":"Replace App Type","description":"Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.","operationId":"ves.io.schema.app_type.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-api-replace"},"x-ves-proto-rpc":"ves.io.schema.app_type.API.Replace"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/app_types":{"get":{"summary":"List App Type","description":"List the set of app_type in a namespace","operationId":"ves.io.schema.app_type.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of app_type","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-api-list"},"x-ves-proto-rpc":"ves.io.schema.app_type.API.List"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/learnt_schema":{"post":{"summary":"Get Learnt Schema per API endpoint","description":"Get Learnt Schema per API endpoint for a given auto discovered API endpoint for Service","operationId":"ves.io.schema.app_type.CustomAPI.GetAPIEndpointLearntSchema","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointLearntSchemaRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointLearntSchemaReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-getapiendpointlearntschema"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.GetAPIEndpointLearntSchema"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/pdf":{"get":{"summary":"Get PDF","description":"Get PDF of all metrics for a given auto discovered API endpoint for App type","operationId":"ves.io.schema.app_type.CustomAPI.APIEndpointPDF","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointPDFRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}},{"name":"collapsed_url","description":"x-example: \"value\"\nAPI endpoint for which PDFs are requested.","in":"query","required":false,"x-displayname":"API URL","schema":{"type":"string"}},{"name":"method","description":"x-example: \"value\"\nmethod of API endpoint for which PDFs are requested.","in":"query","required":false,"x-displayname":"Method","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-apiendpointpdf"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.APIEndpointPDF"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints":{"get":{"summary":"Get API endpoints","description":"Get all auto discovered API endpoints for App type","operationId":"ves.io.schema.app_type.CustomAPI.APIEndpoints","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointsRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}},{"name":"api_endpoint_info_request","description":"List of additional things that needs to be sent as part of the request\n\nAPI ENDPOINT INFO NONE option is used to disable any additional info request per api endpoint response\nAPI ENDPOINT INFO PDF SPARKLINES option is used to enable pdf sparkline info along with the api endpoint response","in":"query","required":false,"x-displayname":"API Endpoint Info PDF Sparklines","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["API_ENDPOINT_INFO_NONE","API_ENDPOINT_INFO_PDF_SPARKLINES"]}}}],"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.APIEndpoints"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints/swagger_spec":{"get":{"summary":"Get Swagger Spec for App Type","description":"Get the corresponding Swagger spec for the given app type","operationId":"ves.io.schema.app_type.CustomAPI.GetSwaggerSpec","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiHttpBody"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-getswaggerspec"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.GetSwaggerSpec"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/pop":{"post":{"summary":"Remove Override","description":"remove override for dynamic component for API endpoints discovered for this App type","operationId":"ves.io.schema.app_type.CustomAPI.OverridePop","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeOverridePopRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeOverridePopReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-overridepop"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.OverridePop"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/push":{"post":{"summary":"Add Override","description":"Add override for dynamic component for API endpoints discovered for this App type","operationId":"ves.io.schema.app_type.CustomAPI.OverridePush","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeOverridePushRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeOverridePushReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-overridepush"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.OverridePush"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/overrides":{"get":{"summary":"Get Override","description":"Get all override for API endpoints configured for this App type","operationId":"ves.io.schema.app_type.CustomAPI.Overrides","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeOverridesRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-overrides"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.Overrides"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoint/pdf":{"post":{"summary":"Get Service API Endpoint PDF","description":"Get PDF of all metrics for a given auto discovered API endpoint for Service","operationId":"ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpointPDF","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointPDFRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}},{"name":"service_name","description":"Service\n\nx-example: \"N:public or S:productpage\"\nIdentifies the destination service","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeServiceAPIEndpointPDFReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-getserviceapiendpointpdf"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpointPDF"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoints":{"post":{"summary":"Get Service API Endpoints","description":"Get all autodiscovered API endpoints for Service","operationId":"ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpoints","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeAPIEndpointsRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"app_type_name","description":"App Type\n\nx-example: \"blogging-app\"\nApp Type for current request","in":"path","required":true,"x-displayname":"App Type","schema":{"type":"string"}},{"name":"service_name","description":"Service\n\nx-example: \"N:public or S:productpage\"\nIdentifies the destination service","in":"path","required":true,"x-displayname":"Service Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeServiceAPIEndpointsReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-customapi-getserviceapiendpoints"},"x-ves-proto-rpc":"ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpoints"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/app_types/{name}":{"get":{"summary":"Get App Type","description":"Get App type will read the configuration from namespace metadata.namespace","operationId":"ves.io.schema.app_type.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-api-get"},"x-ves-proto-rpc":"ves.io.schema.app_type.API.Get"},"delete":{"summary":"Delete App Type","description":"Delete the specified app_type","operationId":"ves.io.schema.app_type.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app_typeDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-app_type-api-delete"},"x-ves-proto-rpc":"ves.io.schema.app_type.API.Delete"},"x-displayname":"App Type","x-ves-proto-service":"ves.io.schema.app_type.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"App Type","x-ves-proto-package":"ves.io.schema.app_type","components":{"schemas":{"apiHttpBody":{"type":"object","description":"Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n    message GetResourceRequest {\n      // A unique request id.\n      string request_id = 1;\n\n      // The raw HTTP body is bound to this field.\n      google.api.HttpBody http_body = 2;\n    }\n\n    service ResourceService {\n      rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n      rpc UpdateResource(google.api.HttpBody) returns\n      (google.protobuf.Empty);\n    }\n\nExample with streaming methods:\n\n    service CaldavService {\n      rpc GetCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n      rpc UpdateCalendar(stream google.api.HttpBody)\n        returns (stream google.api.HttpBody);\n    }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.","properties":{"content_type":{"type":"string","description":"The HTTP Content-Type header value specifying the content type of the body."},"data":{"type":"string","description":"The HTTP request/response body as raw binary.","format":"byte"},"extensions":{"type":"array","description":"Application specific response metadata. Must be set in the first response\nfor streaming APIs.","items":{"$ref":"#/components/schemas/protobufAny"}}}},"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_typeAPIEndpoint":{"type":"object","description":"x-required\nx-displayName: \"API Endpoint\"\nThe rule is applied only for the specified api endpoints.","title":"api endpoint","properties":{"api_endpoint_path":{"type":"string","description":"x-required\nx-example: \"/endpoint1\"\nx-displayName: \"API Endpoint\"\nThe rule is applied only for the specified api endpoints.","title":"api endpoint path"},"methods":{"type":"array","description":"x-displayName: \"Methods\"\nList of methods values to match against.\nx-required\nx-example: \"['GET', 'POST', 'DELETE']\"","title":"methods","items":{"$ref":"#/components/schemas/schemaHttpMethod"}}}},"app_typeAPIEndpointLearntSchemaReq":{"type":"object","description":"shape of request to get learnt schema request for a given API endpoint.","title":"API endpoint Learnt Schema request","x-displayname":"Learnt Schema Request","x-ves-proto-message":"ves.io.schema.app_type.APIEndpointLearntSchemaReq","properties":{"api_endpoint_info_request":{"type":"array","description":" List of additional things that needs to be sent as part of the request\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Api Endpoint Info Request","items":{"$ref":"#/components/schemas/app_typeApiEndpointInfoRequest"},"x-displayname":"Api Endpoint Info Request","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"app_type_name":{"type":"string","description":" App Type for current request\n\nExample: ` \"blogging-app\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"blogging-app"},"collapsed_url":{"type":"string","description":" API endpoint for which PDFs are requested.\n\nExample: ` \"value\"`","title":"Discovered API URL","x-displayname":"API URL","x-ves-example":"value"},"method":{"type":"string","description":" method of API endpoint for which PDFs are requested.\n\nExample: ` \"value\"`","title":"Method of current API URL","x-displayname":"Method","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"}}},"app_typeAPIEndpointLearntSchemaRsp":{"type":"object","description":"shape of response to get req body schema for a given API endpoint.","title":"API endpoint Req Body Schema response","x-displayname":"Req Body Schema Response","x-ves-proto-message":"ves.io.schema.app_type.APIEndpointLearntSchemaRsp","properties":{"api_specs":{"type":"object","description":" Discovered API Specifications based on API type for eg, OpenAPI or GraphQL schema for API endpoint.","title":"API Specifications","x-displayname":"API Specifications"},"discovered_schema":{"$ref":"#/components/schemas/app_typeDiscoveredSchema"},"inventory_openapi_spec":{"type":"string","description":" Inventory OpenAPI spec for request API endpoint.\n\nExample: ` \"{\\\"info\\\":{\\\"description\\\":\\\"\\\",\\\"title\\\":\\\"\\\",\\\"version\\\":\\\"\\\"},\\\"paths\\\":{\\\"\\/api\\/Addresss\\\":{\\\"get\\\":{\\\"consumes\\\":[\\\"application\\/json\\\"],\\\"description\\\":\\\"Swagger auto-generated from learnt schema\\\",\\\"parameters\\\":[{\\\"description\\\":\\\"\\\",\\\"in\\\":\\\"query\\\",\\\"name\\\":\\\"test\\\",\\\"type\\\":\\\"string\\\"},{\\\"description\\\":\\\"\\\",\\\"in\\\":\\\"query\\\",\\\"name\\\":\\\"test1\\\",\\\"type\\\":\\\"string\\\"}],\\\"responses\\\":{\\\"200\\\":{\\\"description\\\":\\\"\\\"}}}}},\\\"schemes\\\":[\\\"https\\\",\\\"http\\\"],\\\"swagger\\\":\\\"2.0\\\"}\"`","title":"Inventory OpenAPI Spec","x-displayname":"Inventory OpenAPI Spec","x-ves-example":"{\\\"info\\\":{\\\"description\\\":\\\"\\\",\\\"title\\\":\\\"\\\",\\\"version\\\":\\\"\\\"},\\\"paths\\\":{\\\"\\/api\\/Addresss\\\":{\\\"get\\\":{\\\"consumes\\\":[\\\"application\\/json\\\"],\\\"description\\\":\\\"Swagger auto-generated from learnt schema\\\",\\\"parameters\\\":[{\\\"description\\\":\\\"\\\",\\\"in\\\":\\\"query\\\",\\\"name\\\":\\\"test\\\",\\\"type\\\":\\\"string\\\"},{\\\"description\\\":\\\"\\\",\\\"in\\\":\\\"query\\\",\\\"name\\\":\\\"test1\\\",\\\"type\\\":\\\"string\\\"}],\\\"responses\\\":{\\\"200\\\":{\\\"description\\\":\\\"\\\"}}}}},\\\"schemes\\\":[\\\"https\\\",\\\"http\\\"],\\\"swagger\\\":\\\"2.0\\\"}"},"pdf_info":{"$ref":"#/components/schemas/app_typeAPIEPPDFInfo"},"sensitive_data":{"type":"array","description":" List of sensitive data for request API endpoint.","title":"List of sensitive data","items":{"$ref":"#/components/schemas/app_typeSensitiveData"},"x-displayname":"List of Sensitive Data"}}},"app_typeAPIEndpointPDFRsp":{"type":"object","description":"shape of response to get PDF for a given API endpoint.","title":"API endpoint PDF response","x-displayname":"PDF Response","x-ves-proto-message":"ves.io.schema.app_type.APIEndpointPDFRsp","properties":{"pdf_info":{"$ref":"#/components/schemas/app_typeAPIEPPDFInfo"}}},"app_typeAPIEndpointsRsp":{"type":"object","description":"Response shape for GET API endpoints API. It is list of API endpoints discovered","title":"API endpoints GET response","x-displayname":"API Endpoints Response","x-ves-proto-message":"ves.io.schema.app_type.APIEndpointsRsp","properties":{"apiep_list":{"type":"array","description":" list of API endpoints discovered","title":"API endpoints list","items":{"$ref":"#/components/schemas/app_typeAPIEPInfo"},"x-displayname":"API Endpoints"}}},"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_typeApiEndpointInfoRequest":{"type":"string","description":"This is the various forms that can be requested to be sent in the ApiEndpointInfoRequest\n\nAPI ENDPOINT INFO NONE option is used to disable any additional info request per api endpoint response\nAPI ENDPOINT INFO PDF SPARKLINES option is used to enable pdf sparkline info along with the api endpoint response","title":"ApiEndpointInfoRequest","enum":["API_ENDPOINT_INFO_NONE","API_ENDPOINT_INFO_PDF_SPARKLINES"],"default":"API_ENDPOINT_INFO_NONE","x-displayname":"API Endpoint Info Request","x-ves-proto-enum":"ves.io.schema.app_type.ApiEndpointInfoRequest"},"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_typeBuiltInSensitiveDataType":{"type":"object","description":"x-displayName: \"Built-In Sensitive Data Type\"\nx-example: \"[EMAIL, CC]\"\nMessage wrapper for built-in sensitive data type.","title":"BuiltInSensitiveDataType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"[EMAIL, CC]\"\nx-required\nBuilt-in rule for sensitive data detection.","title":"name"}}},"app_typeBusinessLogicMarkupSetting":{"type":"object","description":"Settings specifying how API Discovery will be performed","title":"API Discovery Settings","x-displayname":"API Discovery Settings","x-ves-displayorder":"3,5","x-ves-oneof-field-learn_from_redirect_traffic":"[\"disable\",\"enable\"]","x-ves-proto-message":"ves.io.schema.app_type.BusinessLogicMarkupSetting","properties":{"disable":{"$ref":"#/components/schemas/ioschemaEmpty"},"discovered_api_settings":{"$ref":"#/components/schemas/app_typeDiscoveredAPISettings"},"enable":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"app_typeCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of app_type","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.app_type.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/app_typeCreateSpecType"}}},"app_typeCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.app_type.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/app_typeGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"app_typeCreateSpecType":{"type":"object","description":"Create App type will create the configuration in namespace metadata.namespace","title":"Create App type","x-displayname":"Create App Type","x-ves-proto-message":"ves.io.schema.app_type.CreateSpecType","properties":{"business_logic_markup_setting":{"$ref":"#/components/schemas/app_typeBusinessLogicMarkupSetting"},"features":{"type":"array","description":" List of various AI/ML features enabled\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/app_typeFeature"},"x-displayname":"Features","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"app_typeCustomDataDetectionConfig":{"type":"object","description":"x-displayName: \"Custom Data Detection Config\"\nThe custom data detection config specifies targets, scopes & the pattern to be detected.","title":"CustomDataDetectionConfig","properties":{"all_request_sections":{"$ref":"#/components/schemas/ioschemaEmpty"},"all_response_sections":{"$ref":"#/components/schemas/ioschemaEmpty"},"all_sections":{"$ref":"#/components/schemas/ioschemaEmpty"},"any_domain":{"$ref":"#/components/schemas/ioschemaEmpty"},"any_target":{"$ref":"#/components/schemas/ioschemaEmpty"},"api_endpoint_target":{"$ref":"#/components/schemas/app_typeAPIEndpoint"},"api_group":{"type":"string","description":"x-displayName: \"API Group\"\nx-example: \"oas-all-operations\"\nThe rule is applied on the APIs that belong to specified api_group.\nAPI groups derived from API Definition swaggers.\nFor example oas-all-operations including all paths and methods from the swaggers, oas-base-urls covering all requests under base-paths from the swaggers.\nCustom groups can be created if user tags paths or operations with \"x-volterra-api-group\" extensions inside swaggers.","title":"api_group"},"base_path":{"type":"string","description":"x-example: \"/v1\"\nx-displayName: \"Base Path\"\nThe rule is applied only for the requests matching the specified base path.","title":"base path"},"custom_sections":{"$ref":"#/components/schemas/app_typeCustomSections"},"key_pattern":{"$ref":"#/components/schemas/app_typeKeyPattern"},"key_value_pattern":{"$ref":"#/components/schemas/app_typeKeyValuePattern"},"specific_domain":{"type":"string","description":"x-displayName: \"Specific Domain\"\nx-example: \"api.example.com\"\nThe rule will apply for a specific domain.\nFor example: api.example.com","title":"domain"},"value_pattern":{"$ref":"#/components/schemas/app_typeValuePattern"}}},"app_typeCustomSections":{"type":"object","description":"x-displayName: \"Custom Sections\"\nRequest & Response Sections.","title":"CustomSections","properties":{"custom_sections":{"type":"array","description":"x-displayName: \"Custom Sections\"\nx-required\nRequest & Response Sections.","title":"custom_sections","items":{"$ref":"#/components/schemas/schemaHttpSections"}}}},"app_typeCustomSensitiveDataDetectionRule":{"type":"object","description":"x-displayName: \"Custom Sensitive Data Detection Rule\"\nCustom Sensitive Data Rule Definition.","title":"CustomSensitiveDataRule","properties":{"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"sensitive_data_detection_config":{"$ref":"#/components/schemas/app_typeCustomDataDetectionConfig"},"sensitive_data_type":{"$ref":"#/components/schemas/app_typeCustomSensitiveDataType"}}},"app_typeCustomSensitiveDataType":{"type":"object","description":"x-displayName: \"Custom Sensitive Data Type\"\nThe type/category of the sensitive data this rule detects. e.g. Email, Credit Card etc.","title":"CustomSensitiveDataType","properties":{"type":{"type":"string","description":"x-required\nx-displayName: \"Type\"\nx-example: \"EMAIL\"\nThe request is labeled as specified sensitive data type.","title":"sensitive data type"}}},"app_typeDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a app_type","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.app_type.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"app_typeDiscoveredAPISettings":{"type":"object","description":"x-example: \"2\"\nConfigure Discovered API Settings.","title":"DiscoveredAPISettings","x-displayname":"Discovered API Settings","x-ves-proto-message":"ves.io.schema.app_type.DiscoveredAPISettings","properties":{"purge_duration_for_inactive_discovered_apis":{"type":"integer","description":" Inactive discovered API will be deleted after configured duration.\n\nExample: ` \"2\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 7\n","title":"purge_duration_for_inactive_discovered_apis","format":"int64","x-displayname":"Purge Duration for Inactive Discovered APIs from Traffic","x-ves-example":"2","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"7"}}}},"app_typeDiscoveredSchema":{"type":"object","description":"Discovery schema for request API endpoint.","title":"Discovery schema","x-displayname":"Discovery Schema","x-ves-proto-message":"ves.io.schema.app_type.DiscoveredSchema","properties":{"last_updated_time":{"type":"string","description":" Last Updated Time for request API endpoint. The time updated when the APIEP file is uploaded to Azure/AWS.\n\nExample: ` \"2021-01-22 15:46:23.767649\"`","title":"Last Updated Time","format":"date-time","x-displayname":"Last Updated Time","x-ves-example":"2021-01-22 15:46:23.767649"},"request_schema":{"$ref":"#/components/schemas/app_typeRequestSchema"},"response_schema_per_rsp_code":{"type":"object","description":" Response schema per rsp code for request API endpoint.","title":"Response schema per rsp code","x-displayname":"Response Schema Per Rsp Code"}}},"app_typeFeature":{"type":"object","description":"List of features that are to be enabled for this apptype. FeatureType enum lists\nthe features available.","title":"Feature type container","x-displayname":"Features","x-ves-proto-message":"ves.io.schema.app_type.Feature","properties":{"type":{"$ref":"#/components/schemas/app_typeFeatureType"}}},"app_typeFeatureType":{"type":"string","description":"Enumeration for AI/ML features supported\n\nAPI Discovery enables generation of model for various API interactions between services of App type.\nEnable analysis of timeseries for various metric collected like requests, errors, latency etc.\nEnable anomaly detection per API request, i.e. the probability density function (PDF) charts generation for API endpoints\nEnable user behavior analysis","title":"FeatureType","enum":["BUSINESS_LOGIC_MARKUP","TIMESERIES_ANOMALY_DETECTION","PER_REQ_ANOMALY_DETECTION","USER_BEHAVIOR_ANALYSIS"],"default":"BUSINESS_LOGIC_MARKUP","x-displayname":"AI/ML Features","x-ves-proto-enum":"ves.io.schema.app_type.FeatureType"},"app_typeGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read app_type","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.app_type.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/app_typeCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/app_typeReplaceRequest"},"spec":{"$ref":"#/components/schemas/app_typeGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/app_typeStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"app_typeGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"app_typeGetSpecType":{"type":"object","description":"Get App type will read the configuration from namespace metadata.namespace","title":"Get App type","x-displayname":"Get App Type","x-ves-proto-message":"ves.io.schema.app_type.GetSpecType","properties":{"business_logic_markup_setting":{"$ref":"#/components/schemas/app_typeBusinessLogicMarkupSetting"},"features":{"type":"array","description":" List of various AI/ML features enabled\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/app_typeFeature"},"x-displayname":"Features","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"app_typeKeyPattern":{"type":"object","description":"x-displayName: \"Key Pattern\"\nPattern to detect. Could be exact match or regex match.","title":"Key Pattern","properties":{"exact_value":{"type":"string","description":"x-displayName: \"Exact Value\"\nx-example: \"x-volt-header\"\nSearch for values with exact match.","title":"exact value"},"regex_value":{"type":"string","description":"x-displayName: \"Regex Value\"\nx-example: \"'^new.*$', 'san f.*', '.* del .*'\"\nSearch for values matching this regular expression.","title":"regex value"}}},"app_typeKeyValuePattern":{"type":"object","description":"x-displayName: \"Key & Value Pattern\"\nSearch for specific key & value patterns in the specified sections.","title":"Key-Value Pattern","properties":{"key_pattern":{"$ref":"#/components/schemas/app_typeKeyPattern"},"value_pattern":{"$ref":"#/components/schemas/app_typeValuePattern"}}},"app_typeListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of app_type","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.app_type.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/app_typeListResponseItem"},"x-displayname":"Items"}}},"app_typeListResponseItem":{"type":"object","description":"By default a summary of app_type is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of app_type","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.app_type.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this app_type","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this app_type","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates app_type is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/app_typeGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this app_type","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this app_type\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/app_typeStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this app_type\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"app_typeOverrideInfo":{"type":"object","description":"Rule to override a given automatic dynamic identifier used to expand or collapse API URL","title":"Override automatic collapse","x-displayname":"Override Rule","x-ves-proto-message":"ves.io.schema.app_type.OverrideInfo","properties":{"component_identifier":{"type":"string","description":"\n\nExample: ` \"/api/v1/user_id/DYN\"`","title":"Override component identifier","x-displayname":"Identifier","x-ves-example":"/api/v1/user_id/DYN"},"set_dynamic":{"type":"boolean","description":" Enable or Disable component to be considered as dynamic to collapse or expand API URL\n\nExample: ` \"False\"`","title":"Override Value","format":"boolean","x-displayname":"Enable/Disable","x-ves-example":"False"}}},"app_typeOverridePopReq":{"type":"object","description":"Shape of remove to remove override for API endpoints","title":"Remove API endpoint override request","x-displayname":"Remove Override Request","x-ves-proto-message":"ves.io.schema.app_type.OverridePopReq","properties":{"app_type_name":{"type":"string","description":" App Type for current request\n\nExample: ` \"blogging-app\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"blogging-app"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"}}},"app_typeOverridePopRsp":{"type":"object","description":"Shape of response to add override for API endpoints","title":"Add API endpoint override response","x-displayname":"Add Override Response","x-ves-proto-message":"ves.io.schema.app_type.OverridePopRsp","properties":{"status":{"type":"boolean","description":" Status of the add operation (sucess or fail)\n\nExample: ` \"true\"`","title":"Status","format":"boolean","x-displayname":"Status","x-ves-example":"true"},"status_msg":{"type":"string","description":" Message string for the status of add operation\n\nExample: ` \"Override Pop Successful\"`","title":"Message","x-displayname":"Message","x-ves-example":"Override Pop Successful"}}},"app_typeOverridePushReq":{"type":"object","description":"Shape of request to add override for API endpoints","title":"Add API endpoint override request","x-displayname":"Add Override Request","x-ves-proto-message":"ves.io.schema.app_type.OverridePushReq","properties":{"app_type_name":{"type":"string","description":" App Type for current request\n\nExample: ` \"blogging-app\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"blogging-app"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"},"override_info":{"$ref":"#/components/schemas/app_typeOverrideInfo"}}},"app_typeOverridePushRsp":{"type":"object","description":"Shape of response to add override for API endpoints","title":"Add API endpoint override response","x-displayname":"Add Override Response","x-ves-proto-message":"ves.io.schema.app_type.OverridePushRsp","properties":{"status":{"type":"boolean","description":" Status of the add operation (sucess or fail)\n\nExample: ` \"true\"`","title":"Status","format":"boolean","x-displayname":"Status","x-ves-example":"true"},"status_msg":{"type":"string","description":" Message string for the status of add operation\n\nExample: ` \"Override Push Successful\"`","title":"Message","x-displayname":"Message","x-ves-example":"Override Push Successful"}}},"app_typeOverridesRsp":{"type":"object","description":"shape of response to get override for API endpoints","title":"Get API endpoint override response","x-displayname":"Get Override Response","x-ves-proto-message":"ves.io.schema.app_type.OverridesRsp","properties":{"override_list":{"type":"array","description":" List of all override applied to API endpoints of requested App Type","title":"List of override","items":{"$ref":"#/components/schemas/app_typeOverrideInfo"},"x-displayname":"Override"}}},"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_typeReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a app_type","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.app_type.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/app_typeReplaceSpecType"}}},"app_typeReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.app_type.ReplaceResponse"},"app_typeReplaceSpecType":{"type":"object","description":"Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.","title":"Replace App type","x-displayname":"Replace App Type","x-ves-proto-message":"ves.io.schema.app_type.ReplaceSpecType","properties":{"business_logic_markup_setting":{"$ref":"#/components/schemas/app_typeBusinessLogicMarkupSetting"},"features":{"type":"array","description":" List of various AI/ML features enabled\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","items":{"$ref":"#/components/schemas/app_typeFeature"},"x-displayname":"Features","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"app_typeRequestSchema":{"type":"object","description":"Request schema for a given API endpoint.","title":"Request Schema","x-displayname":"Request Schema","x-ves-proto-message":"ves.io.schema.app_type.RequestSchema","properties":{"body_per_content_type":{"type":"object","description":" Body schema per content type for request API endpoint.","title":"Body schema per content type","x-displayname":"Body Schema Per Content Type"},"cookies":{"$ref":"#/components/schemas/app_typeSchemaStruct"},"headers":{"$ref":"#/components/schemas/app_typeSchemaStruct"},"query_params":{"$ref":"#/components/schemas/app_typeSchemaStruct"}}},"app_typeResponseSchema":{"type":"object","description":"x-displayName: \"Response Schema\"\nResponse schema for a given API endpoint.","title":"Response Schema","properties":{"body_per_content_type":{"type":"object","description":"x-displayName: \"Body Schema Per Content Type\"\nBody schema per content type for request API endpoint.","title":"Body schema per content type"},"headers":{"$ref":"#/components/schemas/app_typeSchemaStruct"}}},"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_typeSchemaStruct":{"type":"object","description":"Schema structure for a given API endpoint.","title":"Schema Structure","x-displayname":"Schema Structure","x-ves-proto-message":"ves.io.schema.app_type.SchemaStruct","properties":{"examples":{"type":"array","description":" Examples for request API endpoint.","title":"Examples","items":{"type":"string"},"x-displayname":"Examples"},"schema":{"type":"string","description":" Schema for request API endpoint.","title":"Schema","x-displayname":"Schema"}}},"app_typeSensitiveData":{"type":"object","description":"Sensitive data for a given API endpoint.","title":"Sensitive Data","x-displayname":"Sensitive Data","x-ves-proto-message":"ves.io.schema.app_type.SensitiveData","properties":{"compliances":{"type":"array","description":" Compliance frameworks.","title":"Compliances","items":{"type":"string"},"x-displayname":"Compliances"},"examples":{"type":"array","description":" Examples of sensitive data.","title":"Examples","items":{"type":"string"},"x-displayname":"Examples"},"field":{"type":"string","description":" Field of sensitive data.","title":"Field","x-displayname":"Field"},"rule_type":{"$ref":"#/components/schemas/app_typeSensitiveDataDetectionRuleType"},"section":{"type":"string","description":" Section of sensitive data.\n\nExample: ` req_body`","title":"Section","x-displayname":"Section"},"sensitive_data_type":{"type":"string","description":" Type of sensitive data.\n\nExample: ` EMAIL`","title":"Sensitive Data Type","x-displayname":"Type"},"type":{"$ref":"#/components/schemas/app_typeSensitiveDataType"}}},"app_typeSensitiveDataDetectionRuleType":{"type":"string","description":"Sensitive Data Detection Rule Type\n\n - RULE_TYPE_BUILT_IN: built_in\n\nBuilt in rule type\n - RULE_TYPE_CUSTOM: custom\n\nCustom rule type","title":"sensitive_data_detection_rule_type","enum":["RULE_TYPE_BUILT_IN","RULE_TYPE_CUSTOM"],"default":"RULE_TYPE_BUILT_IN","x-displayname":"Sensitive Data Detection Rule Type","x-ves-proto-enum":"ves.io.schema.app_type.SensitiveDataDetectionRuleType"},"app_typeSensitiveDataDetectionRules":{"type":"object","description":"x-displayName: \"Sensitive Data Detection Rules\"\nRules to manage/configure sensitive data detection in requests and/or response sections.","title":"Sensitive Data Detection Rules","properties":{"custom_sensitive_data_detection_rules":{"type":"array","description":"x-displayName: \"Defined Custom Sensitive Data Types\"\nRules to detect custom sensitive data in requests and/or responses sections.","title":"custom sensitive data rules","items":{"$ref":"#/components/schemas/app_typeCustomSensitiveDataDetectionRule"}},"disabled_built_in_rules":{"type":"array","description":"x-displayName: \"Disabled Built-In Sensitive Data Types\"\nx-example: \"[EMAIL, CC]\"\nList of disabled built-in sensitive data detection rules.","title":"disabled_built_in_rules","items":{"$ref":"#/components/schemas/app_typeBuiltInSensitiveDataType"}}}},"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"},"app_typeServiceAPIEndpointPDFReq":{"type":"object","description":"shape of request to get PDF for a given API endpoint.","title":"Service API endpoint PDF request","x-displayname":"Per Service API Endpoint PDF Request","x-ves-proto-message":"ves.io.schema.app_type.ServiceAPIEndpointPDFReq","properties":{"app_type_name":{"type":"string","description":" App Type for current request\n\nExample: ` \"blogging-app\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"blogging-app"},"collapsed_url":{"type":"string","description":" API endpoint for which PDFs are requested.\n\nExample: ` \"value\"`","title":"Discovered API URL","x-displayname":"API URL","x-ves-example":"value"},"method":{"type":"string","description":" method of API endpoint for which PDFs are requested.\n\nExample: ` \"value\"`","title":"Method of current API URL","x-displayname":"Method","x-ves-example":"value"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"},"service_name":{"type":"string","description":" Identifies the destination service\n\nExample: ` \"N:public or S:productpage\"`","title":"Service","x-displayname":"Service Name","x-ves-example":"N:public or S:productpage"}}},"app_typeServiceAPIEndpointsReq":{"type":"object","description":"Request shape for GET Service API endpoints API","title":"API endpoints per service GET request","x-displayname":"Service API Endpoints Request","x-ves-proto-message":"ves.io.schema.app_type.ServiceAPIEndpointsReq","properties":{"api_endpoint_info_request":{"type":"array","description":" List of additional things that needs to be sent as part of the request\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Api Endpoint Info Request","items":{"$ref":"#/components/schemas/app_typeApiEndpointInfoRequest"},"x-displayname":"Api Endpoint Info Request","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"app_type_name":{"type":"string","description":" App Type for current request\n\nExample: ` \"blogging-app\"`","title":"App Type","x-displayname":"App Type","x-ves-example":"blogging-app"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"},"service_name":{"type":"string","description":" Identifies the destination service\n\nExample: ` \"N:public or S:productpage\"`","title":"Service","x-displayname":"Service Name","x-ves-example":"N:public or S:productpage"}}},"app_typeStatusObject":{"type":"object","description":"Most recently observed status of object","title":"AppType Status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.app_type.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/schemaObjectRefType"},"x-displayname":"Config Object"}}},"app_typeValuePattern":{"type":"object","description":"x-displayName: \"Value Pattern\"\nPattern to detect. Could be exact match or regex match.","title":"Value Pattern","properties":{"exact_value":{"type":"string","description":"x-displayName: \"Exact Value\"\nx-example: \"x-volt-header\"\nPattern value to be detected.","title":"exact value"},"regex_value":{"type":"string","description":"x-displayName: \"Regex Value\"\nx-example: \"'^new.*$', 'san f.*', '.* del .*'\"\nRegular expression for this pattern.","title":"regex value"}}},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaHttpMethod":{"type":"string","description":"x-displayName: \"HTTP Method\"\nSpecifies the HTTP method used to access a resource.\n\n - ANY: x-displayName: \"ANY\"\nAny HTTP Method\n - GET: x-displayName: \"GET\"\n - HEAD: x-displayName: \"HEAD\"\n - POST: x-displayName: \"POST\"\n - PUT: x-displayName: \"PUT\"\n - DELETE: x-displayName: \"DELETE\"\n - CONNECT: x-displayName: \"CONNECT\"\n - OPTIONS: x-displayName: \"OPTIONS\"\n - TRACE: x-displayName: \"TRACE\"\n - PATCH: x-displayName: \"PATCH\"\n - COPY: x-displayName: \"COPY\"","title":"HttpMethod","enum":["ANY","GET","HEAD","POST","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH","COPY"],"default":"ANY"},"schemaHttpSections":{"type":"string","description":"x-displayName: \"HTTP Sections\"\nRequest & Response Sections.\n\n - HTTP_SECTION_NONE: None\n\nALL_SECTIONS\nx-displayName: \"None\"\n - HTTP_SECTION_QUERY_PARAMS: QUERY_PARAMS\n\nx-displayName: \"Request Query Params\"\n - HTTP_SECTION_REQ_HEADERS: REQ_HEADERS\n\nx-displayName: \"Request Headers\"\n - HTTP_SECTION_RSP_HEADERS: RSP_HEADERS\n\nx-displayName: \"Response Headers\"\n - HTTP_SECTION_REQ_BODY: REQ_BODY\n\nx-displayName: \"Request Body\"\n - HTTP_SECTION_RSP_BODY: RSP_BODY\n\nx-displayName: \"Response Body\"","title":"HTTPSections","enum":["HTTP_SECTION_NONE","HTTP_SECTION_QUERY_PARAMS","HTTP_SECTION_REQ_HEADERS","HTTP_SECTION_RSP_HEADERS","HTTP_SECTION_REQ_BODY","HTTP_SECTION_RSP_BODY"],"default":"HTTP_SECTION_NONE"},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaMessageMetaType":{"type":"object","description":"x-displayName: \"Message Metadata\"\nMessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","properties":{"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Virtual Host for acmecorp website\"\nHuman readable description.","title":"description"},"disable":{"type":"boolean","description":"x-displayName: \"Disable\"\nx-example: \"true\"\nA value of true will administratively disable the object that corresponds to the containing message.","title":"disable","format":"boolean"},"name":{"type":"string","description":"x-displayName: \"Name\"\nx-example: \"acmecorp-web\"\nx-required\nThis is the name of the message.\nThe value of name has to follow DNS-1035 format.","title":"name"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}}}}}