@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.voltshare","description":"F5XC VoltShare service serves APIs for users to securing the secrets to share it with each other.","version":""},"paths":{"/api/secret_management/namespaces/system/voltshare/decrypt_secret":{"post":{"summary":"DecryptSecret","description":"DecryptSecret API takes blinded encrypted secret and policy and responds with blinded decrypted secret if user is allowed by the policy","operationId":"ves.io.schema.voltshare.CustomAPI.DecryptSecret","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareDecryptSecretResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareDecryptSecretRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-customapi-decryptsecret"},"x-ves-proto-rpc":"ves.io.schema.voltshare.CustomAPI.DecryptSecret"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/system/voltshare/process_policy_information":{"post":{"summary":"ProcessPolicyInformation","description":"ProcessPolicyInformation API takes policy and secret name as input and returns a document containing .","operationId":"ves.io.schema.voltshare.CustomAPI.ProcessPolicyInformation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareProcessPolicyResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareProcessPolicyRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-customapi-processpolicyinformation"},"x-ves-proto-rpc":"ves.io.schema.voltshare.CustomAPI.ProcessPolicyInformation"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/{namespace}/voltshare/access_count":{"post":{"summary":"VoltShare Access Count Query","description":"Request to get number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT","operationId":"ves.io.schema.voltshare.MonitoringAPI.VoltShareAccessCountQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareVoltShareAccessCountResponse"}}}},"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: \"blogging-app-namespace-1\"\nnamespace is used to scope the security events for the given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareVoltShareAccessCountRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-monitoringapi-voltshareaccesscountquery"},"x-ves-proto-rpc":"ves.io.schema.voltshare.MonitoringAPI.VoltShareAccessCountQuery"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.MonitoringAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/{namespace}/voltshare/audit_logs":{"post":{"summary":"Audit Log Query","description":"Request to get voltshare audit logs that matches the criteria in request.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed.","operationId":"ves.io.schema.voltshare.MonitoringAPI.AuditLogQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"value\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-monitoringapi-auditlogquery"},"x-ves-proto-rpc":"ves.io.schema.voltshare.MonitoringAPI.AuditLogQuery"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.MonitoringAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/aggregation":{"post":{"summary":"Audit Log Aggregation Query","description":"Request to get summary/analytics data for the audit logs that matches the criteria in request.","operationId":"ves.io.schema.voltshare.MonitoringAPI.AuditLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogAggregationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"value\"\nfetch aggregation data scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-monitoringapi-auditlogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.voltshare.MonitoringAPI.AuditLogAggregationQuery"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.MonitoringAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/scroll":{"get":{"summary":"Audit Log Scroll Query","description":"The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"value\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-monitoringapi-auditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery"},"post":{"summary":"Audit Log Scroll Query","description":"The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"value\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/voltshareAuditLogScrollRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-voltshare-monitoringapi-auditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery"},"x-displayname":"F5XC VoltShare","x-ves-proto-service":"ves.io.schema.voltshare.MonitoringAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5XC VoltShare","x-ves-proto-package":"ves.io.schema.voltshare","components":{"schemas":{"logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregation"}}},"logAvgAggregationData":{"type":"object","description":"x-displayName: \"Avg Aggregation Data\"\nAverage Aggregation data","title":"AvgAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the average value of field","title":"value","format":"double"}}},"logCardinalityAggregationData":{"type":"object","description":"x-displayName: \"Cardinality Aggregation Data\"\nApproximate count of distinct values of the log field specified in the request.","title":"CardinalityAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of distinct values of a log field","title":"count","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate access logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket","title":"sub aggregation"}}},"logDateAggregationBucket":{"type":"object","description":"x-displayName: \"Date Aggregation Bucket\"\nDate histogram bucket containing the timestamp and the number of logs in that bucket.","title":"DateAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the date bucket","title":"sub aggregation"},"time":{"type":"string","description":"x-displayName: \"Time\"\nx-example: 1578710280000\n\nunix timestamp","title":"time","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregationData":{"type":"object","description":"x-displayName: \"Date Aggregation Data\"\nDate aggregation data","title":"DateAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing timestamp and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logDateAggregationBucket"}},"step":{"type":"string","description":"x-displayName: \"Step\"\nx-example: \"30m\"\nActual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logDateSubAggregation":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\nAggregate audit logs based on one of the sub aggregation types","title":"Date SubAggregation","properties":{"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregation"}}},"logDateSubAggregationData":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\n\nDate subaggregation data","title":"DateSubAggregationData","properties":{"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"}}},"logFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate audit logs based on the key fields in the log.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Aggregation Bucket\"\nField aggregation bucket containing field value and the number of logs.","title":"FieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"US\"","title":"key"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the field aggregation bucket","title":"sub aggregation"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Aggregation Data\"\nField Aggregation data","title":"FieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldAggregationBucket"}}}},"logFieldSubAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"}}},"logFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Field SubAggregation\"\nField subaggregation data","title":"FieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubAggregationBucket"}},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logFieldSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"}}},"logFieldSubFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Data\"\nField Aggregation data as Field Sub-aggregation","title":"FieldSubFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubFieldAggregationBucket"}}}},"logFilterAggregationData":{"type":"object","description":"x-displayName: \"Filter Aggregation Data\"\nFilter Aggregation Data","title":"FilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logFilterSubAggregationData":{"type":"object","description":"x-displayName: \"FilterSubAggregation\"\nFilter subaggregation data","title":"FilterSubAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFilterSubFieldAggregationBucket"}}}},"logFilterSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Filter Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FilterSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nFields that can be specified in the field aggregation.\n\n - ASN: x-displayName: \"ASN number\"\n - AUTHOR_TENANT: x-displayName: \"Author Tenant\"\n - BROWSER_TYPE: x-displayName: \"Browser Type\"\n - CITY: x-displayName: \"City\"\n - COUNTRY: x-displayName: \"Country\"\n - DEVICE_TYPE: x-displayName: \"Device Type\"\n - OPERATION: x-displayName: \"Operation\"\n - RESULT: x-displayName: \"Result\"\n - SECRET_NAME: x-displayName: \"Secret Name\"\n - SRC_IP: x-displayName: \"Source IP Address\"\n - USER: x-displayName: \"User\"","title":"Key Field","enum":["ASN","AUTHOR_TENANT","BROWSER_TYPE","CITY","COUNTRY","DEVICE_TYPE","OPERATION","RESULT","SECRET_NAME","SRC_IP","USER"],"default":"ASN"},"logLogAggregationData":{"type":"object","description":"x-displayName: \"Log Aggregation\"\nLog aggregation response data","title":"LogAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"date_aggregation":{"$ref":"#/components/schemas/logDateAggregationData"},"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logMaxAggregationData":{"type":"object","description":"x-displayName: \"Max Aggregation Data\"\nMax Aggregation data","title":"MaxAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the maximum value of field","title":"value","format":"double"}}},"logMetricsAggregationData":{"type":"object","description":"x-displayName: \"Metrics Aggregation\"\nMetrics aggregation data","title":"MetricsAggregationData","properties":{"percentile":{"$ref":"#/components/schemas/logPercentileAggregationData"}}},"logMinAggregationData":{"type":"object","description":"x-displayName: \"Min Aggregation Data\"\nMin Aggregation data","title":"MinAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the minimum value of field","title":"value","format":"double"}}},"logMultiFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Bucket\"\nMulti-Field aggregation bucket containing field values and the number of logs.","title":"MultiFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"keys":{"type":"object","description":"x-displayName: \"Keys\"\nKeys contain the name/value pair that identifies the unique combination of multiple key fields\nx-example: \"{\"SRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the multi field aggregation bucket","title":"sub aggregation"}}},"logMultiFieldAggregationData":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Data\"\nMulti-Field Aggregation data","title":"MultiFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logMultiFieldAggregationBucket"}}}},"logMultiFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Multi Field SubAggregation\"\nField subaggregation data","title":"MultiFieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"top_hits_aggregation":{"$ref":"#/components/schemas/logTopHitsAggregationData"}}},"logMultiFilterAggregationData":{"type":"object","description":"x-displayName: \"Multi Filter Aggregation Data\"\nMulti Filter Aggregation data","title":"MultiFilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"}}},"logOrderByData":{"type":"object","description":"x-displayName: \"Order by Data\"\nOrder by data","title":"OrderByData","properties":{"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"}}},"logPercentileAggregationData":{"type":"object","description":"x-displayName: \"Percentile Aggregation Data\"\nPercentile Aggregation data","title":"PercentileAggregationData","properties":{"key":{"type":"number","description":"x-displayName: \"Key\"\nx-example: 99.0","title":"key","format":"double"},"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the key percent","title":"value","format":"double"}}},"logTopHitsAggregationData":{"type":"object","description":"x-displayName: \"TopHits Aggregation Data\"\nTop Hits Aggregation Data.","title":"TopHitsAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of top hit values","title":"count","format":"uint64"},"documents":{"type":"array","description":"x-displayName: \"Documents\"\ndocument values","title":"documents","items":{"type":"string"}}}},"metricsVoltShareAccessCounter":{"type":"object","description":"VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.","title":"VoltShare Access Counter","x-displayname":"VoltShare Access Counter","x-ves-proto-message":"ves.io.schema.voltshare.metrics.VoltShareAccessCounter","properties":{"id":{"$ref":"#/components/schemas/metricsVoltShareAccessId"},"metric":{"type":"array","description":" List of metric values","title":"Metric Values","items":{"$ref":"#/components/schemas/metricsVoltShareMetricValue"},"x-displayname":"Metric Values"}}},"metricsVoltShareAccessId":{"type":"object","description":"VoltShareAccessId uniquely identifies an entry in the response.\nVoltShare access count is aggregated based on the MetricLabel specified in the group_by field in the request.\nTherefore, only the fields that corresponds to the MetricLabel in the group_by will have non-empty\nvalue in the response.","title":"VoltShareAccessId","x-displayname":"VoltShare Access Id","x-ves-proto-message":"ves.io.schema.voltshare.metrics.VoltShareAccessId","properties":{"country":{"type":"string","description":" Country from where the API call was made\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"operation":{"type":"string","description":" Encrypt/Decrypt operation\n\nExample: ` \"Encrypt\"`","title":"Operation","x-displayname":"Operation","x-ves-example":"Encrypt"},"result":{"type":"string","description":" Result of the VoltShare operation\n\nExample: ` \"Success\"`","title":"Result","x-displayname":"Result","x-ves-example":"Success"},"user_tenant":{"type":"string","description":" Tenant that made the VoltShare API call\n\nExample: ` \"customer1\"`","title":"User Tenant","x-displayname":"User Tenant","x-ves-example":"customer1"}}},"metricsVoltShareMetricLabel":{"type":"string","description":"VoltShare Access metric can be sliced and diced based\non one or more labels listed below.\n","title":"MetricLabel","enum":["OPERATION","RESULT","USER_TENANT","COUNTRY"],"default":"OPERATION","x-displayname":"VoltShare Access Metric Labels","x-ves-proto-enum":"ves.io.schema.voltshare.metrics.VoltShareMetricLabel"},"metricsVoltShareMetricLabelFilter":{"type":"object","description":"VoltShare Access metric is tagged with labels mentioned in MetricLabel.\nMetric label filter can be specified to query/aggregate specific timeseries based on label match","title":"MetricLabelFilter","x-displayname":"VoltShare Access Metric Label Filter","x-ves-proto-message":"ves.io.schema.voltshare.metrics.VoltShareMetricLabelFilter","properties":{"label":{"$ref":"#/components/schemas/metricsVoltShareMetricLabel"},"op":{"$ref":"#/components/schemas/metricsVoltShareMetricLabelOp"},"value":{"type":"string","description":" Value to be compared with\n\nExample: ` \"ENCRYPT\"`","title":"Value","x-displayname":"Value","x-ves-example":"ENCRYPT"}}},"metricsVoltShareMetricLabelOp":{"type":"string","description":"The operator to use when querying VoltShare Access metrics with labels.\n","title":"MetricLabelOp","enum":["EQ","NEQ"],"default":"EQ","x-displayname":"VoltShare Access Metric Label Operator","x-ves-proto-enum":"ves.io.schema.voltshare.metrics.VoltShareMetricLabelOp"},"metricsVoltShareMetricValue":{"type":"object","description":"Value returned for a VoltShare Access Metrics query","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.voltshare.metrics.VoltShareMetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"value":{"type":"string","description":" number of accesses\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"schemaSortOrder":{"type":"string","description":"Sort algorithm\n\nSort in descending order\nSort in ascending order","title":"SortOrder","enum":["DESCENDING","ASCENDING"],"default":"DESCENDING","x-displayname":"Sort Order","x-ves-proto-enum":"ves.io.schema.SortOrder"},"schemaTrendSentiment":{"type":"string","description":"x-displayName: \"Trend Sentiment\"\ntrend sentiment\n\n - TREND_SENTIMENT_NONE: x-displayName: \"None\"\n - TREND_SENTIMENT_POSITIVE: x-displayName: \"Positive\"\nIndicates trend sentiment is positive\n - TREND_SENTIMENT_NEGATIVE: x-displayName: \"Negative\"\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE"},"schemaTrendValue":{"type":"object","description":"x-displayName: \"Trend Value\"\nTrend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","properties":{"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"\ndescription of the method used to calculate trend.","title":"Description"},"previous_value":{"type":"string","description":"x-displayName: \"Previous Value\"\nx-example: \"200.00\"","title":"Previous Value"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"x-displayName: \"Value\"\nx-example: \"-15\"","title":"Value"}}},"voltshareAuditLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for audit logs","title":"AuditLogAggregationRequest","x-displayname":"Audit Log Aggregation Request","x-ves-proto-message":"ves.io.schema.voltshare.AuditLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" fetch aggregation data scoped by namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user - user name\n   src_ip - source ip address\n   secret_name - secret name\n   author_tenant - tenant name of the secret creator\n   operation - Encrypt/Decrypt\n   result - Success/Fail\n   country - Country name\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\n Optional: If not specified, all the audit logs matching the given tenant will be considered for aggregation\n\nExample: ` \"{user=\\\"abc@xyz.com\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc@xyz.com\\\"}"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"voltshareAuditLogAggregationResponse":{"type":"object","description":"Response message for AuditLogAggregationRequest","title":"AuditLogAggregationResponse","x-displayname":"Audit Log Aggregation Response","x-ves-proto-message":"ves.io.schema.voltshare.AuditLogAggregationResponse","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregation data is keyed with the aggregation name specified in the request.","title":"aggregations","x-displayname":"Aggregations"},"total_hits":{"type":"string","description":" total number of log messages that matched the query.\n\nExample: ` \"0\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"0"}}},"voltshareAuditLogRequest":{"type":"object","description":"Request to fetch voltshare audit logs","title":"AuditLogRequest","x-displayname":"Audit Log Request","x-ves-proto-message":"ves.io.schema.voltshare.AuditLogRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"0\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"0"},"namespace":{"type":"string","description":" fetch the log messages scoped by namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user - user name\n   src_ip - source ip address\n   secret_name - secret name\n   author_tenant - tenant name of the secret creator\n   operation - Encrypt/Decrypt\n   result - Success/Fail\n   country - Country name\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n\n Optional: If not specified, all the audit logs matching the given tenant will be returned.\n\nExample: ` \"{user=\\\"abc@xyz.com\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc@xyz.com\\\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\n format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"voltshareAuditLogResponse":{"type":"object","description":"Response message for AuditLogRequest/LogScrollRequest","title":"AuditLogResponse","x-displayname":"Audit Log Response","x-ves-proto-message":"ves.io.schema.voltshare.AuditLogResponse","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregation data is keyed with the aggregation name specified in the request.","title":"aggregations","x-displayname":"Aggregations"},"logs":{"type":"array","description":" list of log messages that matched the query. Not all log messages that matched the query are returned in the response.\n\nExample: ` \"value\"`","title":"logs","items":{"type":"string"},"x-displayname":"Logs","x-ves-example":"value"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\n Empty scroll_id indicates no more messages to scroll (EOF).\n Note: scroll_id is valid only for 2 minutes. i.e., If one intend to retrieve next batch of the result, then the\n       scroll request should be sent within 2 minutes upon receiving the AuditLogResponse.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="},"total_hits":{"type":"string","description":" total number of log messages that matched the query.\n\nExample: ` \"0\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"0"}}},"voltshareAuditLogScrollRequest":{"type":"object","description":"Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse\ncontaining no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or\nall log messages, one can use the LogScrollRequest. Use the scroll_id returned in the LogResponse to fetch the next\nbatch of log messages and one can continue this process till the scroll_id returned in the LogResponse is \"\" which\nindicates no more log messages to scroll.","title":"AuditLogScrollRequest","x-displayname":"Audit Log Scroll Request","x-ves-proto-message":"ves.io.schema.voltshare.AuditLogScrollRequest","properties":{"namespace":{"type":"string","description":" fetch the log messages scoped by namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of log messages.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="}}},"voltshareDecryptSecretRequest":{"type":"object","description":"DecryptSecretRequest contains parameters for DecryptSecret API","title":"DecryptSecret Request","x-displayname":"DecryptSecret Request","x-ves-proto-message":"ves.io.schema.voltshare.DecryptSecretRequest","properties":{"blinded_encrypted_key_base64":{"type":"string","description":" Blinded Encrypted Key in base64 format\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"blinded_encrypted_key","x-displayname":"Blinded Encrypted Key","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"policy_document":{"$ref":"#/components/schemas/voltsharePolicyInformationType"},"policy_document_hmac_base64":{"type":"string","description":" Base64 encoded HMAC of the policy document\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"policy_document_hmac","x-displayname":"Policy Document HMAC","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"voltshareDecryptSecretResponse":{"type":"object","description":"DecryptSecretResponse contains the response of DecryptSecret API","title":"DecryptSecret Response","x-displayname":"DecryptSecret Response","x-ves-proto-message":"ves.io.schema.voltshare.DecryptSecretResponse","properties":{"blinded_key_base64":{"type":"string","description":" Blinded Key in base64 format\n\nExample: ` \"value\"`","title":"blinded_key","x-displayname":"Blinded Key","x-ves-example":"value"}}},"voltsharePolicyInformationType":{"type":"object","description":"PolicyInformation contains user defined policy and metadata added by the backend server.","title":"Policy Information","x-displayname":"Policy Information","x-ves-proto-message":"ves.io.schema.voltshare.PolicyInformationType","properties":{"author":{"$ref":"#/components/schemas/voltshareUserRecordType"},"blindfold_key_version":{"type":"integer","description":" Version of BlindfoldKey that will be used for encryption\n\nExample: ` \"0\"`","title":"blindfold_key_version","format":"int64","x-displayname":"Blindfold KeyVersion","x-ves-example":"0"},"creation_time":{"type":"string","description":" Creation time for this policy document","title":"creation_time","format":"date-time","x-displayname":"Creation Time"},"policy":{"$ref":"#/components/schemas/voltsharePolicyType"},"policy_id":{"type":"string","description":" A unique 31 bit number assigned to this policy.\n\nExample: ` \"0\"`","title":"policy_id","format":"uint64","x-displayname":"PolicyID","x-ves-example":"0"},"secret_name":{"type":"string","description":" Name of the secret\n\nExample: ` \"value\"`","title":"secret_name","x-displayname":"Secret Name","x-ves-example":"value"}}},"voltsharePolicyType":{"type":"object","description":"Policy contains user defined policy. It contains list of allowed users and expiry time","title":"Policy","x-displayname":"Policy","x-ves-proto-message":"ves.io.schema.voltshare.PolicyType","properties":{"allowed_users":{"type":"array","description":" List of Users allowed to decrypt the secret\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 256\n","title":"allowed_users","maxItems":256,"items":{"$ref":"#/components/schemas/voltshareUserRecordType"},"x-displayname":"Allowed Users","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"256"}},"expiration_timestamp":{"type":"string","description":" Until when this policy is valid. After expiration only author can decrypt the secret.","title":"expiration_timestamp","format":"date-time","x-displayname":"Expiration Time"}}},"voltshareProcessPolicyRequest":{"type":"object","description":"ProcessPolicyRequest contains parameters ProcessPolicyInformation API","title":"ProcessPolicyRequest","x-displayname":"ProcessPolicy Request","x-ves-proto-message":"ves.io.schema.voltshare.ProcessPolicyRequest","properties":{"policy":{"$ref":"#/components/schemas/voltsharePolicyType"},"secret_name":{"type":"string","description":" Name of the secret\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"secret_name","minLength":1,"maxLength":256,"x-displayname":"Secret Name","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}}}},"voltshareProcessPolicyResponse":{"type":"object","description":"Response of the ProcessPolicyInformation API. It contains Processed Policy, HMAC of the policy and PublicKey to be used for encryption","title":"ProcessPolicyResponse","x-displayname":"ProcessPolicy Response","x-ves-proto-message":"ves.io.schema.voltshare.ProcessPolicyResponse","properties":{"policy_document":{"$ref":"#/components/schemas/voltsharePolicyInformationType"},"policy_document_hmac_base64":{"type":"string","description":" Base64 encoded HMAC of the policy document\n\nExample: ` \"value\"`","title":"policy_document_hmac","x-displayname":"Policy Document HMAC","x-ves-example":"value"},"public_key":{"type":"string","description":" PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key. Private part of this key is ONLY with F5XC Secret Management service.\n Value of this field is a base64 string. When decoded, it unmarshal to PublicKeyDocumentType structure.\n\nExample: ` \"value\"`","title":"Public Key Document","x-displayname":"Public Key Document","x-ves-example":"value"}}},"voltshareUserRecordType":{"type":"object","description":"UserRecordType contains information about a user","title":"User Record","x-displayname":"User Record","x-ves-proto-message":"ves.io.schema.voltshare.UserRecordType","properties":{"email":{"type":"string","description":" email id of the user\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.email: true\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"email","minLength":1,"maxLength":256,"x-displayname":"Email","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.email":"true","ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}},"tenant":{"type":"string","description":" Tenant of the user\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 256\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"tenant","minLength":1,"maxLength":256,"x-displayname":"Tenant","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"256","ves.io.schema.rules.string.min_bytes":"1"}}}},"voltshareVoltShareAccessCountRequest":{"type":"object","description":"Request to get number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT","title":"VoltShareAccessCountRequest","x-displayname":"VoltShare Access Count Request","x-ves-proto-message":"ves.io.schema.voltshare.VoltShareAccessCountRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570007981\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570007981","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"group_by":{"type":"array","description":" Aggregate data by one or more labels listed here.\n OPERATION, RESULT, USER_TENANT, COUNTRY.\n\n Optional: If not specified, then the metric is aggregated across all the labels","title":"Group by","items":{"$ref":"#/components/schemas/metricsVoltShareMetricLabel"},"x-displayname":"Group By"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label\" Op \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n One or more of the following labels can be specified in the label_filter.\n OPERATION, RESULT, USER_TENANT, COUNTRY.\n\n Optional: If not specified, then the metrics will be filtered only based on the namespace in the request.","title":"Label Filter","items":{"$ref":"#/components/schemas/metricsVoltShareMetricLabelFilter"},"x-displayname":"Label Filter"},"namespace":{"type":"string","description":" namespace is used to scope the security events for the given namespace.\n\nExample: ` \"blogging-app-namespace-1\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"blogging-app-namespace-1"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570007981\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570007981","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"15m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"15m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"voltshareVoltShareAccessCountResponse":{"type":"object","description":"VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.","title":"VoltShareAccessCountResponse","x-displayname":"VoltShare Access Count Response","x-ves-proto-message":"ves.io.schema.voltshare.VoltShareAccessCountResponse","properties":{"data":{"type":"array","description":" List of VoltShare Access count data for each unique combination of group_by labels","title":"Security events counter data","items":{"$ref":"#/components/schemas/metricsVoltShareAccessCounter"},"x-displayname":"VoltShare Access Count"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.maintenance_status","version":""},"paths":{"/api/data/namespaces/system/upgrade_status":{"get":{"summary":"Upgrade Status","description":"Request to get the upgrade status","operationId":"ves.io.schema.maintenance_status.CustomAPI.GetUpgradeStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/maintenance_statusGetUpgradeStatusResponse"}}}},"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-maintenance_status-customapi-getupgradestatus"},"x-ves-proto-rpc":"ves.io.schema.maintenance_status.CustomAPI.GetUpgradeStatus"},"x-displayname":"F5xC Upgrade Status","x-ves-proto-service":"ves.io.schema.maintenance_status.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"F5xC Upgrade Status","x-ves-proto-package":"ves.io.schema.maintenance_status","components":{"schemas":{"maintenance_statusGetUpgradeStatusResponse":{"type":"object","description":"Response message for Upgrade Status Request.\nResponse contain different states in upgrade process.","title":"Upgrade Status Response","x-displayname":"Upgrade Status Response","x-ves-oneof-field-upgrade_state":"[\"upgrade_in_progress\",\"upgrade_in_progress_with_config_downtime\",\"upgrade_not_in_progress\"]","x-ves-proto-message":"ves.io.schema.maintenance_status.GetUpgradeStatusResponse","properties":{"upgrade_in_progress":{"$ref":"#/components/schemas/schemaEmpty"},"upgrade_in_progress_with_config_downtime":{"$ref":"#/components/schemas/schemaEmpty"},"upgrade_not_in_progress":{"$ref":"#/components/schemas/schemaEmpty"}}},"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"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.fast_acl","description":"Fast ACL provides destination and specifies rules to protect the site from denial of service attacks.\n  - It is specified in terms of five tuple of the packet {destination ip, destination port, source ip, source port, protocol}.\n  - Fast ACL provides destination IP and port with protocol while Fast ACL rules in ACL provide source IP, port and action\n  - Destination is always provided as a combination of destination IP and port\n\nTypical Usecase(s) are:\n  - Rate-limiting traffic to destination\n  - Accepting traffic from certain source IPs to destination\n  - Ratelimiting or dropping traffic from source IPs to destination\n\nThese ACL rules are applied at very early stage in datapath ingress processing and form\nfirst line of defence against attack. These rules are evaluated for each packet coming in to the system (ingress),\nunlike session based ACL where action is calculated only on first packet in session.\n\nFast ACL picks source based on Longest prefix match for faster processing, which differs\nfrom traditional ACL where rules are evaluated in order. If none of the rule matches\nthen default action is to forward the packet\n\nFast ACL on a customer edge(CE) Site\n\nFast ACL is selected from Fast ACL set on CE Site based on Fleet Configuration. Fast ACL set matching following condition are applied on a CE site\n- Fast ACL set to which this Fast ACL belong is referred to by a Network Firewall\n- Network Firewall is referred to by a Fleet\n- CE site is member of the Fleet\n- Only tenant can configure the set\n- Network type supported are Site Local and Site Local Inside. Any other network type is not valid on CE\n\nSelection of Destination\n- Tenant can choose VIP(s) or interface IP(configured as VIP) via Fast ACL\n\n Fast ACL on RE\n\n- Fast ACL is picked from RE Fast ACL sets and can be defined by tenants for the public VIP(s)\n- Network type supported for RE is Public. Sets with Fast ACL with any other network type will be rejected\n\nSelection of public VIP destination\n- tenant ACL can pick VIP corresponding to tenant only\nSelection of shared VIP destination\n- tenant CANNOT use this option on RE.\nCustom prefixes destination\n- tenant CANNOT use this option on RE.\nShared VIP services\n- tenant CANNOT use this option, is only meant for volterra administrators\n\n Default Protocol Policer\n\n- Is valid on CE and RE and configurable by any tenant\n- Used for rate limiting\n- Applied when none of the source rules match\n- Protocols supported are ICMP, TCP, UDP, DNS","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/fast_acls":{"post":{"summary":"Create Fast ACL","description":"Create a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`","operationId":"ves.io.schema.fast_acl.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclCreateResponse"}}}},"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/fast_aclCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-fast_acl-api-create"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.API.Create"},"x-displayname":"Fast ACL","x-ves-proto-service":"ves.io.schema.fast_acl.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/fast_acls/{metadata.name}":{"put":{"summary":"Replace Fast ACL","description":"Replace a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`","operationId":"ves.io.schema.fast_acl.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclReplaceResponse"}}}},"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/fast_aclReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-fast_acl-api-replace"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.API.Replace"},"x-displayname":"Fast ACL","x-ves-proto-service":"ves.io.schema.fast_acl.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/data/namespaces/{namespace}/fast_acl/hits":{"post":{"summary":"Fast ACL Hits","description":"Get the counter for Fast ACL hits for a given namespace.","operationId":"ves.io.schema.fast_acl.CustomDataAPI.FastACLHits","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclFastACLHitsResponse"}}}},"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 is used to scope Fast ACL hits for the given namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclFastACLHitsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-fast_acl-customdataapi-fastaclhits"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.CustomDataAPI.FastACLHits"},"x-displayname":"Fast ACL","x-ves-proto-service":"ves.io.schema.fast_acl.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/fast_acls":{"get":{"summary":"List Fast ACL","description":"List the set of fast_acl in a namespace","operationId":"ves.io.schema.fast_acl.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclListResponse"}}}},"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 fast_acl","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-fast_acl-api-list"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.API.List"},"x-displayname":"Fast ACL","x-ves-proto-service":"ves.io.schema.fast_acl.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/fast_acls/{name}":{"get":{"summary":"Get Fast ACL","description":"Get value of `fast_acl` for object","operationId":"ves.io.schema.fast_acl.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/fast_aclGetResponse"}}}},"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-fast_acl-api-get"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.API.Get"},"delete":{"summary":"Delete Fast ACL","description":"Delete the specified fast_acl","operationId":"ves.io.schema.fast_acl.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/fast_aclDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-fast_acl-api-delete"},"x-ves-proto-rpc":"ves.io.schema.fast_acl.API.Delete"},"x-displayname":"Fast ACL","x-ves-proto-service":"ves.io.schema.fast_acl.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Fast ACL","x-ves-proto-package":"ves.io.schema.fast_acl","components":{"schemas":{"fast_aclCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of fast_acl","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.fast_acl.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemafast_aclCreateSpecType"}}},"fast_aclCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.fast_acl.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemafast_aclGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"fast_aclDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a fast_acl","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.fast_acl.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"}}},"fast_aclDestinationIPAddressType":{"type":"object","description":"x-displayName: \"Destination IP Address Type\"\nSpecifies destination as list of ip addresses and ports\nDestinationIPAddressType is applied only for DestinationType - IP Address option","title":"Destination IP Address Specification Type","properties":{"address":{"type":"array","description":"x-displayName: \"IP Address\"\nList of IP addresses to match with destination","title":"IP Address","items":{"$ref":"#/components/schemas/schemaIpAddressType"}},"ports":{"type":"array","description":"x-displayName: \"Ports\"\nx-example: 100\nx-required\nList of ports to match with destination ports\nSpecial value \"0\" means all valid ports on the VIPs","title":"Ports","items":{"$ref":"#/components/schemas/schemaPortValueType"}},"protocol":{"type":"string","description":"x-displayName: \"Protocol\"\nx-example: \"TCP\"\nProtocol to match in the traffic","title":"protocol"}}},"fast_aclDestinationType":{"type":"object","description":"x-displayName: \"Destination Type\"\nType of destination configuration. It will provide destination IP, port and protocol\n\"ves-io\" tenant has the option of choosing all type of destination type\nAny other tenant can choose destination as interface_services, vip_services or all_services\nFurther details on each destination type on RE and CE is provided in destination options\n\nDestination protocol and port for VIP or interface services is picked from configured listener","title":"Destination type","properties":{"all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"destination_ip_address":{"$ref":"#/components/schemas/fast_aclDestinationIPAddressType"},"interface_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"selected_vip_address":{"$ref":"#/components/schemas/fast_aclSelectedVIPAddressType"},"shared_vip_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"vhost":{"$ref":"#/components/schemas/ioschemaEmpty"},"vip_services":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"fast_aclFastACLHits":{"type":"object","description":"FastACLHits contains the timeseries data of Fast ACL hits","title":"Fast ACL Hits","x-displayname":"Fast ACL Hits","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLHits","properties":{"id":{"$ref":"#/components/schemas/fast_aclFastACLHitsId"},"metric":{"type":"array","description":" x-unit: \"count\"\n List of metric values","title":"Metric","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Metric"}}},"fast_aclFastACLHitsId":{"type":"object","description":"FastACLHitsId uniquely identifies an entry in the response to Fast ACL hits request.\nFast ACL hits counter is aggregated based on the labels specified in the group_by field in the request.\nTherefore, only the feields that corresponds to the MetricLabel in the group_by field will have non-empty\nvalue in the response.","title":"Fast ACL Hits ID","x-displayname":"Fast ACL Hits ID","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLHitsId","properties":{"fast_acl":{"type":"string","description":" Fast ACL name\n\nExample: ` \"facl-1\"`","title":"Fast ACL","x-displayname":"Fast ACL","x-ves-example":"facl-1"},"fast_acl_rule":{"type":"string","description":" Fast ACL Rule name\n\nExample: ` \"rule1\"`","title":"Fast ACL Rule","x-displayname":"Fast ACL Rule","x-ves-example":"rule1"},"namespace":{"type":"string","description":" Namespace in which the policy rule was hit\n\nExample: ` \"ns1\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"site":{"type":"string","description":" Site name\n\nExample: ` \"ce1\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce1"}}},"fast_aclFastACLHitsRequest":{"type":"object","description":"Request to get the Fast ACL hits counter.","title":"Fast ACL Hits Request","x-displayname":"Fast ACL Hits Request","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLHitsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570007981\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570007981","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"group_by":{"type":"array","description":" Aggregate data by one of more labels specified in `group_by`.\n\n Optional: If not specified, then the rule hits are aggregated/grouped by `FAST_ACL`.","title":"Group by","items":{"$ref":"#/components/schemas/fast_aclFastACLMetricLabel"},"x-displayname":"Group By"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label\" `Op` \"value\".\n Response will only contain data that matches all the conditions specified in the `label_filter`.\n\n Optional: If not specified, then the metrics will be filtered only based on the `namespace` in the request.","title":"Label Filter","items":{"$ref":"#/components/schemas/fast_aclFastACLMetricLabelFilter"},"x-displayname":"Label Filter"},"namespace":{"type":"string","description":" Namespace is used to scope Fast ACL hits for the given namespace.\n\nExample: ` \"ns1\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570007981\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570007981","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"fast_aclFastACLHitsResponse":{"type":"object","description":"Number of Fast ACL rule hits for each unique combination of group_by labels in the request.","title":"Fast ACL Hits Response","x-displayname":"Fast ACL Hits Response","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLHitsResponse","properties":{"data":{"type":"array","description":" List of Fast ACL hits data","title":"Fast ACL Hits","items":{"$ref":"#/components/schemas/fast_aclFastACLHits"},"x-displayname":"Fast ACL Hits"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"fast_aclFastACLMetricLabel":{"type":"string","description":"Fast ACL hits can be sliced and diced based on one or more labels listed below.\n","title":"Fast ACL Metric Labels","enum":["NAMESPACE","FAST_ACL","FAST_ACL_RULE","SITE"],"default":"NAMESPACE","x-displayname":"Fast ACL Metric Labels","x-ves-proto-enum":"ves.io.schema.fast_acl.FastACLMetricLabel"},"fast_aclFastACLMetricLabelFilter":{"type":"object","description":"Label filter can be specified to filter metrics based on label match","title":"Fast ACL Metric Label Filter","x-displayname":"Fast ACL Metric Label Filter","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLMetricLabelFilter","properties":{"label":{"$ref":"#/components/schemas/fast_aclFastACLMetricLabel"},"op":{"$ref":"#/components/schemas/schemaMetricLabelOp"},"value":{"type":"string","description":" Value to be compared with\n\nExample: ` \"policy1\"`","title":"Value","x-displayname":"Value","x-ves-example":"policy1"}}},"fast_aclFastACLRuleType":{"type":"object","description":"Shape of `fast_acl_rule`","title":"Fast ACL Rule","x-displayname":"Fast ACL Rule","x-ves-oneof-field-source":"[\"ip_prefix_set\",\"prefix\"]","x-ves-proto-message":"ves.io.schema.fast_acl.FastACLRuleType","properties":{"action":{"$ref":"#/components/schemas/fast_acl_ruleFastAclRuleAction"},"ip_prefix_set":{"$ref":"#/components/schemas/schemaIpPrefixSetRefType"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"port":{"type":"array","description":" L4 port numbers to match\n\nExample: ` ALL / DNS / 1234`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n","title":"ports","maxItems":128,"items":{"$ref":"#/components/schemas/schemaPortValueType"},"x-displayname":"Source Ports","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128"}},"prefix":{"$ref":"#/components/schemas/schemaPrefixListType"}}},"fast_aclGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read fast_acl","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.fast_acl.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/fast_aclCreateRequest"},"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/fast_aclReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemafast_aclGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/fast_aclStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"fast_aclGetResponseFormatCode":{"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"},"fast_aclLegacyACLType":{"type":"object","description":"x-displayName: \"Fast ACL Legacy Mode\"\nFast ACL definition for Site","title":"Fast ACL Legacy mode","properties":{"destination_type":{"$ref":"#/components/schemas/fast_aclDestinationType"},"network_type":{"$ref":"#/components/schemas/schemaVirtualNetworkSelectorType"},"source_rules":{"type":"array","description":"x-displayName: \"Source Rules\"\nList of Fast ACL rules to be applied to received packets on this site","title":"Source Rules","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}}},"fast_aclListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of fast_acl","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.fast_acl.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/fast_aclListResponseItem"},"x-displayname":"Items"}}},"fast_aclListResponseItem":{"type":"object","description":"By default a summary of fast_acl 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 fast_acl","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.fast_acl.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this fast_acl","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this fast_acl","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates fast_acl is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemafast_aclGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this fast_acl","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this fast_acl\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/fast_aclStatusObject"},"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 fast_acl\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"fast_aclReACLType":{"type":"object","description":"Fast ACL definition for RE","title":"Fast ACL for RE","x-displayname":"Fast ACL for RE","x-ves-oneof-field-vip_choice":"[\"all_public_vips\",\"default_tenant_vip\",\"selected_tenant_vip\"]","x-ves-proto-message":"ves.io.schema.fast_acl.ReACLType","properties":{"all_public_vips":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_tenant_vip":{"$ref":"#/components/schemas/ioschemaEmpty"},"fast_acl_rules":{"type":"array","description":" Fast ACL rules to match\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Rules","maxItems":128,"items":{"$ref":"#/components/schemas/fast_aclFastACLRuleType"},"x-displayname":"Rules","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.unique_metadata_name":"true"}},"selected_tenant_vip":{"$ref":"#/components/schemas/fast_aclSelectedTenantVIPsType"}}},"fast_aclReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a fast_acl","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.fast_acl.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemafast_aclReplaceSpecType"}}},"fast_aclReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.fast_acl.ReplaceResponse"},"fast_aclSelectedTenantVIPsType":{"type":"object","description":"Select various tenant public VIP(s)","title":"Specific Tenant VIP","x-displayname":"Specific Tenant VIP","x-ves-proto-message":"ves.io.schema.fast_acl.SelectedTenantVIPsType","properties":{"default_tenant_vip":{"type":"boolean","description":" Include tenant vip in list of specific VIP(s)","title":"Include Default Tenant VIP","format":"boolean","x-displayname":"Include Tenant VIP"},"public_ip_refs":{"type":"array","description":" Select additional public VIP(s)\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"Apply to Dedicated Public VIP","minItems":1,"maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Select Public VIP(s)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.min_items":"1"}}}},"fast_aclSelectedVIPAddressType":{"type":"object","description":"x-displayName: \"RE Destination Public IP list\"\nSpecifies destination as list of tenant ip addresses on RE\nPort and protocol is picked automatically based on advertise acl.","title":"RE Destination Public IP List","properties":{"address":{"type":"array","description":"x-displayName: \"IP Address\"\nList of IP addresses to match with destination","title":"IP Address","items":{"$ref":"#/components/schemas/schemaIpAddressType"}}}},"fast_aclSiteACLType":{"type":"object","description":"Fast ACL definition for Site","title":"Fast ACL for Site","x-displayname":"Fast ACL for Site","x-ves-oneof-field-network_choice":"[\"inside_network\",\"outside_network\"]","x-ves-oneof-field-vip_choice":"[\"all_services\",\"interface_services\",\"vip_services\"]","x-ves-proto-message":"ves.io.schema.fast_acl.SiteACLType","properties":{"all_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"fast_acl_rules":{"type":"array","description":" Fast ACL rules to match\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Rules","maxItems":128,"items":{"$ref":"#/components/schemas/fast_aclFastACLRuleType"},"x-displayname":"Rules","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.unique_metadata_name":"true"}},"inside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"interface_services":{"$ref":"#/components/schemas/ioschemaEmpty"},"outside_network":{"$ref":"#/components/schemas/ioschemaEmpty"},"vip_services":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"fast_aclStatusObject":{"type":"object","description":"Most recently observed status of object","title":"StatusObject","x-displayname":"Status Object","x-ves-displayorder":"1,2,3","x-ves-proto-message":"ves.io.schema.fast_acl.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Reference to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"fast_acl_ruleFastAclRuleAction":{"type":"object","description":"FastAclRuleAction specifies possible action to be applied on traffic,\npossible action include dropping, forwarding or ratelimiting the traffic","title":"FastAclRuleAction","x-displayname":"Action","x-ves-oneof-field-action":"[\"policer_action\",\"protocol_policer_action\",\"simple_action\"]","x-ves-proto-message":"ves.io.schema.fast_acl_rule.FastAclRuleAction","properties":{"policer_action":{"$ref":"#/components/schemas/schemaPolicerRefType"},"protocol_policer_action":{"$ref":"#/components/schemas/schemaProtocolPolicerRefType"},"simple_action":{"$ref":"#/components/schemas/fast_acl_ruleFastAclRuleSimpleAction"}}},"fast_acl_ruleFastAclRuleSimpleAction":{"type":"string","description":"FastAclRuleSimpleAction specifies simple action like PASS or DENY\n\nDrop the traffic\nForward the traffic","title":"FastAclRuleSimpleAction","enum":["DENY","ALLOW"],"default":"DENY","x-displayname":"Simple Action","x-ves-proto-enum":"ves.io.schema.fast_acl_rule.FastAclRuleSimpleAction"},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"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"}}},"schemaIpAddressType":{"type":"object","description":"x-displayName: \"IP Address\"\nIP Address used to specify an IPv4 or IPv6 address","title":"IP Address","properties":{"ipv4":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"ipv6":{"$ref":"#/components/schemas/schemaIpv6AddressType"}}},"schemaIpPrefixSetRefType":{"type":"object","description":"A list of references to ip_prefix_set objects.","title":"IpPrefixSetRefType","x-displayname":"IP Prefix Set Reference","x-ves-proto-message":"ves.io.schema.IpPrefixSetRefType","properties":{"ref":{"type":"array","description":" A list of references to ip_prefix_set objects.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaIpv4AddressType":{"type":"object","description":"x-displayName: \"IPv4 Address\"\nIPv4 Address in dot-decimal notation","title":"IPv4 Address","properties":{"addr":{"type":"string","description":"x-displayName: \"IPv4 Address\"\nx-example: \"192.168.1.1\"\nIPv4 Address in string form with dot-decimal notation","title":"IPv4 Address"}}},"schemaIpv6AddressType":{"type":"object","description":"x-displayName: \"IPv6 Address\"\nIPv6 Address specified as hexadecimal numbers separated by ':'","title":"IPv6 Address","properties":{"addr":{"type":"string","description":"x-displayName: \"IPv6 Address\"\nx-example: \"2001:db8:0:0:0:0:2:1\"\nIPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':'\nThe address can be compacted by suppressing zeros\ne.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'","title":"IPv6 Address"}}},"schemaMessageMetaType":{"type":"object","description":"MessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","x-displayname":"Message Metadata","x-ves-proto-message":"ves.io.schema.MessageMetaType","properties":{"description":{"type":"string","description":" Human readable description.\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"description","maxLength":256,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"name":{"type":"string","description":" This is the name of the message.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"name","minLength":1,"x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.ves_object_name":"true"}}}},"schemaMetricLabelOp":{"type":"string","description":"The operator to use when filtering metrics based on label values.\n","title":"Metric Label Operator","enum":["EQ","NEQ"],"default":"EQ","x-displayname":"Metric Label Operator","x-ves-proto-enum":"ves.io.schema.MetricLabelOp"},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"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"}}},"schemaPolicerRefType":{"type":"object","description":"Reference to policer object","title":"PolicerRefType","x-displayname":"Policer Reference","x-ves-proto-message":"ves.io.schema.PolicerRefType","properties":{"ref":{"type":"array","description":" A policer direct reference\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaPortValueType":{"type":"object","description":"PortValueType specifies the port value\nCan be any or a specified port","title":"PortValueType","x-displayname":"Port Value Type","x-ves-oneof-field-port_value_type_choice":"[\"all\",\"dns\",\"user_defined\"]","x-ves-proto-message":"ves.io.schema.PortValueType","properties":{"all":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns":{"$ref":"#/components/schemas/ioschemaEmpty"},"user_defined":{"type":"integer","description":"Exclusive with [all dns]\n Matches the user defined port\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 65535\n","title":"User defined Port","format":"int64","x-displayname":"User defined port","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"65535"}}}},"schemaPrefixListType":{"type":"object","description":"List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes","title":"IP Prefix List","x-displayname":"IP Prefix List","x-ves-proto-message":"ves.io.schema.PrefixListType","properties":{"prefix":{"type":"array","description":" IP Address prefix in string format. String must contain both prefix and prefix-length\n\nExample: ` \"[192.168.1.0/24, 192.168.2.0/24]\"\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.ipv4_prefix: true\n  ves.io.schema.rules.repeated.max_items: 256\n","title":"Prefix","maxItems":256,"items":{"type":"string"},"x-displayname":"Prefix","x-ves-example":"[192.168.1.0/24, 192.168.2.0/24]\"","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv4_prefix":"true","ves.io.schema.rules.repeated.max_items":"256"}}}},"schemaProtocolPolicerRefType":{"type":"object","description":"Reference to policer object","title":"ProtocolPolicerRefType","x-displayname":"Protocol Policer Reference","x-ves-proto-message":"ves.io.schema.ProtocolPolicerRefType","properties":{"ref":{"type":"array","description":" Reference to protocol policer object\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"ref","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Protocol policer Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"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"}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"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"}}},"schemaVirtualNetworkSelectorType":{"type":"object","description":"x-displayName: \"Virtual Network Type\"\nDifferent types of virtual networks understood by the system","title":"VirtualNetworkSelectorType","properties":{"public":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local":{"$ref":"#/components/schemas/ioschemaEmpty"},"site_local_inside":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"schemafast_aclCreateSpecType":{"type":"object","description":"Create a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`","title":"Create Fast ACL","x-displayname":"Create Fast ACL","x-ves-oneof-field-site_choice":"[\"re_acl\",\"site_acl\"]","x-ves-proto-message":"ves.io.schema.fast_acl.CreateSpecType","properties":{"protocol_policer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"re_acl":{"$ref":"#/components/schemas/fast_aclReACLType"},"site_acl":{"$ref":"#/components/schemas/fast_aclSiteACLType"}}},"schemafast_aclGetSpecType":{"type":"object","description":"Get value of `fast_acl` for object","title":"Get Fast ACL","x-displayname":"Get Fast ACL","x-ves-oneof-field-site_choice":"[\"re_acl\",\"site_acl\"]","x-ves-proto-message":"ves.io.schema.fast_acl.GetSpecType","properties":{"protocol_policer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"re_acl":{"$ref":"#/components/schemas/fast_aclReACLType"},"site_acl":{"$ref":"#/components/schemas/fast_aclSiteACLType"}}},"schemafast_aclReplaceSpecType":{"type":"object","description":"Replace a `fast_acl` object, `fast_acl` object contains rules to protect site from denial of service\nIt has destination{destination IP, destination port) and references to `fast_acl_rule`","title":"Replace Fast ACL","x-displayname":"Replace Fast ACL","x-ves-oneof-field-site_choice":"[\"re_acl\",\"site_acl\"]","x-ves-proto-message":"ves.io.schema.fast_acl.ReplaceSpecType","properties":{"protocol_policer":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"re_acl":{"$ref":"#/components/schemas/fast_aclReACLType"},"site_acl":{"$ref":"#/components/schemas/fast_aclSiteACLType"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}}}}}