@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.graph.site","description":"graph/site api is query used to get monitoring information for inter site traffic graph for a application.\nTraffic for application is selected when ves.io/app_type label is added to group of services or virtual_host.\nIt returns graph which is set of nodes and edges. \nEach node represents site and edge is traffic between sites for this application. Edges are directed from client to server. \nTwo edges can be present for a given pair of sites. Only method post is supported. Query parameters are present in the request body. \nIt is always scoped by namespace.","version":""},"paths":{"/api/data/namespaces/{namespace}/graph/site":{"post":{"summary":"Site Graph Query","description":"Request to get inter-site traffic graph for an application.","operationId":"ves.io.schema.graph.site.CustomAPI.Query","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-graph-site-customapi-query"},"x-ves-proto-rpc":"ves.io.schema.graph.site.CustomAPI.Query"},"x-displayname":"Site Graph","x-ves-proto-service":"ves.io.schema.graph.site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/site/edge":{"post":{"summary":"Site Edge Query","description":"Request to get time-series data for an edge returned in the site traffic graph.","operationId":"ves.io.schema.graph.site.CustomAPI.EdgeQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteEdgeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteEdgeRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.graph.site.CustomAPI.EdgeQuery"},"x-displayname":"Site Graph","x-ves-proto-service":"ves.io.schema.graph.site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/graph/site/node":{"post":{"summary":"Site Node Query","description":"Request to get time-series data for a site returned in the site traffic graph.","operationId":"ves.io.schema.graph.site.CustomAPI.NodeQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteNodeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nnamespace is used to scope the application traffic to a given namespace.\nFor system namespace, application traffic across all namespaces for the\ntenant will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/siteNodeRequest"}}},"required":true},"x-ves-proto-rpc":"ves.io.schema.graph.site.CustomAPI.NodeQuery"},"x-displayname":"Site Graph","x-ves-proto-service":"ves.io.schema.graph.site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Site Graph","x-ves-proto-package":"ves.io.schema.graph.site","components":{"schemas":{"graphEdgeMetricData":{"type":"object","description":"EdgeMetricData contains requested metric data for an edge","title":"Edge Metric Data","x-displayname":"Edge Metric Data","x-ves-proto-message":"ves.io.schema.graph.EdgeMetricData","properties":{"data":{"type":"array","description":" List of metric specified in the request for an edge","title":"Data","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Data"}}},"graphEdgeMetricSelector":{"type":"object","description":"EdgeMetricSelector is used to select the metrics that should be returned for an edge.","title":"Edge Metric Selector","x-displayname":"Edge Metric Selector","x-ves-proto-message":"ves.io.schema.graph.EdgeMetricSelector","properties":{"features":{"type":"array","description":" Specify list of timeseries features that should be returned for each metric type\n in the request.","title":"Features","items":{"$ref":"#/components/schemas/timeseriesTimeseriesFeature"},"x-displayname":"Features"},"types":{"type":"array","description":" Specify list of metrics that should be returned for each edge in the connectivity graph.","title":"Types","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Types"}}},"graphHealthscoreData":{"type":"object","description":"Contains the list of healthscores requested by the user.","title":"Healthscore Data","x-displayname":"Healthscore Data","x-ves-proto-message":"ves.io.schema.graph.HealthscoreData","properties":{"data":{"type":"array","description":" List of healthscores specified in the request.","title":"Data","items":{"$ref":"#/components/schemas/graphHealthscoreTypeData"},"x-displayname":"Data"}}},"graphHealthscoreSelector":{"type":"object","description":"Healthscore Selector is used to specify the healthscore types to be returned in the response.","title":"Healthscore Selector","x-displayname":"Healthscore Selector","x-ves-proto-message":"ves.io.schema.graph.HealthscoreSelector","properties":{"types":{"type":"array","description":" Healthscore types to be returned in the response.","title":"Types","items":{"$ref":"#/components/schemas/graphHealthscoreType"},"x-displayname":"Types"}}},"graphHealthscoreType":{"type":"string","description":"Healthscore for a site or service calculated based on SLAs and KPIs for the application\n\nHealthscore not requested\nx-unit: \"percentage\"\nConnectivity Healthscore\nx-unit: \"percentage\"\nPerformance Healthscore\nx-unit: \"percentage\"\nSecurity Healthscore\nx-unit: \"percentage\"\nReliability Healthscore\nx-unit: \"percentage\"\nOverall Healthscore","title":"Healthscore Type","enum":["HEALTHSCORE_NONE","HEALTHSCORE_CONNECTIVITY","HEALTHSCORE_PERFORMANCE","HEALTHSCORE_SECURITY","HEALTHSCORE_RELIABILITY","HEALTHSCORE_OVERALL"],"default":"HEALTHSCORE_NONE","x-displayname":"Healthscore Type","x-ves-proto-enum":"ves.io.schema.graph.HealthscoreType"},"graphHealthscoreTypeData":{"type":"object","description":"HealthScoreTypeData contains healthscore type and the corresponding value","title":"Healthscore Type Data","x-displayname":"Healthscore Type Data","x-ves-proto-message":"ves.io.schema.graph.HealthscoreTypeData","properties":{"reason":{"type":"string","description":" A human readable string explaining the reason in case of bad healthscore\n\nExample: ` \"Only one healthy RE connected\"`","title":"Reason","x-displayname":"Reason","x-ves-example":"Only one healthy RE connected"},"type":{"$ref":"#/components/schemas/graphHealthscoreType"},"value":{"type":"array","description":" Healthscore value","title":"Value","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Value"}}},"graphMetricData":{"type":"object","description":"MetricData contains the metric type and the corresponding metric value(s)","title":"Metric Data","x-displayname":"Metric Data","x-ves-proto-message":"ves.io.schema.graph.MetricData","properties":{"type":{"$ref":"#/components/schemas/schemagraphMetricType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"},"value":{"$ref":"#/components/schemas/graphMetricFeatureData"}}},"graphMetricFeatureData":{"type":"object","description":"Contains metric values for timeseries features specified in the request.","title":"Metric Feature Data","x-displayname":"Metric Feature Data","x-ves-proto-message":"ves.io.schema.graph.MetricFeatureData","properties":{"anomaly":{"type":"array","description":" Number of anomalies for the given time range.","title":"Anomaly","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Anomaly"},"confidence_lower_bound":{"type":"array","description":" Lower Bound of the metric value","title":"Confidence Lower Bound","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Confidence Lower Bound"},"confidence_upper_bound":{"type":"array","description":" Upper Bound of the metric value","title":"Confidence Upper Bound","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Confidence Upper Bound"},"healthscore":{"type":"array","description":" Healscore of the metric calculated based on the number of anomalies\n and the value of the anomalies for the time range.","title":"Healthscore","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Healthscore"},"raw":{"type":"array","description":" List of metric values for a given metric type","title":"Raw","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Raw"},"trend":{"type":"array","description":" Indicates the metric trend","title":"Trend","items":{"$ref":"#/components/schemas/schemagraphMetricValue"},"x-displayname":"Trend"}}},"graphNodeMetricData":{"type":"object","description":"NodeMetricData contains the upstream and downstream metrics for a node.","title":"Node Metric Data","x-displayname":"Node Metric Data","x-ves-proto-message":"ves.io.schema.graph.NodeMetricData","properties":{"downstream":{"type":"array","description":" Metric data for the source site/service","title":"Downstream","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Downstream"},"upstream":{"type":"array","description":" Metric data for the destination site/service","title":"Upstream","items":{"$ref":"#/components/schemas/graphMetricData"},"x-displayname":"Upstream"}}},"graphNodeMetricSelector":{"type":"object","description":"NodeMetricSelector is used to select the metrics that should be returned for a node.","title":"Node Metric Selector","x-displayname":"Node Metric Selector","x-ves-proto-message":"ves.io.schema.graph.NodeMetricSelector","properties":{"downstream":{"type":"array","description":" Downstream refers to the service that sends requests and receives response.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Downstream","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Downstream","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}},"features":{"type":"array","description":" Specify list of timeseries features that should be returned for each metric type\n in the request.","title":"Features","items":{"$ref":"#/components/schemas/timeseriesTimeseriesFeature"},"x-displayname":"Features"},"upstream":{"type":"array","description":" Upstream refers to the service that receives requests and sends response.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.unique: true\n","title":"Upstream","items":{"$ref":"#/components/schemas/schemagraphMetricType"},"x-displayname":"Upstream","x-ves-validation-rules":{"ves.io.schema.rules.repeated.unique":"true"}}}},"graphQueryOp":{"type":"string","description":"Match operators supported on a label\n\nIndicates that the field is not set\nSelect timeseries whose label value exactly matches the specified string\nSelect timeseries whose label value does not match the specified string","title":"Label Operator","enum":["NOP","EQ","NEQ"],"default":"NOP","x-displayname":"Label Operator","x-ves-proto-enum":"ves.io.schema.graph.QueryOp"},"graphsiteLabel":{"type":"string","description":"Metrics used to construct the site graph are tagged with these labels and therefore\nthe metrics can be sliced and diced based on one or more labels listed below.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)","title":"Label","enum":["LABEL_NONE","LABEL_SITE"],"default":"LABEL_NONE","x-displayname":"Label","x-ves-proto-enum":"ves.io.schema.graph.site.Label"},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"schemagraphMetricType":{"type":"string","description":"List of metric types that are supported for application site and service graph\n\nIndicates field not being set\nx-unit: \"per second\"\nNumber of requests per second\nDeprecated by HTTP_REQUEST_RATE, TCP_CONNECTION_RATE\nx-unit: \"per second\"\nNumber of errors per second\nDeprecated by HTTP_ERROR_RATE, TCP_ERROR_RATE\nx-unit: \"seconds\"\nAverage latency per request\nDeprecated by HTTP_RESPONSE_LATENCY and TCP_CONNECTION_DURATION\nx-unit: \"bits per second (bps)\"\nRequest Throughput\nx-unit: \"bits per second (bps)\"\nResponse Throughput\nx-unit: \"per second\"\nNumber of errors with response code 3XX\nDeprecated\nx-unit: \"per second\"\nNumber of errors with response code 4XX\nDeprecated by HTTP_ERROR_RATE_4XX\nx-unit: \"per second\"\nNumber of errors with response code 5XX\nDeprecated by HTTP_ERROR_RATE_5XX\nx-unit: \"seconds\"\nMax time taken to complete 50% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_50\nx-unit: \"seconds\"\nMax time taken to complete 90% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_90\nx-unit: \"seconds\"\nMax time taken to complete 99% of the requests\nDeprecated by HTTP_RESPONSE_LATENCY_PERCENTILE_99\nDeprecated\nx-unit: \"seconds\"\nAverage Round Trip Time for the client\nx-unit: \"seconds\"\nAverage Round Trip Time for the server\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nDeprecated by HTTP_SERVER_DATA_TRANSFER_TIME\nx-unit: \"seconds\"\nAverage time taken by the application to service the request\nDeprecated by HTTP_APP_LATENCY\nx-unit: \"per second\"\nNumber of requests to origin (good requests) per second\nx-unit: \"requests per second\"\nNumber of HTTP requests per second\nx-unit: \"errors per second\"\nNumber of HTTP errors per second\nx-unit: \"errors per second\"\nNumber of HTTP client errors per second\nx-unit: \"errors per second\"\nNumber of HTTP server errors per second\nx-unit: \"seconds\"\nAverage latency per HTTP request\nx-unit: \"seconds\"\nMax time taken to complete 50% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 90% of the HTTP requests\nx-unit: \"seconds\"\nMax time taken to complete 99% of the HTTP requests\nx-unit: \"seconds\"\nAverage time taken by the server for data transfer\nx-unit: \"seconds\"\nAverage time taken by the application to service the HTTP request\nx-unit: \"connections per second\"\nNumber of TCP connections per second\nx-unit: \"errors per second\"\nNumber of TCP connection errors per second\nx-unit: \"errors per second\"\nNumber of TCP client errors per second\nx-unit: \"errors per second\"\nNumber of TCP server/upstream errors per second\nx-unit: \"seconds\"\nAverage connection duration","title":"Metric Type","enum":["METRIC_TYPE_NONE","REQUEST_RATE","ERROR_RATE","RESPONSE_LATENCY","REQUEST_THROUGHPUT","RESPONSE_THROUGHPUT","ERROR_RATE_3XX","ERROR_RATE_4XX","ERROR_RATE_5XX","RESPONSE_LATENCY_PERCENTILE_50","RESPONSE_LATENCY_PERCENTILE_90","RESPONSE_LATENCY_PERCENTILE_99","RESPONSE_DATA_TRANSFER_DURATION","CLIENT_RTT","SERVER_RTT","SERVER_DATA_TRANSFER_TIME","APP_LATENCY","REQUEST_TO_ORIGIN_RATE","HTTP_REQUEST_RATE","HTTP_ERROR_RATE","HTTP_ERROR_RATE_4XX","HTTP_ERROR_RATE_5XX","HTTP_RESPONSE_LATENCY","HTTP_RESPONSE_LATENCY_PERCENTILE_50","HTTP_RESPONSE_LATENCY_PERCENTILE_90","HTTP_RESPONSE_LATENCY_PERCENTILE_99","HTTP_SERVER_DATA_TRANSFER_TIME","HTTP_APP_LATENCY","TCP_CONNECTION_RATE","TCP_ERROR_RATE","TCP_ERROR_RATE_CLIENT","TCP_ERROR_RATE_UPSTREAM","TCP_CONNECTION_DURATION"],"default":"METRIC_TYPE_NONE","x-displayname":"Metric Type","x-ves-proto-enum":"ves.io.schema.graph.MetricType"},"schemagraphMetricValue":{"type":"object","description":"Each metric value consists of a timestamp and a value.\nTimestamp in the Metric Value is based on the start_time, end_time and step in the request.\nValid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ... tn=tn-1+step, where tn <= end_time.\nResponse may not contain values for all timestamps between start_time and end_time.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.graph.MetricValue","properties":{"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":" Metric value\n\nExample: ` \"10.6\"`","title":"Value","x-displayname":"Value","x-ves-example":"10.6"}}},"siteEdgeData":{"type":"object","description":"EdgeData wraps all the response data for an edge in the site graph response.","title":"Edge Data","x-displayname":"Edge Data","x-ves-proto-message":"ves.io.schema.graph.site.EdgeData","properties":{"data":{"$ref":"#/components/schemas/siteEdgeFieldData"},"dst_id":{"$ref":"#/components/schemas/siteId"},"src_id":{"$ref":"#/components/schemas/siteId"}}},"siteEdgeFieldData":{"type":"object","description":"EdgeFieldData wraps all the metric and the healthscore data for an edge.","title":"Edge Field data","x-displayname":"Edge Field Data","x-ves-proto-message":"ves.io.schema.graph.site.EdgeFieldData","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreData"},"metric":{"$ref":"#/components/schemas/graphEdgeMetricData"}}},"siteEdgeFieldSelector":{"type":"object","description":"EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.","title":"Edge Field Selector","x-displayname":"Edge Field Selector","x-ves-proto-message":"ves.io.schema.graph.site.EdgeFieldSelector","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreSelector"},"metric":{"$ref":"#/components/schemas/graphEdgeMetricSelector"}}},"siteEdgeRequest":{"type":"object","description":"Request to get the time-series data for an edge in the site graph.\nWhile graph/site API is used to get application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/edge API is used to get the time-series data (drill-down of aggregated data)\nfor each field.","title":"Site Edge Request","x-displayname":"Site Edge Request","x-ves-proto-message":"ves.io.schema.graph.site.EdgeRequest","properties":{"dst_id":{"$ref":"#/components/schemas/siteId"},"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/siteEdgeFieldSelector"},"namespace":{"type":"string","description":" namespace is used to scope the application traffic to a given namespace.\n For system namespace, application traffic across all namespaces for the\n tenant will be considered.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"src_id":{"$ref":"#/components/schemas/siteId"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"siteEdgeResponse":{"type":"object","description":"Response for graph/site/edge API returns the time-series data for the site edge specified in the request.","title":"Site Edge Response","x-displayname":"Site Edge Response","x-ves-proto-message":"ves.io.schema.graph.site.EdgeResponse","properties":{"data":{"$ref":"#/components/schemas/siteEdgeFieldData"},"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"}}}},"siteFieldSelector":{"type":"object","description":"FieldSelector is used to specify the list of fields to be returned in the response for site graph.","title":"Field Selector","x-displayname":"Field Selector","x-ves-proto-message":"ves.io.schema.graph.site.FieldSelector","properties":{"edge":{"$ref":"#/components/schemas/siteEdgeFieldSelector"},"node":{"$ref":"#/components/schemas/siteNodeFieldSelector"}}},"siteGraphData":{"type":"object","description":"GraphData wraps the response for the site graph request that contains\nall the nodes and the edges. Each node contains the application traffic\nflowing from/to site and each edge contains the application traffic flowing\nfrom/to the source site and the destination site.","title":"Graph Data","x-displayname":"Graph Data","x-ves-proto-message":"ves.io.schema.graph.site.GraphData","properties":{"edges":{"type":"array","description":" List of edges in the site graph. Each edge contains the application traffic\n flowing from/to the source site and the destination site.","title":"Edges","items":{"$ref":"#/components/schemas/siteEdgeData"},"x-displayname":"Edges"},"nodes":{"type":"array","description":" List of nodes in the site graph. Each node contains the application traffic\n flowing from/to the site.","title":"Nodes","items":{"$ref":"#/components/schemas/siteNodeData"},"x-displayname":"Nodes"}}},"siteId":{"type":"object","description":"Id uniquely identifies a node or an edge in the site graph.","title":"Id","x-displayname":"Id","x-ves-proto-message":"ves.io.schema.graph.site.Id","properties":{"site":{"type":"string","description":" Name of the site\n\nExample: ` \"ce01\"`","title":"Site","x-displayname":"Site","x-ves-example":"ce01"}}},"siteIdField":{"type":"string","description":"IdField is used to select one or more fields that uniquely identifies\na node or an edge in the site graph.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)","title":"Id Field","enum":["NONE","SITE"],"default":"NONE","x-displayname":"Id Field","x-ves-proto-enum":"ves.io.schema.graph.site.IdField"},"siteLabelFilter":{"type":"object","description":"Metrics used to render the site graph are tagged with labels listed in the enum Label.\nLabel Filter is used to filter the timeseries that match the specified label key/value\nand the operator.","title":"Label Filter","x-displayname":"Label Filter","x-ves-proto-message":"ves.io.schema.graph.site.LabelFilter","properties":{"label":{"$ref":"#/components/schemas/graphsiteLabel"},"op":{"$ref":"#/components/schemas/graphQueryOp"},"value":{"type":"string","description":" Value of the label\n\nExample: ` \"ce01\"`","title":"Value","x-displayname":"Value","x-ves-example":"ce01"}}},"siteNodeData":{"type":"object","description":"NodeData wraps all the response data for a node in the site graph response.","title":"Node Data","x-displayname":"Node Data","x-ves-proto-message":"ves.io.schema.graph.site.NodeData","properties":{"data":{"$ref":"#/components/schemas/siteNodeFieldData"},"id":{"$ref":"#/components/schemas/siteId"}}},"siteNodeFieldData":{"type":"object","description":"NodeFieldData wraps all the metric and the healthscore data for a node.","title":"Node Field data","x-displayname":"Node Field Data","x-ves-proto-message":"ves.io.schema.graph.site.NodeFieldData","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreData"},"metric":{"$ref":"#/components/schemas/graphNodeMetricData"}}},"siteNodeFieldSelector":{"type":"object","description":"NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.","title":"Node Field Selector","x-displayname":"Node Field Selector","x-ves-proto-message":"ves.io.schema.graph.site.NodeFieldSelector","properties":{"healthscore":{"$ref":"#/components/schemas/graphHealthscoreSelector"},"metric":{"$ref":"#/components/schemas/graphNodeMetricSelector"}}},"siteNodeRequest":{"type":"object","description":"Request to get time-series data for a node in the site graph.\nWhile graph/site API is used to get application traffic for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/site/node API is used to get the time-series data (drill-down of aggregated data)\nfor each field.","title":"Site Node Request","x-displayname":"Site Node Request","x-ves-proto-message":"ves.io.schema.graph.site.NodeRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/siteNodeFieldSelector"},"id":{"$ref":"#/components/schemas/siteId"},"namespace":{"type":"string","description":" namespace is used to scope the application traffic to a given namespace.\n For system namespace, application traffic across all namespaces for the\n tenant will be considered.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"siteNodeResponse":{"type":"object","description":"Response for graph/site/node request returns the time-series data for the site\nspecified in the request.","title":"Site Node Response","x-displayname":"Site Node Response","x-ves-proto-message":"ves.io.schema.graph.site.NodeResponse","properties":{"data":{"$ref":"#/components/schemas/siteNodeFieldData"},"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"}}}},"siteRequest":{"type":"object","description":"graph/site API is used to get intra-site and inter-site graph for application traffic.","title":"Site Graph Request","x-displayname":"Site Graph Request","x-ves-proto-message":"ves.io.schema.graph.site.Request","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"$ref":"#/components/schemas/siteFieldSelector"},"group_by":{"type":"array","description":" Aggregate data by site.\n Optional: If not specified, then the data is aggregated/grouped by site.","title":"Group by","items":{"$ref":"#/components/schemas/siteIdField"},"x-displayname":"Group By"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label key\" QueryOp \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n\n Optional: If not specified, application traffic for all sites will be returned in the response. ","title":"Label Filter","items":{"$ref":"#/components/schemas/siteLabelFilter"},"x-displayname":"Label Filter"},"namespace":{"type":"string","description":" namespace is used to scope the application traffic to a given namespace.\n For system namespace, application traffic across all namespaces for the\n tenant will be considered.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":"\n start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"siteResponse":{"type":"object","description":"Response for graph/site API contains list of nodes and edges.\nEach node contains application traffic flowing from/to site.\nEach edge contains application traffic flowing from src site to dst site.","title":"Site Graph Response","x-displayname":"Site Graph Response","x-ves-proto-message":"ves.io.schema.graph.site.Response","properties":{"data":{"$ref":"#/components/schemas/siteGraphData"},"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"}}}},"timeseriesTimeseriesFeature":{"type":"string","description":"Various Timeseries Features that can be enabled\n\nDo not enable any feature\nEnable calculating confidence interval, upper and lower bound time series where metric is expected to vary.\ndetect anomalies and generate alarm when metric goes out of confidence interval\ndetect trend of the metric\nIndicate a score between 0 to 100 which indicates if the metric is healthy","title":"Timeseries","enum":["TIMESERIES_FEATURE_NONE","CONFIDENCE_INTERVAL","ANOMALY_DETECTION","TREND","HEALTHSCORE"],"default":"TIMESERIES_FEATURE_NONE","x-displayname":"Timeseries","x-ves-proto-enum":"ves.io.schema.timeseries.TimeseriesFeature"}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.site_mesh_group","description":"Site mesh group is a configuration tool to provide Site to Site\nconnectivity\n\nSet of sites in a site mesh group are defined by a virtual site.\n\nThe site mesh groups can be of type HUB or SPOKE. Where,\n- SITE_MESH_GROUP_TYPE_HUB_FULL_MESH\n  'virtual_site' in the Site Mesh Group defines list of HUB Sites for the Site Mesh Group\n  A HUB Site will route traffic between all its Spoke Sites.\n\n  Current release can support only a single site in Site Mesh Group of this type\n\n- SITE_MESH_GROUP_TYPE_SPOKE\n  'virtual_site' selects list of Spoke sites. Traffic between two Spoke sites is\n   routed thru Hub Sites.\n\n  'hub' field refers to another Site Mesh Group. The 'virtual_site' in this Site Mesh Group\n  gives list of Hub Sites for the Spokes. Every Spoke site will create tunnels with all the\n  Hub Sites\n\n- SITE_MESH_GROUP_TYPE_FULL_MESH\n  'virtual_site' selects list of Sites. Full mesh of tunnels is created between all sites that\n  are member of virtual_site\n\nNOTE :\n- The tunnels created by Site Mesh Group are in addition to the tunnels created from CE to its 'Connected REs'\n- The tunnels can be setup over either public network or a private network and tunnels can be of type IPSec only\n- A site can be member of either SITE_MESH_GROUP_TYPE_HUB_FULL_MESH or SITE_MESH_GROUP_TYPE_SPOKE. Not both","version":""},"paths":{"/api/config/namespaces/{metadata.namespace}/site_mesh_groups":{"post":{"summary":"Create Site Mesh Group","description":"Create a Site Mesh Group in system namespace of user","operationId":"ves.io.schema.site_mesh_group.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site_mesh_groupCreateResponse"}}}},"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/site_mesh_groupCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-site_mesh_group-api-create"},"x-ves-proto-rpc":"ves.io.schema.site_mesh_group.API.Create"},"x-displayname":"Site Mesh Group","x-ves-proto-service":"ves.io.schema.site_mesh_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/site_mesh_groups/{metadata.name}":{"put":{"summary":"Replace Site Mesh Group","description":"Replace contents of a Site Mesh Group object","operationId":"ves.io.schema.site_mesh_group.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site_mesh_groupReplaceResponse"}}}},"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/site_mesh_groupReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-site_mesh_group-api-replace"},"x-ves-proto-rpc":"ves.io.schema.site_mesh_group.API.Replace"},"x-displayname":"Site Mesh Group","x-ves-proto-service":"ves.io.schema.site_mesh_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/site_mesh_groups":{"get":{"summary":"List Site Mesh Group","description":"List the set of site_mesh_group in a namespace","operationId":"ves.io.schema.site_mesh_group.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site_mesh_groupListResponse"}}}},"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 site_mesh_group","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-site_mesh_group-api-list"},"x-ves-proto-rpc":"ves.io.schema.site_mesh_group.API.List"},"x-displayname":"Site Mesh Group","x-ves-proto-service":"ves.io.schema.site_mesh_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/site_mesh_groups/{name}":{"get":{"summary":"Get Site Mesh Group","description":"Gets Site Mesh Group object from system namespace","operationId":"ves.io.schema.site_mesh_group.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site_mesh_groupGetResponse"}}}},"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-site_mesh_group-api-get"},"x-ves-proto-rpc":"ves.io.schema.site_mesh_group.API.Get"},"delete":{"summary":"Delete Site Mesh Group","description":"Delete the specified site_mesh_group","operationId":"ves.io.schema.site_mesh_group.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/site_mesh_groupDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-site_mesh_group-api-delete"},"x-ves-proto-rpc":"ves.io.schema.site_mesh_group.API.Delete"},"x-displayname":"Site Mesh Group","x-ves-proto-service":"ves.io.schema.site_mesh_group.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Site Mesh Group","x-ves-proto-package":"ves.io.schema.site_mesh_group","components":{"schemas":{"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSiteInfo":{"type":"object","description":"Information about a particular site.","title":"Site Info","x-displayname":"Site Info","x-ves-proto-message":"ves.io.schema.SiteInfo","properties":{"annotations":{"type":"array","description":" The list of annotations providing information about the referenced site.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"annotations","items":{"type":"string"},"x-displayname":"annotations","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"site":{"type":"array","description":" 'site' refers to a site.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"site","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"site","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaSiteMeshGroupStatus":{"type":"object","description":"Status of the site mesh group (this will be used in site status object and smg status object)","title":"Site mesh group status","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.SiteMeshGroupStatus","properties":{"other_connected_sites":{"type":"array","description":" List of sites connected by this Site Mesh Group\n\nExample: ` \"[ce01-sfo, ce01-nyc]\"`","title":"other_connected_sites","items":{"type":"string"},"x-displayname":"Other Connected Sites","x-ves-example":"[ce01-sfo, ce01-nyc]"},"site_info":{"type":"array","description":" The list of sites in the site mesh group and information about each","title":"site_info","items":{"$ref":"#/components/schemas/schemaSiteInfo"},"x-displayname":"site info"}}},"schemaSiteToSiteTunnelType":{"type":"string","description":"x-displayName: \"Tunnel type\"\nTunnel encapsulation to be used between sites\n\n - SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL: x-displayName: \"IPSEC and SSL\"\nTunnel can operate in both IPsec and SSL, with IPsec being prefered over SSL.\n - SITE_TO_SITE_TUNNEL_IPSEC: x-displayName: \"IPSEC\"\nTunnel is of type IPsec\n - SITE_TO_SITE_TUNNEL_SSL: x-displayName: \"SSL\"\nTunnel is of type SSL","title":"Site to site tunnel type","enum":["SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL","SITE_TO_SITE_TUNNEL_IPSEC","SITE_TO_SITE_TUNNEL_SSL"],"default":"SITE_TO_SITE_TUNNEL_IPSEC_OR_SSL"},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemasite_mesh_groupCreateSpecType":{"type":"object","description":"Create a Site Mesh Group in system namespace of user","title":"Create site mesh group","x-displayname":"Create Site Mesh Group","x-ves-displayorder":"1,3,4","x-ves-oneof-field-mesh_choice":"[\"full_mesh\",\"hub_mesh\",\"spoke_mesh\"]","x-ves-oneof-field-re_fallback":"[\"disable_re_fallback\",\"enable_re_fallback\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.CreateSpecType","properties":{"disable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"full_mesh":{"$ref":"#/components/schemas/site_mesh_groupFullMeshGroupType"},"hub_mesh":{"$ref":"#/components/schemas/site_mesh_groupHubFullMeshGroupType"},"spoke_mesh":{"$ref":"#/components/schemas/site_mesh_groupSpokeMeshGroupType"},"virtual_site":{"type":"array","description":" Set of sites for which this mesh group config is valid.\n If 'Type' is Spoke, then it gives set of spoke sites.\n If 'Type' is Hub, then it gives set of hub sites.\n If 'Type' is Full Mesh, then it gives set of sites that are connected in full mesh.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Site (Sites in this group)","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"schemasite_mesh_groupGetSpecType":{"type":"object","description":"Gets Site Mesh Group object from system namespace","title":"Get site mesh group","x-displayname":"Get Site Mesh Group","x-ves-displayorder":"1,3,4,2","x-ves-oneof-field-mesh_choice":"[\"full_mesh\",\"hub_mesh\",\"spoke_mesh\"]","x-ves-oneof-field-re_fallback":"[\"disable_re_fallback\",\"enable_re_fallback\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.GetSpecType","properties":{"disable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"full_mesh":{"$ref":"#/components/schemas/site_mesh_groupFullMeshGroupType"},"hub_mesh":{"$ref":"#/components/schemas/site_mesh_groupHubFullMeshGroupType"},"spoke_mesh":{"$ref":"#/components/schemas/site_mesh_groupSpokeMeshGroupType"},"virtual_site":{"type":"array","description":" Set of sites for which this mesh group config is valid.\n If 'Type' is Spoke, then it gives set of spoke sites.\n If 'Type' is Hub, then it gives set of hub sites.\n If 'Type' is Full Mesh, then it gives set of sites that are connected in full mesh.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Site (Sites in this group)","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"schemasite_mesh_groupReplaceSpecType":{"type":"object","description":"Replace contents of a Site Mesh Group object","title":"Replace site mesh group","x-displayname":"Replace Site Mesh Group","x-ves-displayorder":"1,3,4","x-ves-oneof-field-mesh_choice":"[\"full_mesh\",\"hub_mesh\",\"spoke_mesh\"]","x-ves-oneof-field-re_fallback":"[\"disable_re_fallback\",\"enable_re_fallback\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.ReplaceSpecType","properties":{"disable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"enable_re_fallback":{"$ref":"#/components/schemas/ioschemaEmpty"},"full_mesh":{"$ref":"#/components/schemas/site_mesh_groupFullMeshGroupType"},"hub_mesh":{"$ref":"#/components/schemas/site_mesh_groupHubFullMeshGroupType"},"spoke_mesh":{"$ref":"#/components/schemas/site_mesh_groupSpokeMeshGroupType"},"virtual_site":{"type":"array","description":" Set of sites for which this mesh group config is valid.\n If 'Type' is Spoke, then it gives set of spoke sites.\n If 'Type' is Hub, then it gives set of hub sites.\n If 'Type' is Full Mesh, then it gives set of sites that are connected in full mesh.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","maxItems":1,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Virtual Site (Sites in this group)","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"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"}}}},"site_mesh_groupCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of site_mesh_group","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.site_mesh_group.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemasite_mesh_groupCreateSpecType"}}},"site_mesh_groupCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.site_mesh_group.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemasite_mesh_groupGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"site_mesh_groupDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a site_mesh_group","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.site_mesh_group.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"}}},"site_mesh_groupFullMeshGroupType":{"type":"object","description":"Details of Full Mesh Group Type","title":"Full Mesh Group Type","x-displayname":"Full Mesh","x-ves-oneof-field-full_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.FullMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"site_mesh_groupGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read site_mesh_group","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.site_mesh_group.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/site_mesh_groupCreateRequest"},"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/site_mesh_groupReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemasite_mesh_groupGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/site_mesh_groupStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"site_mesh_groupGetResponseFormatCode":{"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"},"site_mesh_groupHubFullMeshGroupType":{"type":"object","description":"Details of Hub Full Mesh Group Type","title":"Hub Full Mesh Group Type","x-displayname":"Hub Full Mesh","x-ves-oneof-field-hub_full_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.HubFullMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"site_mesh_groupListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of site_mesh_group","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.site_mesh_group.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/site_mesh_groupListResponseItem"},"x-displayname":"Items"}}},"site_mesh_groupListResponseItem":{"type":"object","description":"By default a summary of site_mesh_group 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 site_mesh_group","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.site_mesh_group.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this site_mesh_group","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this site_mesh_group","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates site_mesh_group is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemasite_mesh_groupGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this site_mesh_group","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this site_mesh_group\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/site_mesh_groupStatusObject"},"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 site_mesh_group\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"site_mesh_groupReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a site_mesh_group","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.site_mesh_group.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemasite_mesh_groupReplaceSpecType"}}},"site_mesh_groupReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.site_mesh_group.ReplaceResponse"},"site_mesh_groupSiteMeshGroupType":{"type":"string","description":"x-displayName: \"Mesh Type\"\nDefines different types of Mesh\n\n - SITE_MESH_GROUP_TYPE_INVALID: x-displayName: \"Invalid\"\nInvalid mesh type\n - SITE_MESH_GROUP_TYPE_HUB_FULL_MESH: x-displayName: \"Hub\"\nMesh of type Hub\n - SITE_MESH_GROUP_TYPE_SPOKE: x-displayName: \"Spoke\"\nMesh of type Spoke\n - SITE_MESH_GROUP_TYPE_FULL_MESH: x-displayName: \"Full Mesh\"\nFull mesh of tunnels are created between all sites","title":"Site Mesh Group Type","enum":["SITE_MESH_GROUP_TYPE_INVALID","SITE_MESH_GROUP_TYPE_HUB_FULL_MESH","SITE_MESH_GROUP_TYPE_SPOKE","SITE_MESH_GROUP_TYPE_FULL_MESH"],"default":"SITE_MESH_GROUP_TYPE_INVALID"},"site_mesh_groupSpokeMeshGroupType":{"type":"object","description":"Details of Spoke Mesh Group Type","title":"Spoke Mesh Group Type","x-displayname":"Spoke","x-ves-oneof-field-spoke_hub_mesh_choice":"[\"control_and_data_plane_mesh\",\"data_plane_mesh\"]","x-ves-proto-message":"ves.io.schema.site_mesh_group.SpokeMeshGroupType","properties":{"control_and_data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_plane_mesh":{"$ref":"#/components/schemas/ioschemaEmpty"},"hub_mesh_group":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"site_mesh_groupStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Site Mesh Group status","x-displayname":"Status Object","x-ves-proto-message":"ves.io.schema.site_mesh_group.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions reported by various components of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Object reference","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"},"site_mesh_group_status":{"$ref":"#/components/schemas/schemaSiteMeshGroupStatus"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.status_at_site","description":"Any user configured object in F5XC Edge Cloud has a status object associated with that it.\nAn object may be created in multiple sites and therefore it is desirable to have the ability\nto get the current status of the configured object in a given site.","version":""},"paths":{"/api/data/namespaces/{namespace}/{kind}/{name}/status_at_site":{"get":{"summary":"Get Status","description":"Get status of an object in a given site.","operationId":"ves.io.schema.status_at_site.CustomAPI.GetStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/status_at_siteStatusResponse"}}}},"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-required\nx-example: \"bookinfo\"\nNamespace of the configured object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"kind","description":"Kind\n\nx-required\nx-example: \"virtual_host\"\nObject type","in":"path","required":true,"x-displayname":"Kind","schema":{"type":"string"}},{"name":"name","description":"Name\n\nx-required\nx-example: \"productpage\"\nObject name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"site","description":"x-required\nx-example: \"ce01\"\nSite name","in":"query","required":false,"x-displayname":"Site","schema":{"type":"string"}},{"name":"site_type","description":"Site type indicates whether the site is CE or RE\noptional: If not specified, the value for site_type defaults to CUSTOMER_EDGE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site","in":"query","required":false,"x-displayname":"NginxOne","schema":{"type":"string","enum":["INVALID","REGIONAL_EDGE","CUSTOMER_EDGE","NGINX_ONE"],"default":"INVALID"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-status_at_site-customapi-getstatus"},"x-ves-proto-rpc":"ves.io.schema.status_at_site.CustomAPI.GetStatus"},"x-displayname":"Status at site","x-ves-proto-service":"ves.io.schema.status_at_site.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Status at site","x-ves-proto-package":"ves.io.schema.status_at_site","components":{"schemas":{"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"}}},"siteSiteType":{"type":"string","description":"x-displayName: \"Site Type\"\nSite Type which can either RE or CE\n\n - INVALID: x-displayName: \"Invalid\"\nInvalid type of site\n - REGIONAL_EDGE: x-displayName: \"RE\"\nRegional Edge site\n - CUSTOMER_EDGE: x-displayName: \"CE\"\nCustomer Edge site\n - NGINX_ONE: x-displayName: \"NginxOne\"","title":"SiteType","enum":["INVALID","REGIONAL_EDGE","CUSTOMER_EDGE","NGINX_ONE"],"default":"INVALID"},"status_at_siteStatusResponse":{"type":"object","description":"Status Response for a configured object in a site.","title":"Status Response","x-displayname":"Status Response","x-ves-proto-message":"ves.io.schema.status_at_site.StatusResponse","properties":{"conditions":{"type":"array","description":" List of conditions for the requested object in a given site.","title":"Conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"error":{"$ref":"#/components/schemas/schemaErrorType"}}}}}}

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.stored_object","version":""},"paths":{"/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield":{"get":{"summary":"Get List Of Mobile App Shields","description":"ListMobileAppShields is an API to list all mobile app shields available for download.","operationId":"ves.io.schema.stored_object.MobileAppShieldCustomAPI.ListMobileAppShields","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectListObjectsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"x-example: \"swagger\"\nOptional query parameter. Type of the stored_object","in":"query","required":false,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"x-example: \"my-file, shared/my-file, my-ns/my-file\"\nOptional query parameter. Name of the stored_object","in":"query","required":false,"x-displayname":"Name","schema":{"type":"string"}},{"name":"query_type","description":"Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n - EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n - PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.","in":"query","required":false,"x-displayname":"PREFIX MATCH","schema":{"type":"string","enum":["EXACT_MATCH","PREFIX_MATCH"],"default":"EXACT_MATCH"}},{"name":"latest_version_only","description":"Optional query parameter. If passed, returns only latest version of the objects.","in":"query","required":false,"x-displayname":"Latest Versions Only","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-mobileappshieldcustomapi-listmobileappshields"},"x-ves-proto-rpc":"ves.io.schema.stored_object.MobileAppShieldCustomAPI.ListMobileAppShields"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.MobileAppShieldCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield/{name}/{version}":{"get":{"summary":"Get Mobile App Shield","description":"GetMobileAppShield is an API to download particular version of mobile app shield","operationId":"ves.io.schema.stored_object.MobileAppShieldCustomAPI.GetMobileAppShield","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectGetObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"version","description":"version\n\nx-example: \"v0-21-09-13\"\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.","in":"path","required":true,"x-displayname":"Version","schema":{"type":"string"}},{"name":"object_type","description":"x-example: \"swagger\"\nx-required\nType of the stored_object","in":"query","required":false,"x-displayname":"Object Type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-mobileappshieldcustomapi-getmobileappshield"},"x-ves-proto-rpc":"ves.io.schema.stored_object.MobileAppShieldCustomAPI.GetMobileAppShield"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.MobileAppShieldCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator":{"get":{"summary":"Get List Of Mobile Integrators","description":"ListMobileIntegrators is an API to list all mobile integrators available for download.","operationId":"ves.io.schema.stored_object.MobileIntegratorCustomAPI.ListMobileIntegrators","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectListObjectsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"x-example: \"swagger\"\nOptional query parameter. Type of the stored_object","in":"query","required":false,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"x-example: \"my-file, shared/my-file, my-ns/my-file\"\nOptional query parameter. Name of the stored_object","in":"query","required":false,"x-displayname":"Name","schema":{"type":"string"}},{"name":"query_type","description":"Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n - EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n - PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.","in":"query","required":false,"x-displayname":"PREFIX MATCH","schema":{"type":"string","enum":["EXACT_MATCH","PREFIX_MATCH"],"default":"EXACT_MATCH"}},{"name":"latest_version_only","description":"Optional query parameter. If passed, returns only latest version of the objects.","in":"query","required":false,"x-displayname":"Latest Versions Only","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-mobileintegratorcustomapi-listmobileintegrators"},"x-ves-proto-rpc":"ves.io.schema.stored_object.MobileIntegratorCustomAPI.ListMobileIntegrators"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.MobileIntegratorCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator/{name}/{version}":{"get":{"summary":"Get Mobile Integrator","description":"GetMobileIntegrator is an API to download particular version of Integrator","operationId":"ves.io.schema.stored_object.MobileIntegratorCustomAPI.GetMobileIntegrator","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectGetObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"version","description":"version\n\nx-example: \"v0-21-09-13\"\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.","in":"path","required":true,"x-displayname":"Version","schema":{"type":"string"}},{"name":"object_type","description":"x-example: \"swagger\"\nx-required\nType of the stored_object","in":"query","required":false,"x-displayname":"Object Type","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-mobileintegratorcustomapi-getmobileintegrator"},"x-ves-proto-rpc":"ves.io.schema.stored_object.MobileIntegratorCustomAPI.GetMobileIntegrator"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.MobileIntegratorCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/{object_type}":{"get":{"summary":"Get List Of Stored Objects","description":"ListObjects is an API to list objects in object store","operationId":"ves.io.schema.stored_object.CustomAPI.ListObjects","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectListObjectsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"object_type\n\nx-example: \"swagger\"\nOptional query parameter. Type of the stored_object","in":"path","required":true,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"x-example: \"my-file, shared/my-file, my-ns/my-file\"\nOptional query parameter. Name of the stored_object","in":"query","required":false,"x-displayname":"Name","schema":{"type":"string"}},{"name":"query_type","description":"Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n - EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n - PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.","in":"query","required":false,"x-displayname":"PREFIX MATCH","schema":{"type":"string","enum":["EXACT_MATCH","PREFIX_MATCH"],"default":"EXACT_MATCH"}},{"name":"latest_version_only","description":"Optional query parameter. If passed, returns only latest version of the objects.","in":"query","required":false,"x-displayname":"Latest Versions Only","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-customapi-listobjects"},"x-ves-proto-rpc":"ves.io.schema.stored_object.CustomAPI.ListObjects"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}":{"delete":{"summary":"Delete Stored Object(s)","description":"DeleteObjects is an API to delete object(s) in object store","operationId":"ves.io.schema.stored_object.CustomAPI.DeleteObject","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectDeleteObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"object_type\n\nx-example: \"swagger\"\nx-required\nType of the stored_object","in":"path","required":true,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"version","description":"x-example: \"v1-21-01-12\"\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.","in":"query","required":false,"x-displayname":"Version","schema":{"type":"string"}},{"name":"force_delete","description":"x-example: \"value\"\nOptional query parameter. If provided will delete all the versions of the specified object.","in":"query","required":false,"x-displayname":"Force Delete","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-customapi-deleteobject"},"x-ves-proto-rpc":"ves.io.schema.stored_object.CustomAPI.DeleteObject"},"put":{"summary":"Create Stored Object","description":"CreateObject is an API to upload an object to generic object store. Objects are immutable, a new version is created when the content is updated.","operationId":"ves.io.schema.stored_object.CustomAPI.CreateObject","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectCreateObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace in which object is to be created","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"object_type\n\nx-example: \"swagger\"\nx-required\nType of the stored_object","in":"path","required":true,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectCreateObjectRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-customapi-createobject"},"x-ves-proto-rpc":"ves.io.schema.stored_object.CustomAPI.CreateObject"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}/{version}":{"get":{"summary":"Get Stored Object","description":"GetObject is an API to download an object from object store","operationId":"ves.io.schema.stored_object.CustomAPI.GetObject","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectGetObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"object_type\n\nx-example: \"swagger\"\nx-required\nType of the stored_object","in":"path","required":true,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"version","description":"version\n\nx-example: \"v0-21-09-13\"\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.","in":"path","required":true,"x-displayname":"Version","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-customapi-getobject"},"x-ves-proto-rpc":"ves.io.schema.stored_object.CustomAPI.GetObject"},"delete":{"summary":"Delete Stored Object(s)","description":"DeleteObjects is an API to delete object(s) in object store","operationId":"ves.io.schema.stored_object.CustomAPI.DeleteObject","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/stored_objectDeleteObjectResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"system\"\nx-required\nNamespace of the stored_object","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"object_type","description":"object_type\n\nx-example: \"swagger\"\nx-required\nType of the stored_object","in":"path","required":true,"x-displayname":"Object Type","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"volt-api-specs\"\nx-required\nName of the stored_object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"version","description":"version\n\nx-example: \"v1-21-01-12\"\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.","in":"path","required":true,"x-displayname":"Version","schema":{"type":"string"}},{"name":"force_delete","description":"x-example: \"value\"\nOptional query parameter. If provided will delete all the versions of the specified object.","in":"query","required":false,"x-displayname":"Force Delete","schema":{"type":"boolean","format":"boolean"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-stored_object-customapi-deleteobject"},"x-ves-proto-rpc":"ves.io.schema.stored_object.CustomAPI.DeleteObject"},"x-displayname":"Stored Object","x-ves-proto-service":"ves.io.schema.stored_object.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Stored Object","x-ves-proto-package":"ves.io.schema.stored_object","components":{"schemas":{"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"},"schemaHttpMethod":{"type":"string","description":"Specifies the HTTP method used to access a resource.\n\nAny HTTP Method","title":"HttpMethod","enum":["ANY","GET","HEAD","POST","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH","COPY"],"default":"ANY","x-displayname":"HTTP Method","x-ves-proto-enum":"ves.io.schema.HttpMethod"},"stored_objectCreateObjectRequest":{"type":"object","description":"Request message for CreateObject API","title":"CreateObjectRequest","x-displayname":"Create Object Request","x-ves-oneof-field-contents":"[\"bytes_value\",\"string_value\"]","x-ves-oneof-field-object_attributes":"[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"no_attributes\"]","x-ves-proto-message":"ves.io.schema.stored_object.CreateObjectRequest","properties":{"bytes_value":{"type":"string","description":"Exclusive with [string_value]\n Binary object contents. Should be encoded in base64 scheme.\n\nValidation Rules:\n  ves.io.schema.rules.bytes.max_len: 5242880\n","title":"bytes_value","format":"byte","maximum":5242880,"x-displayname":"Byte Value","x-ves-validation-rules":{"ves.io.schema.rules.bytes.max_len":"5242880"}},"content_format":{"type":"string","description":" The optional content format associated with object\n\nExample: ` \"json, yaml\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]\n","title":"content_format","x-displayname":"Content Format","x-ves-example":"json, yaml","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]"}},"description":{"type":"string","description":" The optional description associated with object\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n","title":"description","maxLength":512,"x-displayname":"Description","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512"}},"mobile_app_shield":{"$ref":"#/components/schemas/stored_objectMobileAppShieldAttributes"},"mobile_integrator":{"$ref":"#/components/schemas/stored_objectMobileIntegratorAttributes"},"mobile_sdk":{"$ref":"#/components/schemas/stored_objectMobileSDKAttributes"},"name":{"type":"string","description":" Name of the stored_object.\n\nExample: ` \"volt-api-specs\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 512\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"name","minLength":1,"maxLength":512,"x-displayname":"Name","x-ves-example":"volt-api-specs","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"512","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.ves_object_name":"true"}},"namespace":{"type":"string","description":" Namespace in which object is to be created\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"namespace","x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"no_attributes":{"$ref":"#/components/schemas/schemaEmpty"},"object_type":{"type":"string","description":" Type of the stored_object\n\nExample: ` \"swagger\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\"]\n","title":"object_type","x-displayname":"Object Type","x-ves-example":"swagger","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\"]"}},"string_value":{"type":"string","description":"Exclusive with [bytes_value]\n String formatted contents\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 5242880\n","title":"contents","maxLength":5242880,"x-displayname":"String Value","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"5242880"}}}},"stored_objectCreateObjectResponse":{"type":"object","description":"Response message for CreateObject API","title":"CreateObjectResponse","x-displayname":"Create Object Response","x-ves-oneof-field-additional_info":"[\"no_additional_info\",\"presigned_url\"]","x-ves-proto-message":"ves.io.schema.stored_object.CreateObjectResponse","properties":{"metadata":{"$ref":"#/components/schemas/stored_objectStoredObjectDescriptor"},"no_additional_info":{"$ref":"#/components/schemas/schemaEmpty"},"presigned_url":{"$ref":"#/components/schemas/stored_objectPreSignedUrl"},"status":{"$ref":"#/components/schemas/stored_objectStoredObjectResponseStatus"}}},"stored_objectDeleteObjectResponse":{"type":"object","description":"Response for DeleteObjects API","title":"DeleteObjectResponse","x-displayname":"Delete Objects Response","x-ves-proto-message":"ves.io.schema.stored_object.DeleteObjectResponse","properties":{"deleted_objects":{"type":"array","description":" Names of Deleted Object\n\nExample: ` \"value\"`","title":"deleted_objects","items":{"type":"string"},"x-displayname":"Deleted Object Names","x-ves-example":"value"}}},"stored_objectGetObjectResponse":{"type":"object","description":"Response message for GetObject API","title":"GetObjectResponse","x-displayname":"Get Object Response","x-ves-oneof-field-contents":"[\"bytes_value\",\"presigned_url\",\"string_value\"]","x-ves-proto-message":"ves.io.schema.stored_object.GetObjectResponse","properties":{"bytes_value":{"type":"string","description":"Exclusive with [presigned_url string_value]\n Binary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object.\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.bytes.max_len: 5242880\n","title":"bytes_value","format":"byte","maximum":5242880,"x-displayname":"Byte Value","x-ves-validation-rules":{"ves.io.schema.rules.bytes.max_len":"5242880"}},"content_format":{"type":"string","description":" The optional content format associated with object\n\nExample: ` \"json, yaml\"`","title":"content_format","x-displayname":"Content Format","x-ves-example":"json, yaml"},"metadata":{"$ref":"#/components/schemas/stored_objectStoredObjectDescriptor"},"presigned_url":{"$ref":"#/components/schemas/stored_objectPreSignedUrl"},"string_value":{"type":"string","description":"Exclusive with [bytes_value presigned_url]\n String formatted contents\n\nExample: ` \"\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 5242880\n","title":"contents","maxLength":5242880,"x-displayname":"Contents","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"5242880"}}}},"stored_objectListItemDescriptor":{"type":"object","description":"A descriptor for list response item.","title":"ListItemDescriptor","x-displayname":"List Item Descriptor","x-ves-oneof-field-object_attributes":"[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"no_attributes\"]","x-ves-proto-message":"ves.io.schema.stored_object.ListItemDescriptor","properties":{"mobile_app_shield":{"$ref":"#/components/schemas/stored_objectMobileAppShieldAttributes"},"mobile_integrator":{"$ref":"#/components/schemas/stored_objectMobileIntegratorAttributes"},"mobile_sdk":{"$ref":"#/components/schemas/stored_objectMobileSDKAttributes"},"name":{"type":"string","description":" Name of the stored object.","title":"name","x-displayname":"Object Name"},"no_attributes":{"$ref":"#/components/schemas/schemaEmpty"},"tenant":{"type":"string","description":" Tenant to which this object belongs.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"versions":{"type":"array","description":" Available versions for the stored object.","title":"versions","items":{"$ref":"#/components/schemas/stored_objectVersionDescriptor"},"x-displayname":"Versions"}}},"stored_objectListObjectsResponse":{"type":"object","description":"Response for GetListOfObjects API","title":"ListObjectsResponse","x-displayname":"List Objects Response","x-ves-proto-message":"ves.io.schema.stored_object.ListObjectsResponse","properties":{"items":{"type":"array","description":" Stored object names and available versions for each object.","title":"list of store object descriptors","items":{"$ref":"#/components/schemas/stored_objectListItemDescriptor"},"x-displayname":"Stored Object Descriptors"}}},"stored_objectMobileAppShieldAttributes":{"type":"object","description":"Describes attributes specific to object type - mobile-app-shield","title":"MobileAppShieldAttributes","x-displayname":"mobile-app-shield attributes","x-ves-proto-message":"ves.io.schema.stored_object.MobileAppShieldAttributes","properties":{"os_type":{"$ref":"#/components/schemas/stored_objectOSType"},"release_version":{"type":"string","description":" Version of mobile app shield release\n\nExample: ` \"v.4.2.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 32\n  ves.io.schema.rules.string.not_empty: true\n","title":"release_version","maxLength":32,"x-displayname":"mobile app shield release version","x-ves-example":"v.4.2.1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"32","ves.io.schema.rules.string.not_empty":"true"}}}},"stored_objectMobileIntegratorAttributes":{"type":"object","description":"Describes attributes specific to object type - mobile-integrator","title":"MobileIntegratorAttributes","x-displayname":"mobile-integrator attributes","x-ves-proto-message":"ves.io.schema.stored_object.MobileIntegratorAttributes","properties":{"os_type":{"$ref":"#/components/schemas/stored_objectOSType"},"release_version":{"type":"string","description":" Version of mobile integrator release\n\nExample: ` \"v.4.2.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 32\n  ves.io.schema.rules.string.not_empty: true\n","title":"release_version","maxLength":32,"x-displayname":"mobile integrator release version","x-ves-example":"v.4.2.1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"32","ves.io.schema.rules.string.not_empty":"true"}}}},"stored_objectMobileSDKAttributes":{"type":"object","description":"Describes attributes specific to object type - mobile-sdk","title":"MobileSDKAttributes","x-displayname":"mobile-sdk attributes","x-ves-proto-message":"ves.io.schema.stored_object.MobileSDKAttributes","properties":{"os_type":{"$ref":"#/components/schemas/stored_objectOSType"},"release_version":{"type":"string","description":" Version of mobile sdk release\n\nExample: ` \"v.4.2.1\"`","title":"release_version","x-displayname":"mobile sdk release version","x-ves-example":"v.4.2.1"}}},"stored_objectOSType":{"type":"string","description":"Defines a selection for operating system type. Its either ANDROID or IOS\n\n - ANDROID: ANDROID\n\n - IOS: IOS\n","title":"OSType","enum":["ANDROID","IOS"],"default":"ANDROID","x-displayname":"Operating System type","x-ves-proto-enum":"ves.io.schema.stored_object.OSType"},"stored_objectPreSignedUrl":{"type":"object","description":"Pre signed url","title":"PreSignedUrl","x-displayname":"Pre Signed Url","x-ves-oneof-field-storage_provider_choice":"[\"aws\"]","x-ves-proto-message":"ves.io.schema.stored_object.PreSignedUrl","properties":{"aws":{"$ref":"#/components/schemas/stored_objectPresignedUrlData"}}},"stored_objectPresignedUrlData":{"type":"object","description":"Pre signed url data","title":"PresignedUrlData","x-displayname":"Pre Signed Url Data","x-ves-proto-message":"ves.io.schema.stored_object.PresignedUrlData","properties":{"method":{"$ref":"#/components/schemas/schemaHttpMethod"},"url":{"type":"string","description":" The url to upload or download the resource","title":"url","x-displayname":"url"}}},"stored_objectQueryType":{"type":"string","description":"x-displayName: \"Query Type\"\nThe type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object having the 'name' as prefix. Default is EXACT_MATCH.\n\n - EXACT_MATCH: EXACT_MATCH\n\nx-displayName: \"EXACT MATCH\"\nReturns list of objects with exact match on the name filed.\n - PREFIX_MATCH: PREFIX_MATCH\n\nx-displayName: \"PREFIX MATCH\"\nReturns the list of object matching the 'name' prefix.","title":"QueryType","enum":["EXACT_MATCH","PREFIX_MATCH"],"default":"EXACT_MATCH"},"stored_objectStoredObjectDescriptor":{"type":"object","description":"Response for Get, Create APIs","title":"StoredObjectDescriptor","x-displayname":"Object Metadata Response","x-ves-oneof-field-object_attributes":"[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"no_attributes\"]","x-ves-proto-message":"ves.io.schema.stored_object.StoredObjectDescriptor","properties":{"creation_timestamp":{"type":"string","description":" Creation date & time for the object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"description":{"type":"string","description":" Optional field, the Description for the object\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n","title":"description","maxLength":512,"x-displayname":"description","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512"}},"mobile_app_shield":{"$ref":"#/components/schemas/stored_objectMobileAppShieldAttributes"},"mobile_integrator":{"$ref":"#/components/schemas/stored_objectMobileIntegratorAttributes"},"mobile_sdk":{"$ref":"#/components/schemas/stored_objectMobileSDKAttributes"},"name":{"type":"string","description":" Name of the stored object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace of the stored object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"namespace","x-displayname":"Namespace","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"no_attributes":{"$ref":"#/components/schemas/schemaEmpty"},"url":{"type":"string","description":" Url of the stored object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"url","x-displayname":"Url","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"version":{"type":"string","description":" Version of the stored object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"version","x-displayname":"Version","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"stored_objectStoredObjectResponseStatus":{"type":"string","description":"The stored object status represents status of create object response if object got created, updated or already exists.","title":"StoredObjectResponseStatus","enum":["STORED_OBJECT_STATUS_NONE","STORED_OBJECT_STATUS_CREATED","STORED_OBJECT_STATUS_UPDATED","STORED_OBJECT_STATUS_ALREADY_EXISTS"],"default":"STORED_OBJECT_STATUS_NONE","x-displayname":"","x-ves-proto-enum":"ves.io.schema.stored_object.StoredObjectResponseStatus"},"stored_objectVersionDescriptor":{"type":"object","description":"Descriptor for store object version.","title":"VersionDescriptor","x-displayname":"Version Descriptor","x-ves-proto-message":"ves.io.schema.stored_object.VersionDescriptor","properties":{"creation_timestamp":{"type":"string","description":" Creation date & time for the object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"description":{"type":"string","description":" Optional field, the Description for the object\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 512\n","title":"description","maxLength":512,"x-displayname":"description","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"512"}},"latest_version":{"type":"boolean","description":" A tag representing if this is the latest version for the object.","title":"latest_version","format":"boolean","x-displayname":"Latest Version"},"url":{"type":"string","description":" Url of the stored object\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"url","x-displayname":"Url","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"version":{"type":"string","description":" Version of the stored object.","title":"version","x-displayname":"Version"}}}}}}