@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/resources/workload_flavor.md

@@ -0,0 +1,90 @@
+---
+page_title: "f5xc_workload_flavor Resource - terraform-provider-f5xc"
+subcategory: "Kubernetes"
+description: |-
+  [Namespace: required] Manages workload_flavor in F5 Distributed Cloud.
+---
+
+# f5xc_workload_flavor (Resource)
+
+[Namespace: required] Manages workload_flavor in F5 Distributed Cloud.
+
+~> **Note** Please refer to [Workload Flavor API docs](https://docs.cloud.f5.com/docs-v2/api/workload-flavor) to learn more.
+
+## Example Usage
+
+```terraform
+# Workload Flavor Resource Example
+# [Namespace: required] Manages workload_flavor in F5 Distributed Cloud.
+
+# Basic Workload Flavor configuration
+resource "f5xc_workload_flavor" "example" {
+  name      = "example-workload-flavor"
+  namespace = "staging"
+
+  labels = {
+    environment = "production"
+    managed_by  = "terraform"
+  }
+
+  annotations = {
+    "owner" = "platform-team"
+  }
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Argument Reference
+
+### Metadata Argument Reference
+
+<a id="name"></a>&#x2022; [`name`](#name) - Required String<br>Name of the Workload Flavor. Must be unique within the namespace
+
+<a id="namespace"></a>&#x2022; [`namespace`](#namespace) - Required String<br>Namespace where the Workload Flavor will be created
+
+<a id="annotations"></a>&#x2022; [`annotations`](#annotations) - Optional Map<br>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata
+
+<a id="description"></a>&#x2022; [`description`](#description) - Optional String<br>Human readable description for the object
+
+<a id="disable"></a>&#x2022; [`disable`](#disable) - Optional Bool<br>A value of true will administratively disable the object
+
+<a id="labels"></a>&#x2022; [`labels`](#labels) - Optional Map<br>Labels is a user defined key value map that can be attached to resources for organization and filtering
+
+### Spec Argument Reference
+
+<a id="ephemeral-storage"></a>&#x2022; [`ephemeral_storage`](#ephemeral-storage) - Optional String<br>Ephemeral Storage (MiB). Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor
+
+<a id="memory"></a>&#x2022; [`memory`](#memory) - Optional String<br>Memory (MiB). Memory in MiB (mebibyte) allocated for the workload_flavor
+
+<a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
+
+<a id="vcpus"></a>&#x2022; [`vcpus`](#vcpus) - Optional Number<br>vCPUs. Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core
+
+### Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+<a id="id"></a>&#x2022; [`id`](#id) - Optional String<br>Unique identifier for the resource
+
+---
+
+#### Timeouts
+
+A [`timeouts`](#timeouts) block supports the following:
+
+<a id="timeouts-create"></a>&#x2022; [`create`](#timeouts-create) - Optional String (Defaults to `10 minutes`)<br>Used when creating the resource
+
+<a id="timeouts-delete"></a>&#x2022; [`delete`](#timeouts-delete) - Optional String (Defaults to `10 minutes`)<br>Used when deleting the resource
+
+<a id="timeouts-read"></a>&#x2022; [`read`](#timeouts-read) - Optional String (Defaults to `5 minutes`)<br>Used when retrieving the resource
+
+<a id="timeouts-update"></a>&#x2022; [`update`](#timeouts-update) - Optional String (Defaults to `10 minutes`)<br>Used when updating the resource
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Import using namespace/name format
+terraform import f5xc_workload_flavor.example system/example
+```

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.ai_assistant","description":"Custom handler for ai assistant related microservice","version":""},"paths":{"/api/gen-ai/namespaces/{namespace}/eval_query":{"post":{"summary":"Eval AI Assistant Query","description":"Temporarily to be used in place of AIAssistantQuery for evaluating api access/rbac check","operationId":"ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace of the HTTP Load Balancer for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ai_assistantAIAssistantQueryRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-ai_assistant-sahayaapi-evalaiassistantquery"},"x-ves-proto-rpc":"ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantQuery"},"x-displayname":"AI Assistant APIs","x-ves-proto-service":"ves.io.schema.ai_assistant.SahayaAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/gen-ai/namespaces/{namespace}/eval_query_feedback":{"post":{"summary":"Eval Feedback of AI Assistant Query","description":"Temporarily to be used in place of AIAssistantFeedback for evaluating api access/rbac check","operationId":"ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantFeedback","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nNamespace of the HTTP Load Balancer for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ai_assistantAIAssistantQueryFeedbackRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-ai_assistant-sahayaapi-evalaiassistantfeedback"},"x-ves-proto-rpc":"ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantFeedback"},"x-displayname":"AI Assistant APIs","x-ves-proto-service":"ves.io.schema.ai_assistant.SahayaAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/gen-ai/namespaces/{namespace}/query":{"post":{"summary":"AI Assistant Query","description":"Enable service by returning service account details","operationId":"ves.io.schema.ai_assistant.SahayaAPI.AIAssistantQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ai_assistantAIAssistantQueryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"\nNamespace of the HTTP Load Balancer for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ai_assistantAIAssistantQueryRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-ai_assistant-sahayaapi-aiassistantquery"},"x-ves-proto-rpc":"ves.io.schema.ai_assistant.SahayaAPI.AIAssistantQuery"},"x-displayname":"AI Assistant APIs","x-ves-proto-service":"ves.io.schema.ai_assistant.SahayaAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/gen-ai/namespaces/{namespace}/query_feedback":{"post":{"summary":"Feedback of AI Assistant Query","description":"Enable service by returning service account details","operationId":"ves.io.schema.ai_assistant.SahayaAPI.AIAssistantFeedback","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemaEmpty"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nNamespace of the HTTP Load Balancer for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ai_assistantAIAssistantQueryFeedbackRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-ai_assistant-sahayaapi-aiassistantfeedback"},"x-ves-proto-rpc":"ves.io.schema.ai_assistant.SahayaAPI.AIAssistantFeedback"},"x-displayname":"AI Assistant APIs","x-ves-proto-service":"ves.io.schema.ai_assistant.SahayaAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"AI Assistant APIs","x-ves-proto-package":"ves.io.schema.ai_assistant","components":{"requestBodies":{"ai_assistantAIAssistantQueryFeedbackRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ai_assistantAIAssistantQueryFeedbackRequest"}}},"required":true},"ai_assistantAIAssistantQueryRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ai_assistantAIAssistantQueryRequest"}}},"required":true}},"schemas":{"ai_assistantAIAssistantQueryFeedbackRequest":{"type":"object","description":"AI Assistant Query Feedback Request","title":"AI Assistant Query Feedback Request","x-displayname":"AI Assistant Query Feedback Request","x-ves-oneof-field-feedback_choice":"[\"negative_feedback\",\"positive_feedback\"]","x-ves-proto-message":"ves.io.schema.ai_assistant.AIAssistantQueryFeedbackRequest","properties":{"comment":{"type":"string","description":"\n\nExample: ` \"Response is biased\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 4096\n","title":"comment","maxLength":4096,"x-displayname":"Comment","x-ves-example":"Response is biased","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"4096"}},"namespace":{"type":"string","description":" Namespace of the HTTP Load Balancer for current request\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"negative_feedback":{"$ref":"#/components/schemas/ai_assistantNegativeFeedbackDetails"},"positive_feedback":{"$ref":"#/components/schemas/schemaEmpty"},"query":{"type":"string","description":" Query will be in text format\n\nExample: ` \"How to investigate request log\"`","title":"query","x-displayname":"Query","x-ves-example":"How to investigate request log"},"query_id":{"type":"string","description":" Query Identifier\n\nExample: ` \"07e03bc6-81d4-4c86-a865-67b5763fe294\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$\n","title":"query_id","x-displayname":"Query Id","x-ves-example":"07e03bc6-81d4-4c86-a865-67b5763fe294","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"}}}},"ai_assistantAIAssistantQueryRequest":{"type":"object","description":"AI Assistant Query Request","title":"AI Assistant Query Request","x-displayname":"AI Assistant Query Request","x-ves-proto-message":"ves.io.schema.ai_assistant.AIAssistantQueryRequest","properties":{"current_query":{"type":"string","description":" Current query will be in text format\n\nExample: ` \"Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294\"`","title":"current_query","x-displayname":"Current query","x-ves-example":"Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294"},"namespace":{"type":"string","description":" Namespace of the HTTP Load Balancer for current request\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"}}},"ai_assistantAIAssistantQueryResponse":{"type":"object","description":"AI Assistant Query Response","title":"AI Assistant Query Response","x-displayname":"AI Assistant Query Response","x-ves-oneof-field-response_choice":"[\"explain_log\",\"gen_dashboard_filter\",\"generic_response\",\"list_response\",\"site_analysis_response\",\"widget_response\"]","x-ves-proto-message":"ves.io.schema.ai_assistant.AIAssistantQueryResponse","properties":{"current_query":{"type":"string","description":" Current query will be in text format\n\nExample: ` \"Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294\"`","title":"current_query","x-displayname":"Current query","x-ves-example":"Explain security event 07e03bc6-81d4-4c86-a865-67b5763fe294"},"explain_log":{"$ref":"#/components/schemas/explain_log_recordExplainLogRecordResponse"},"follow_up_queries":{"type":"array","description":" Follow up Queries to be given as suggestion to users\n\nExample: ` \"Explain following violation in whole namespace\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"follow_up_queries","items":{"type":"string"},"x-displayname":"Follow up Queries","x-ves-example":"Explain following violation in whole namespace","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"gen_dashboard_filter":{"$ref":"#/components/schemas/gen_dashboard_filterGenDashboardFilterResponse"},"generic_response":{"$ref":"#/components/schemas/commonGenericResponse"},"list_response":{"$ref":"#/components/schemas/listListResponse"},"query_id":{"type":"string","description":" Query Identifier\n\nExample: ` \"07e03bc6-81d4-4c86-a865-67b5763fe294\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.pattern: ^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$\n","title":"query_id","x-displayname":"Query Id","x-ves-example":"07e03bc6-81d4-4c86-a865-67b5763fe294","x-ves-validation-rules":{"ves.io.schema.rules.string.pattern":"^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$"}},"site_analysis_response":{"$ref":"#/components/schemas/site_analysisSiteAnalysisResponse"},"widget_response":{"$ref":"#/components/schemas/widgetWidgetResponse"}}},"ai_assistantNegativeFeedbackDetails":{"type":"object","description":"Negative Feedback Details","title":"NegativeFeedbackDetails","x-displayname":"Negative Feedback Details","x-ves-proto-message":"ves.io.schema.ai_assistant.NegativeFeedbackDetails","properties":{"remarks":{"type":"array","description":"\n\nExample: ` \"Inaccurate data\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.unique: true\n","title":"remarks","items":{"$ref":"#/components/schemas/ai_assistantNegativeFeedbackType"},"x-displayname":"Feedback","x-ves-example":"Inaccurate data","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.unique":"true"}}}},"ai_assistantNegativeFeedbackType":{"type":"string","description":"x-displayName \"Negative Feedback Type\"\nType of Negative Feedback\n\n - OTHER: x-displayName \"Other\"\nOther\n - INACCURATE_DATA: x-displayName \"Inaccurate data\"\nInaccurate data\n - IRRELEVANT_CONTENT: x-displayName \"Irrelevant content\"\nIrrelevant content\n - POOR_FORMAT: x-displayName \"Poor format\"\nPoor format\n - SLOW_RESPONSE: x-displayName \"Slow response\"\nSlow response","title":"Negative Feedback Type","enum":["OTHER","INACCURATE_DATA","IRRELEVANT_CONTENT","POOR_FORMAT","SLOW_RESPONSE"],"default":"OTHER","x-displayname":"","x-ves-proto-enum":"ves.io.schema.ai_assistant.NegativeFeedbackType"},"ai_assistantcommonUnitType":{"type":"string","description":"Unit Type defines the unit for each fields.\n\n - UNIT_TYPE_NONE: None\n\nNone type\n - GB: GB\n\n - PERCENT: Percent\n\n - BYTE: Byte\n","title":"UnitType","enum":["UNIT_TYPE_NONE","GB","PERCENT","BYTE"],"default":"UNIT_TYPE_NONE","x-displayname":"Unit Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.UnitType"},"ai_assistantexplain_log_recordAction":{"type":"string","description":"Action taken for the request\n\n - ACTION_NONE: None\n\nNo action\n - ALLOW: Allow\n\nThe request was allowed to pass\n - BLOCK: Block\n\nThe request was blocked\n - REDIRECT: Redirect\n\nThe request was redirected","title":"Action","enum":["ACTION_NONE","ALLOW","BLOCK","REDIRECT"],"default":"ACTION_NONE","x-displayname":"Action","x-ves-proto-enum":"ves.io.schema.ai_assistant.explain_log_record.Action"},"commonCellProperties":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.common.CellProperties","properties":{"status_style":{"$ref":"#/components/schemas/commonStatusStyle"}}},"commonColourType":{"type":"string","description":"Colour Type defines the colour of fields to be displayed.\n\n - COLOUR_TYPE_NONE: None\n\nNo colour\n - DANGER: danger\n\ncolour type red\n - INFO: info\n\ncolour type blue\n - WARNING: warning\n\ncolour type orange\n - AMBER: amber\n\ncolour type yellow\n - SUCCESS: success\n\ncolour type green\n - MALIBU: malibu\n\ncolour type blue","title":"ColourType","enum":["COLOUR_TYPE_NONE","DANGER","INFO","WARNING","AMBER","SUCCESS","MALIBU"],"default":"COLOUR_TYPE_NONE","x-displayname":"Colour Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.ColourType"},"commonColumnType":{"type":"string","description":"Column Type defines the data type for each column.\n\n - COLUMN_TYPE_NONE: None\n\n - STRING: string\n\n - INT: integer\n\n - FLOAT: float\n\n - BOOL: boolean\n","title":"ColumnType","enum":["COLUMN_TYPE_NONE","STRING","INT","FLOAT","BOOL"],"default":"COLUMN_TYPE_NONE","x-displayname":"Column Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.ColumnType"},"commonDashboardLink":{"type":"object","description":"Dashboard link will present common fields like type, namespace, object, dateFilter, logFilter","title":"DashboardLink","x-displayname":"Dashboard Link","x-ves-proto-message":"ves.io.schema.ai_assistant.common.DashboardLink","properties":{"key":{"type":"string","description":" Key will present a placeholder in a text field to insert the link.\n For example: To view these events go to the ${{link:db_link}}.\n\nExample: ` \"db_link\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"key","x-displayname":"Key","x-ves-example":"db_link","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"log_filters":{"type":"array","description":" Logs filter","title":"log_filters","items":{"$ref":"#/components/schemas/commonLogFilter"},"x-displayname":"Logs Filter"},"namespace":{"type":"string","description":" Namespace for current request\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"object_name":{"type":"string","description":" Object name such as LB, VH\n\nExample: ` \"ves-io-http-loadbalancer-prod-nginx\"`","title":"object_name","x-displayname":"Object name","x-ves-example":"ves-io-http-loadbalancer-prod-nginx"},"time_range":{"type":"string","description":" Time range filter\n\nExample: ` \"604800\"`","title":"time_range","x-displayname":"Time Range","x-ves-example":"604800"},"title":{"type":"string","description":" Title for the link\n\nExample: ` \"Security Analytics lb1\"`","title":"title","x-displayname":"Title","x-ves-example":"Security Analytics lb1"},"type":{"$ref":"#/components/schemas/commonDashboardLinkType"}}},"commonDashboardLinkType":{"type":"string","description":"Link Type to be presented\n\n - SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS\n\nSecurity analytics dashboard: /web/workspaces/web-app-and-api-protection/../dashboard/security-dashboard/../security_analytics/events\n - REQUESTS_EVENTS: REQUESTS_EVENTS\n\nRequests dashboard: /web/workspaces/web-app-and-api-protection/../dashboard/security-dashboard/../security_monitoring/request\n - SITES: SITES\n\nSites dashboard: /web/workspaces/multi-cloud-network-connect/overview/sites/dashboard\n - CLOUD_CREDENTIALS: CLOUD_CREDENTIALS\n\nCLOUD_CREDENTIALS --> /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/cloud_credential\n - SITES_UBER: SITES_UBER\n\nSites dashboard: /web/workspaces/multi-cloud-network-connect/overview/sites/dashboard\n - SITE_ALERTS: SITE_ALERTS\n\nAlerts dashboard: /web/workspaces/multi-cloud-network-connect/overview/infrastructure/sites/alerts\n - SITE_MANAGEMENT_AWS_VPC_SITES: SITE_MANAGEMENT_AWS_VPC_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/aws_vpc_site\n - SITE_MANAGEMENT_AWS_TGW_SITES: SITE_MANAGEMENT_AWS_TGW_SITES\n\nSite Management dashboard: /web/workspacesmulti-cloud-network-connect/manage/site_management/cloud_sites/aws_tgw_site\n - SITE_MANAGEMENT_AZURE_VNET_SITES: SITE_MANAGEMENT_AZURE_VNET_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/azure_site\n - SITE_MANAGEMENT_GCP_VPC_SITES: SITE_MANAGEMENT_GCP_VPC_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/gcp_vpc_site\n - SITE_MANAGEMENT_APP_STACK_SITES: SITE_MANAGEMENT_APP_STACK_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/appstack_site\n - SITE_MANAGEMENT_SECURE_MESH_SITES: SITE_MANAGEMENT_SECURE_MESH_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/legacy_configs/securemesh_site\n - TENANT_OVERVIEW_PAGE: TENANT_OVERVIEW_PAGE\n\nTenant Overview Page: /web/workspaces/administration/tenant-settings/tenant-overview\n - SUPPORT: SUPPORT\n\nSupport Page: /web/home","title":"LinkType","enum":["SECURITY_ANALYTICS_EVENTS","REQUESTS_EVENTS","SITES","CLOUD_CREDENTIALS","SITES_UBER","SITE_ALERTS","SITE_MANAGEMENT_AWS_VPC_SITES","SITE_MANAGEMENT_AWS_TGW_SITES","SITE_MANAGEMENT_AZURE_VNET_SITES","SITE_MANAGEMENT_GCP_VPC_SITES","SITE_MANAGEMENT_APP_STACK_SITES","SITE_MANAGEMENT_SECURE_MESH_SITES","TENANT_OVERVIEW_PAGE","SUPPORT"],"default":"SECURITY_ANALYTICS_EVENTS","x-displayname":"Link Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.DashboardLinkType"},"commonDisplay":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.common.Display","properties":{"colour":{"$ref":"#/components/schemas/commonColourType"},"display_type":{"$ref":"#/components/schemas/commonDisplayType"},"formats":{"type":"array","description":"\n\nExample: ` \"Bold Italic\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"format","items":{"$ref":"#/components/schemas/commonFormatType"},"x-displayname":"formats","x-ves-example":"Bold Italic","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"commonDisplayType":{"type":"string","description":"Render Type defines the format to which data has to be rendered on UI.\n\n - DISPLAY_TYPE_NONE: None\n\nNone type\n - ICON: icon\n\nValue to be displayed as ICON\n - PROGRESS_BAR: progress bar\n\n - DATE: date\n\n - DURATION: duration\n\n - PROVIDER_ICON: provider icon\n","title":"DisplayType","enum":["DISPLAY_TYPE_NONE","ICON","DOT_WITH_VALUE","PROGRESS_BAR","DATE","DURATION","PROVIDER_ICON"],"default":"DISPLAY_TYPE_NONE","x-displayname":"DisplayType Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.DisplayType"},"commonFieldProperties":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.common.FieldProperties","properties":{"data_type":{"$ref":"#/components/schemas/commonColumnType"},"display":{"$ref":"#/components/schemas/commonDisplay"},"name":{"type":"string","description":"\n\nExample: ` \"provider\"`","title":"Name","x-displayname":"name","x-ves-example":"provider"},"title":{"type":"string","description":"\n\nExample: ` \"Site Name\"`","title":"Title","x-displayname":"title","x-ves-example":"Site Name"},"tooltip":{"type":"string","description":" Tooltip for the field","title":"Tooltip","x-displayname":"tooltip"},"unit":{"$ref":"#/components/schemas/ai_assistantcommonUnitType"}}},"commonFilterOperator":{"type":"string","description":"Operator for query filter\n\n - IN: Filter Operator\n\nSpecifies that query result includes filter values\n - NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values","title":"Filter Operator","enum":["IN","NOT_IN"],"default":"IN","x-displayname":"Filter Operator","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.FilterOperator"},"commonFormatType":{"type":"string","description":"Format Type defines the format type for each fields.\n\n - FORMAT_TYPE_NONE: None\n\nNo format\n - INLINE: Inline\n\nKey value to be displayed in inline format\n - BOLD: Bold\n\nValue to be displayed in bold format\n - REVERSE_KEY_VALUE_ORDER: ReverseKeyValueOrder\n\nKey value to be displayed in Reverse Key Value Order format\n - WRAP: Wrap\n\nValue to be wrapped","title":"FormatType","enum":["FORMAT_TYPE_NONE","INLINE","BOLD","REVERSE_KEY_VALUE_ORDER","WRAP"],"default":"FORMAT_TYPE_NONE","x-displayname":"Format Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.FormatType"},"commonGenericLink":{"type":"object","description":"Generic link can have external link with full url","title":"GenericLink","x-displayname":"Generic Link","x-ves-proto-message":"ves.io.schema.ai_assistant.common.GenericLink","properties":{"key":{"type":"string","description":" Key will present a placeholder in a text field to insert the link.\n For example: To view these events go to the ${{link:db_link}}.\n\nExample: ` \"db_link\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"key","x-displayname":"Key","x-ves-example":"db_link","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"title":{"type":"string","description":" Title for the link\n\nExample: ` \"Security Analytics lb1\"`","title":"title","x-displayname":"Title","x-ves-example":"Security Analytics lb1"},"url":{"type":"string","description":" Full url\n\nExample: ` \"https://datatracker.ietf.org/doc/html/rfc3986\"`","title":"url","x-displayname":"URL","x-ves-example":"https://datatracker.ietf.org/doc/html/rfc3986"}}},"commonGenericResponse":{"type":"object","description":"Generic Response","title":"Generic Response","x-displayname":"Generic Response","x-ves-proto-message":"ves.io.schema.ai_assistant.common.GenericResponse","properties":{"error":{"$ref":"#/components/schemas/schemaErrorType"},"is_error":{"type":"boolean","description":"\n\nExample: ` \"true\"`","title":"is_error","format":"boolean","x-displayname":"is_error","x-ves-example":"true"},"summary":{"type":"string","description":" \n\nExample: ` \"Query not supported\"`","title":"Summary","x-displayname":"Summary","x-ves-example":"Query not supported"}}},"commonLink":{"type":"object","description":"Link for a page","title":"Link","x-displayname":"Link","x-ves-oneof-field-link_type":"[\"dashboard_link\",\"generic_link\"]","x-ves-proto-message":"ves.io.schema.ai_assistant.common.Link","properties":{"dashboard_link":{"$ref":"#/components/schemas/commonDashboardLink"},"generic_link":{"$ref":"#/components/schemas/commonGenericLink"}}},"commonLogFilter":{"type":"object","description":"Log filter for filter query","title":"LogFilter","x-displayname":"Log Filter","x-ves-proto-message":"ves.io.schema.ai_assistant.common.LogFilter","properties":{"key":{"type":"string","description":" Key to be presented in the filter\n\nExample: ` \"attack_types.name\"`","title":"key","x-displayname":"Key","x-ves-example":"attack_types.name"},"op":{"$ref":"#/components/schemas/commonFilterOperator"},"values":{"type":"array","description":" Values to be presented in the filter\n\nExample: ` \"ATTACK_TYPE_CROSS_SITE_SCRIPTING\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"values","items":{"type":"string"},"x-displayname":"Values","x-ves-example":"ATTACK_TYPE_CROSS_SITE_SCRIPTING","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"commonOverlayContent":{"type":"object","description":"Overlay link for creating ticket","title":"Overlay Link","x-displayname":"Overlay Link","x-ves-proto-message":"ves.io.schema.ai_assistant.common.OverlayContent","properties":{"data":{"$ref":"#/components/schemas/commonOverlayData"},"title":{"type":"string","description":" Title for the link\n\nExample: ` \"Security Analytics lb1\"`","title":"title","x-displayname":"Title","x-ves-example":"Security Analytics lb1"},"type":{"$ref":"#/components/schemas/commonDashboardLinkType"}}},"commonOverlayData":{"type":"object","description":"Overlay data for creating support ticket","title":"Overlay Data","x-displayname":"Overlay Data","x-ves-proto-message":"ves.io.schema.ai_assistant.common.OverlayData","properties":{"priority":{"type":"string","description":" Priority for the support ticket\n\nExample: ` \"Normal\"`","title":"priority","x-displayname":"Priority","x-ves-example":"Normal"},"product_data":{"type":"string","description":" Product Data for the support ticket\n\nExample: ` \"Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down\"`","title":"product data","x-displayname":"Product Data","x-ves-example":"Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down"},"subject":{"type":"string","description":" Subject for the support ticket\n\nExample: ` \"Troubleshoot site\"`","title":"subject","x-displayname":"Subject","x-ves-example":"Troubleshoot site"},"support_type":{"type":"string","description":" Type for the support ticket\n\nExample: ` \"Technical Support\"`","title":"type","x-displayname":"Type","x-ves-example":"Technical Support"},"topic":{"type":"string","description":" Topic for the support ticket\n\nExample: ` \"Troubleshooting\"`","title":"topic","x-displayname":"Topic","x-ves-example":"Troubleshooting"},"workspace":{"type":"string","description":" Workspace for the support ticket\n\nExample: ` \"Multi-Cloud Network Connect\"`","title":"workspace","x-displayname":"Workspace","x-ves-example":"Multi-Cloud Network Connect"}}},"commonStatusStyle":{"type":"string","description":"Status Style defines the colour of status to be displayed.\n\n - STATUS_STYLE_UNKNOWN: Unknown\n\nNo colour\n - STATUS_STYLE_SUCCESS: success\n\ncolour type green\n - STATUS_STYLE_DANGER: danger\n\ncolour type red\n - STATUS_STYLE_WARNING: warning\n\ncolour type yellow\n - STATUS_STYLE_INACTIVE: inactive\n\ncolour type grey\n - STATUS_STYLE_MINOR: minor\n\ncolour type blue","title":"StatusStyle","enum":["STATUS_STYLE_UNKNOWN","STATUS_STYLE_SUCCESS","STATUS_STYLE_DANGER","STATUS_STYLE_WARNING","STATUS_STYLE_INACTIVE","STATUS_STYLE_MINOR"],"default":"STATUS_STYLE_UNKNOWN","x-displayname":"Status Style","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.StatusStyle"},"commonWidgetType":{"type":"string","description":"Widget Type defines the data type for widget.\n\n - WIDGET_TYPE_NONE: None\n\nNone type\n - TWO_VALUE: two_value\n\nTwo Value type widget\n - DISTRIBUTION_CHART: distribution_chart\n\nDistribution Chart type widget\n - TABLE: table\n\nTable type widget\n - LIST: list\n\nList type widget\n - GRID: grid\n\nGrid type widget\n - PIE: pie\n\npie type widget","title":"WidgetType","enum":["WIDGET_TYPE_NONE","TWO_VALUE","DISTRIBUTION_CHART","TABLE","LIST","GRID","PIE"],"default":"WIDGET_TYPE_NONE","x-displayname":"Widget Type","x-ves-proto-enum":"ves.io.schema.ai_assistant.common.WidgetType"},"explain_log_recordAccuracy":{"type":"string","description":"Specifies accuracy of the signature\n\n - ACCURACY_NONE: None\n\nNo accuracy\n - ACCURACY_LOW: Low\n\nSpecifies low accuracy of the signature\n - ACCURACY_MEDIUM: Medium\n\nSpecifies medium accuracy of the signature\n - ACCURACY_HIGH: High\n\nSpecifies high accuracy of the signature","title":"Accuracy","enum":["ACCURACY_NONE","ACCURACY_LOW","ACCURACY_MEDIUM","ACCURACY_HIGH"],"default":"ACCURACY_NONE","x-displayname":"Accuracy","x-ves-proto-enum":"ves.io.schema.ai_assistant.explain_log_record.Accuracy"},"explain_log_recordBot":{"type":"object","description":"Bot details","title":"Bot","x-displayname":"Bot","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.Bot","properties":{"classification":{"type":"string","description":" Bot classification\n\nExample: ` \"suspicious\"`","title":"classification","x-displayname":"Classification","x-ves-example":"suspicious"},"name":{"type":"string","description":" Bot name\n\nExample: ` \"curl\"`","title":"name","x-displayname":"Name","x-ves-example":"curl"},"type":{"type":"string","description":" Bot type\n\nExample: ` \"HTTP Library\"`","title":"name","x-displayname":"Type","x-ves-example":"HTTP Library"}}},"explain_log_recordBotDefenseEventDetails":{"type":"object","description":"Bot Defense security events details","title":"BotDefenseEventDetails","x-displayname":"Bot Defense Event Details","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.BotDefenseEventDetails","properties":{"action":{"$ref":"#/components/schemas/ai_assistantexplain_log_recordAction"},"automation_type":{"type":"string","description":" Bot automation type\n\nExample: ` \"Token Missing\"`","title":"automation_type","x-displayname":"Automation type","x-ves-example":"Token Missing"},"bot_type":{"type":"string","description":" Bot type\n\nExample: ` \"MALICIOUS\"`","title":"bot_type","x-displayname":"Bot type","x-ves-example":"MALICIOUS"},"method":{"type":"string","description":" Method of the request\n\nExample: ` \"GET\"`","title":"method","x-displayname":"Method","x-ves-example":"GET"},"request_path":{"type":"string","description":" Request path\n\nExample: ` \"/api/support/cases/case1\"`","title":"request_path","x-displayname":"Request Path","x-ves-example":"/api/support/cases/case1"}}},"explain_log_recordEnforcementMode":{"type":"string","description":"Enforcement mode of WAF\n\n - ENFORCEMENT_NONE: None\n\nNo enforcement\n - MONITORING: Monitoring\n\nMonitoring mode of waf\n - BLOCKING: Blocking\n\nBlocking mode of waf","title":"EnforcementMode","enum":["ENFORCEMENT_NONE","MONITORING","BLOCKING"],"default":"ENFORCEMENT_NONE","x-displayname":"Enforcement Mode","x-ves-proto-enum":"ves.io.schema.ai_assistant.explain_log_record.EnforcementMode"},"explain_log_recordExplainLogRecordResponse":{"type":"object","description":"Explain log response","title":"ExplainLogRecordResponse","x-displayname":"Explain Log Record Response","x-ves-oneof-field-details":"[\"bot_defense_event_details\",\"request_details\",\"svc_policy_event_details\",\"waf_event_details\"]","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.ExplainLogRecordResponse","properties":{"actions":{"type":"string","description":" Follow-up actions\n\nExample: ` \"If you think that this is a false positive you can create exclusion rule..\"`","title":"actions","x-displayname":"Actions","x-ves-example":"If you think that this is a false positive you can create exclusion rule.."},"analysis":{"type":"string","description":" Log analysis\n\nExample: ` \"The request was blocked because Null in request violation was detected\"`","title":"analysis","x-displayname":"Analysis","x-ves-example":"The request was blocked because Null in request violation was detected"},"bot_defense_event_details":{"$ref":"#/components/schemas/explain_log_recordBotDefenseEventDetails"},"request_details":{"$ref":"#/components/schemas/explain_log_recordRequestDetails"},"summary":{"type":"string","description":" Log summary\n\nExample: ` \"Request Id 12345 refers to a WAF security event for an HTTP request that was blocked\"`","title":"summary","x-displayname":"Summary","x-ves-example":"Request Id 12345 refers to a WAF security event for an HTTP request that was blocked"},"svc_policy_event_details":{"$ref":"#/components/schemas/explain_log_recordSvcPolicyEventDetails"},"waf_event_details":{"$ref":"#/components/schemas/explain_log_recordWAFEventDetails"}}},"explain_log_recordIPReputation":{"type":"string","description":"Specifies IP risk/trustworthiness\n\n - IP_REPUTATION_NONE: None\n\nNo IP reputation\n - IP_REPUTATION_LOW: Low\n\nSpecifies low IP risk/trustworthiness\n - IP_REPUTATION_HIGH: High\n\nSpecifies high IP risk/trustworthiness","title":"IPReputation","enum":["IP_REPUTATION_NONE","IP_REPUTATION_LOW","IP_REPUTATION_HIGH"],"default":"IP_REPUTATION_NONE","x-displayname":"IP Reputation","x-ves-proto-enum":"ves.io.schema.ai_assistant.explain_log_record.IPReputation"},"explain_log_recordRequestDetails":{"type":"object","description":"Request details","title":"RequestDetails","x-displayname":"Request Details","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.RequestDetails","properties":{"domain":{"type":"string","description":" domain\n\nExample: ` \"example.com\"`","title":"domain","x-displayname":"domain","x-ves-example":"example.com"},"rsp_code":{"type":"integer","description":" rsp_code\n\nExample: ` \"200\"`","title":"rsp_code","format":"int64","x-displayname":"Response Code","x-ves-example":"200"},"rsp_code_details":{"type":"string","description":" rsp_code_details\n\nExample: ` \"via upstream\"`","title":"rsp_code_details","x-displayname":"Response Code Details","x-ves-example":"via upstream"},"upstream_protocol_error_reason":{"type":"string","description":" upstream_protocol_error_reason\n\nExample: ` \"headers_count_exceeds_limit\"`","title":"upstream_protocol_error_reason","x-displayname":"Upstream Protocol Error Reason","x-ves-example":"headers_count_exceeds_limit"}}},"explain_log_recordSignature":{"type":"object","description":"Signature details","title":"Signature","x-displayname":"Signature","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.Signature","properties":{"accuracy":{"$ref":"#/components/schemas/explain_log_recordAccuracy"},"attack_type":{"type":"string","description":" Attack type of the signature\n\nExample: ` \"Command Execution\"`","title":"attack_type","x-displayname":"Attack Type","x-ves-example":"Command Execution"},"context":{"type":"string","description":" Context of the signature\n\nExample: ` \"parameter\"`","title":"context","x-displayname":"Context","x-ves-example":"parameter"},"id":{"type":"string","description":" Signature ID\n\nExample: ` \"200013569\"`","title":"id","x-displayname":"Signature ID","x-ves-example":"200013569"},"matching_info":{"type":"string","description":" Matching info\n\nExample: ` \"Matched 7 chars on offset 6 against valueToken\"`","title":"matching_info","x-displayname":"Matching Info","x-ves-example":"Matched 7 chars on offset 6 against value: Token"},"name":{"type":"string","description":" Signature name\n\nExample: ` \"shell command processor\"`","title":"name","x-displayname":"Name","x-ves-example":"shell command processor"},"state":{"type":"string","description":" State of the signature, can be enabled, suppressed and etc\n\nExample: ` \"Enabled\"`","title":"state","x-displayname":"State","x-ves-example":"Enabled"}}},"explain_log_recordSvcPolicyEventDetails":{"type":"object","description":"Service policy security events details","title":"SvcPolicyEventDetails","x-displayname":"Service Policy Event Details","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.SvcPolicyEventDetails","properties":{"action":{"$ref":"#/components/schemas/ai_assistantexplain_log_recordAction"},"ip_risk":{"$ref":"#/components/schemas/explain_log_recordIPReputation"},"ip_threat_categories":{"type":"array","description":" IP threat categories\n\nExample: ` \"SPAM_SOURCES,PHISHING\"`","title":"ip threat categories","items":{"$ref":"#/components/schemas/policyIPThreatCategory"},"x-displayname":"IP threat categories","x-ves-example":"SPAM_SOURCES,PHISHING"},"ip_trustworthiness":{"$ref":"#/components/schemas/explain_log_recordIPReputation"},"policy":{"type":"string","description":" Policy name\n\nExample: ` \"policy-1\"`","title":"policy","x-displayname":"Policy","x-ves-example":"policy-1"},"policy_namespace":{"type":"string","description":" Policy namespace\n\nExample: ` \"data-path\"`","title":"policy namespace","x-displayname":"Policy namespace","x-ves-example":"data-path"},"policy_rule":{"type":"string","description":" Policy rule name\n\nExample: ` \"policy-rule-1\"`","title":"policy rule","x-displayname":"Policy rule","x-ves-example":"policy-rule-1"}}},"explain_log_recordThreatCampaign":{"type":"object","description":"Threat campaign details","title":"ThreatCampaign","x-displayname":"Threat Campaign","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.ThreatCampaign","properties":{"attack_type":{"type":"string","description":" Attack type of threat campaign\n\nExample: ` \"Command Execution\"`","title":"attack_type","x-displayname":"Attack Type","x-ves-example":"Command Execution"},"id":{"type":"string","description":" ThreatCampaign ID\n\nExample: ` \"cmpe1ab3d4feddb3c691bc68201d253be66\"`","title":"id","x-displayname":"ThreatCampaign ID","x-ves-example":"cmpe1ab3d4feddb3c691bc68201d253be66"},"name":{"type":"string","description":" ThreatCampaign name\n\nExample: ` \"Nette Framework Remote Code Execution - oshi\"`","title":"name","x-displayname":"Name","x-ves-example":"Nette Framework Remote Code Execution - oshi"}}},"explain_log_recordViolation":{"type":"object","description":"Violation details","title":"Violation","x-displayname":"Violation","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.Violation","properties":{"attack_type":{"type":"string","description":" Attack type of the violation\n\nExample: ` \"Command Execution\"`","title":"attack_type","x-displayname":"Attack Type","x-ves-example":"Command Execution"},"context":{"type":"string","description":" Context of the violation\n\nExample: ` \"parameter\"`","title":"context","x-displayname":"Context","x-ves-example":"parameter"},"matching_info":{"type":"string","description":" Matching info\n\nExample: ` \"File extension was dat\"`","title":"matching_info","x-displayname":"Matching Info","x-ves-example":"File extension was dat"},"name":{"type":"string","description":" Violation name\n\nExample: ` \"Illegal filetype\"`","title":"name","x-displayname":"Name","x-ves-example":"Illegal filetype"},"state":{"type":"string","description":" State of the violation, can be enabled, suppressed and etc\n\nExample: ` \"Enabled\"`","title":"state","x-displayname":"State","x-ves-example":"Enabled"}}},"explain_log_recordWAFEventDetails":{"type":"object","description":"WAF security events details","title":"WAFEventDetails","x-displayname":"WAF Event Details","x-ves-proto-message":"ves.io.schema.ai_assistant.explain_log_record.WAFEventDetails","properties":{"action":{"$ref":"#/components/schemas/ai_assistantexplain_log_recordAction"},"app_firewall":{"type":"string","description":" App Firewall name\n\nExample: ` \"app-firewall\"`","title":"app_firewall","x-displayname":"App Firewall","x-ves-example":"app-firewall"},"bot":{"$ref":"#/components/schemas/explain_log_recordBot"},"enforcement_mode":{"$ref":"#/components/schemas/explain_log_recordEnforcementMode"},"signatures":{"type":"array","description":" The signatures that were detected in the request","title":"signatures","items":{"$ref":"#/components/schemas/explain_log_recordSignature"},"x-displayname":"Signatures"},"threat_campaigns":{"type":"array","description":" Threat campaigns that were detected in the request","title":"threat_campaigns","items":{"$ref":"#/components/schemas/explain_log_recordThreatCampaign"},"x-displayname":"Threat Campaign"},"violations":{"type":"array","description":" The violations that were detected in the request","title":"violations","items":{"$ref":"#/components/schemas/explain_log_recordViolation"},"x-displayname":"Violations"}}},"gen_dashboard_filterGenDashboardFilterResponse":{"type":"object","description":"Generate dashboard filter response","title":"GenDashboardFilterResponse","x-displayname":"Generate Dashboard Filter","x-ves-proto-message":"ves.io.schema.ai_assistant.gen_dashboard_filter.GenDashboardFilterResponse","properties":{"actions":{"type":"string","description":" Follow-up actions\n\nExample: ` \"To view these events go to the ${{link:dashboard_link}} page\"`","title":"actions","x-displayname":"Actions","x-ves-example":"To view these events go to the ${{link:dashboard_link}} page"},"links":{"type":"array","description":" Links that will be presented to the user","title":"links","items":{"$ref":"#/components/schemas/commonLink"},"x-displayname":"Links"},"summary":{"type":"string","description":" Events summary\n\nExample: ` \"135 events matching your query were found\"`","title":"summary","x-displayname":"Summary","x-ves-example":"135 events matching your query were found"}}},"listItem":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.list.Item","properties":{"link":{"$ref":"#/components/schemas/commonLink"}}},"listList":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.list.List","properties":{"item":{"type":"array","description":" List of item\n\nExample: ` \"Entries for each item\"`","title":"item","items":{"$ref":"#/components/schemas/listItem"},"x-displayname":"Item","x-ves-example":"Entries for each item"},"title":{"type":"string","description":"\n\nExample: ` \"Cloud Sites\"`","title":"Title","x-displayname":"Title","x-ves-example":"Cloud Sites"}}},"listListResponse":{"type":"object","description":"List response","title":"List Response","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.ai_assistant.list.ListResponse","properties":{"external_links":{"type":"array","description":" External doc links, that will be presented to the user\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 6\n","title":"external links","items":{"$ref":"#/components/schemas/commonLink"},"x-displayname":"External Links","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"6"}},"items":{"type":"array","description":" Response will have set of lists","title":"Items","items":{"$ref":"#/components/schemas/listList"},"x-displayname":"List View "},"summary":{"type":"string","description":"\n\nExample: ` \"This is summary of List response\"`","title":"summary","x-displayname":"Summary","x-ves-example":"This is summary of List response"}}},"policyIPThreatCategory":{"type":"string","description":"The IP threat categories to use when a policy based IP threat category is configured.\n\n - SPAM_SOURCES: SPAM_SOURCES\n\n - WINDOWS_EXPLOITS: WINDOWS_EXPLOITS\n\n - WEB_ATTACKS: WEB_ATTACKS\n\n - BOTNETS: BOTNETS\n\n - SCANNERS: SCANNERS\n\n - REPUTATION: REPUTATION\n\n - PHISHING: PHISHING\n\n - PROXY: PROXY\n\n - MOBILE_THREATS: MOBILE_THREATS\n\n - TOR_PROXY: TOR_PROXY\n\n - DENIAL_OF_SERVICE: DENIAL_OF_SERVICE\n\n - NETWORK: NETWORK\n","title":"IP Threat Category","enum":["SPAM_SOURCES","WINDOWS_EXPLOITS","WEB_ATTACKS","BOTNETS","SCANNERS","REPUTATION","PHISHING","PROXY","MOBILE_THREATS","TOR_PROXY","DENIAL_OF_SERVICE","NETWORK"],"default":"SPAM_SOURCES","x-displayname":"IP Threat Category","x-ves-proto-enum":"ves.io.schema.policy.IPThreatCategory"},"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"}}},"schemaEmpty":{"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"},"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"}}},"site_analysisSiteAnalysisResponse":{"type":"object","description":"Site analysis response","title":"Site Analysis Response","x-displayname":"Site Analysis Response","x-ves-proto-message":"ves.io.schema.ai_assistant.site_analysis.SiteAnalysisResponse","properties":{"external_links":{"type":"array","description":" External doc links, that will be presented to the user\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 6\n","title":"external links","items":{"$ref":"#/components/schemas/commonLink"},"x-displayname":"External Links","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"6"}},"internal_links":{"type":"array","description":" Internal Link like dashboard links, that will be presented to the user\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n  ves.io.schema.rules.string.max_len: 6\n","title":"internal links","items":{"$ref":"#/components/schemas/commonLink"},"x-displayname":"Internal Links","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true","ves.io.schema.rules.string.max_len":"6"}},"overlay_content":{"$ref":"#/components/schemas/commonOverlayContent"},"summary":{"type":"string","description":"\n\nExample: ` \"This site analysis response provides status of sites.\"`","title":"summary","x-displayname":"Summary","x-ves-example":"This site analysis response provides status of sites."},"table_view":{"$ref":"#/components/schemas/widgetWidgetView"}}},"widgetCell":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.widget.Cell","properties":{"link":{"$ref":"#/components/schemas/commonLink"},"properties":{"$ref":"#/components/schemas/commonCellProperties"},"value":{"type":"string","description":"\n\nExample: ` \"site1\"`","title":"Value","x-displayname":"value","x-ves-example":"site1"}}},"widgetRow":{"type":"object","description":"Contains the value for each rows of table","title":"Row","x-displayname":"Table Rows","x-ves-proto-message":"ves.io.schema.ai_assistant.widget.Row","properties":{"cells":{"type":"array","description":"\n\nExample: ` \"Site Name:\"site-1\"`","title":"Values","items":{"$ref":"#/components/schemas/widgetCell"},"x-displayname":"Values","x-ves-example":"Site Name:\"site-1"}}},"widgetTable":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.widget.Table","properties":{"field_properties":{"type":"array","description":" Lists the name of the field & corresponding properties\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Properties\nx-displayName: \"Field Properties\"\nLists the name of the field & corresponding properties","items":{"$ref":"#/components/schemas/commonFieldProperties"},"x-displayname":"Field Properties","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"rows":{"type":"array","description":" List of table rows\n\nExample: ` \"Entries for each rows\"`","title":"rows","items":{"$ref":"#/components/schemas/widgetRow"},"x-displayname":"Row","x-ves-example":"Entries for each rows"},"widget_type":{"$ref":"#/components/schemas/commonWidgetType"}}},"widgetWidgetResponse":{"type":"object","description":"Widget response","title":"Widget Response","x-displayname":"Widget Response","x-ves-proto-message":"ves.io.schema.ai_assistant.widget.WidgetResponse","properties":{"item_links":{"type":"array","description":" Links that will be presented to the user","title":"item_links","items":{"$ref":"#/components/schemas/commonLink"},"x-displayname":"Links"},"items":{"type":"array","description":" Response will have different types of widgets","title":"Items","items":{"$ref":"#/components/schemas/widgetWidgetView"},"x-displayname":"Widget View "},"summary":{"type":"string","description":"\n\nExample: ` \"This is summary of widget response\"`","title":"summary","x-displayname":"Summary","x-ves-example":"This is summary of widget response"}}},"widgetWidgetView":{"type":"object","x-ves-proto-message":"ves.io.schema.ai_assistant.widget.WidgetView","properties":{"item":{"$ref":"#/components/schemas/widgetTable"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0001.public.ves.io.schema.api_sec.api_crawler.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.api_sec.api_crawler","description":"This is the api crawler type","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/api_crawlers":{"post":{"summary":"Create API Crawler","operationId":"ves.io.schema.api_sec.api_crawler.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_crawlerCreateResponse"}}}},"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/api_crawlerCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-api_crawler-api-create"},"x-ves-proto-rpc":"ves.io.schema.api_sec.api_crawler.API.Create"},"x-displayname":"API Crawler","x-ves-proto-service":"ves.io.schema.api_sec.api_crawler.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/api_crawlers/{metadata.name}":{"put":{"summary":"Replace API crawler","operationId":"ves.io.schema.api_sec.api_crawler.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_crawlerReplaceResponse"}}}},"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/api_crawlerReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-api_crawler-api-replace"},"x-ves-proto-rpc":"ves.io.schema.api_sec.api_crawler.API.Replace"},"x-displayname":"API Crawler","x-ves-proto-service":"ves.io.schema.api_sec.api_crawler.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/api_crawlers":{"get":{"summary":"List API Crawler","description":"List the set of api_crawler in a namespace","operationId":"ves.io.schema.api_sec.api_crawler.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_crawlerListResponse"}}}},"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 api_crawler","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-api_sec-api_crawler-api-list"},"x-ves-proto-rpc":"ves.io.schema.api_sec.api_crawler.API.List"},"x-displayname":"API Crawler","x-ves-proto-service":"ves.io.schema.api_sec.api_crawler.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/api_crawlers/{name}":{"get":{"summary":"Get API crawler","operationId":"ves.io.schema.api_sec.api_crawler.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api_crawlerGetResponse"}}}},"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-api_sec-api_crawler-api-get"},"x-ves-proto-rpc":"ves.io.schema.api_sec.api_crawler.API.Get"},"delete":{"summary":"Delete API Crawler","description":"Delete the specified api_crawler","operationId":"ves.io.schema.api_sec.api_crawler.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/api_crawlerDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-api_crawler-api-delete"},"x-ves-proto-rpc":"ves.io.schema.api_sec.api_crawler.API.Delete"},"x-displayname":"API Crawler","x-ves-proto-service":"ves.io.schema.api_sec.api_crawler.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"API Crawler","x-ves-proto-package":"ves.io.schema.api_sec.api_crawler","components":{"schemas":{"api_crawlerApiCrawlingStatus":{"type":"object","description":"Contains status information for API crawling configuration","title":"API Crawling Status Type","x-displayname":"API Crawling Status","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ApiCrawlingStatus","properties":{"last_updated":{"type":"string","description":" Timestamp of the most recent change for the API Crawling configuration","title":"last_updated","format":"date-time","x-displayname":"Last Updated"}}},"api_crawlerCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of api_crawler","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/api_crawlerCreateSpecType"}}},"api_crawlerCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/api_crawlerGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"api_crawlerCreateSpecType":{"type":"object","title":"Create API Crawler","x-displayname":"Create API Crawler","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.CreateSpecType","properties":{"domains":{"type":"array","description":" API Crawler Configuration\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n","maxItems":32,"items":{"$ref":"#/components/schemas/api_crawlerDomainConfiguration"},"x-displayname":"API Crawler","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32"}}}},"api_crawlerDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a api_crawler","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.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"}}},"api_crawlerDomainConfiguration":{"type":"object","description":"The Domain configuration message","title":"Configured API Domains","x-displayname":"Domain Configuration","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.DomainConfiguration","properties":{"domain":{"type":"string","description":" Select the domain to execute API Crawling with given credentials.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n  ves.io.schema.rules.string.vh_domain: true\n","title":"Domain","maxLength":256,"x-displayname":"Domains to Crawl","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256","ves.io.schema.rules.string.vh_domain":"true"}},"simple_login":{"$ref":"#/components/schemas/api_crawlerSimpleLogin"}}},"api_crawlerGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read api_crawler","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/api_crawlerCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/api_crawlerReplaceRequest"},"spec":{"$ref":"#/components/schemas/api_crawlerGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/api_crawlerStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"api_crawlerGetResponseFormatCode":{"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"},"api_crawlerGetSpecType":{"type":"object","title":"Get API crawler","x-displayname":"Get API crawler","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.GetSpecType","properties":{"domains":{"type":"array","description":" API Crawler Configuration\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n","maxItems":32,"items":{"$ref":"#/components/schemas/api_crawlerDomainConfiguration"},"x-displayname":"API Crawler","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32"}}}},"api_crawlerListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of api_crawler","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.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/api_crawlerListResponseItem"},"x-displayname":"Items"}}},"api_crawlerListResponseItem":{"type":"object","description":"By default a summary of api_crawler 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 api_crawler","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this api_crawler","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this api_crawler","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates api_crawler is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/api_crawlerGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this api_crawler","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this api_crawler\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/api_crawlerStatusObject"},"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 api_crawler\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"api_crawlerReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a api_crawler","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/api_crawlerReplaceSpecType"}}},"api_crawlerReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ReplaceResponse"},"api_crawlerReplaceSpecType":{"type":"object","title":"Replace API Crawler","x-displayname":"Replace API crawler","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ReplaceSpecType","properties":{"domains":{"type":"array","description":" API Crawler Configuration\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n","maxItems":32,"items":{"$ref":"#/components/schemas/api_crawlerDomainConfiguration"},"x-displayname":"API Crawler","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32"}}}},"api_crawlerScanInfo":{"type":"object","description":"scanInfo represents the status and metadata of an API scan","title":"Scan Information","x-displayname":"Scan Information","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.ScanInfo","properties":{"added_to_queue":{"type":"string","description":" Timestamp when scan was added to the queue","title":"added_to_queue","format":"date-time","x-displayname":"Added To Queue"},"domain":{"type":"string","description":" The domain being scanned\n\nExample: ` \"example1.com\"`","title":"domain","x-displayname":"Domain","x-ves-example":"example1.com"},"endpoint_count":{"type":"integer","description":" The total count of unique API endpoints discovered during the crawling process\n\nExample: ` 42`","title":"Number of endpoints discovered","format":"int64","x-displayname":"Number of EndPoints"},"error":{"type":"string","description":" Error message if the scan encountered any issues\n\nExample: ` \"Authentication failed\"`","title":"error","x-displayname":"Error Message","x-ves-example":"Authentication failed"},"kafka_message_created_at":{"type":"string","description":" Timestamp when the message was created in Kafka","title":"kafka_message_created_at","format":"date-time","x-displayname":"Kafka Message Created At"},"last_status_update":{"type":"string","description":" Timestamp of the last status update","title":"last_status_update","format":"date-time","x-displayname":"Last Status Updated"},"status":{"$ref":"#/components/schemas/api_crawlerScanStatus"}}},"api_crawlerScanStatus":{"type":"string","description":"Represents the current status of an API crawling scan\n\nDefault unspecified status\nScan has successfully completed\nScan is currently in progress\nScan has been initiated and is beginning execution\nScan is queued and waiting to start\nScan encountered an error","title":"Scan Status","enum":["UNSPECIFIED","COMPLETED","RUNNING","STARTED","PENDING","ERROR"],"default":"UNSPECIFIED","x-displayname":"Scan Status","x-ves-proto-enum":"ves.io.schema.api_sec.api_crawler.ScanStatus"},"api_crawlerSimpleLogin":{"type":"object","title":"Simple Login","x-displayname":"Simple Login","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.SimpleLogin","properties":{"password":{"$ref":"#/components/schemas/schemaSecretType"},"user":{"type":"string","description":" Enter the username to assign credentials for the selected domain to crawl\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 64\n","title":"The custom domain user authentication","maxLength":64,"x-displayname":"User","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"64"}}}},"api_crawlerStatusObject":{"type":"object","title":"Most recently observed status of object","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.api_sec.api_crawler.StatusObject","properties":{"api_crawling_status":{"$ref":"#/components/schemas/api_crawlerApiCrawlingStatus"},"conditions":{"type":"array","description":" Conditions reported by various component of the system.","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions","x-ves-deprecated":"Unused"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"scans":{"type":"array","description":" List of current scanning status for all domains configured for API Crawling","title":"scans_status","items":{"$ref":"#/components/schemas/api_crawlerScanInfo"},"x-displayname":"Scans Status"}}},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"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"}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"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"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}}}}}