From 71252bae2888e53526fe7489a106951d90a9e331 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 7 Apr 2021 11:44:24 -0600 Subject: [PATCH] updated cloud api swagger (#2395) --- api-docs/cloud/swagger.yml | 29 +++++++++++++++++++++++------ api-docs/cloud/swaggerV1Compat.yml | 2 +- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/api-docs/cloud/swagger.yml b/api-docs/cloud/swagger.yml index 8aa0e4c1a..f359aa1fe 100644 --- a/api-docs/cloud/swagger.yml +++ b/api-docs/cloud/swagger.yml @@ -7297,9 +7297,13 @@ components: - expire everySeconds: type: integer - description: Duration in seconds for how long data will be kept in the database. + description: Duration in seconds for how long data will be kept in the database. 0 means infinite. example: 86400 - minimum: 1 + minimum: 0 + shardGroupDurationSeconds: + type: integer + format: int64 + description: Shard duration measured in seconds. required: [type, everySeconds] Link: type: string @@ -9241,6 +9245,12 @@ components: xTickStep: type: number format: float + yLabelColumnSeparator: + type: string + yLabelColumns: + type: array + items: + type: string ySeriesColumns: type: array items: @@ -9271,6 +9281,9 @@ components: type: string ySuffix: type: string + hoverDimension: + type: string + enum: [auto, x, y, xy] legendColorizeRows: type: boolean legendOpacity: @@ -11134,8 +11147,14 @@ components: type: string bucket: type: string + retentionPeriodSeconds: + type: integer retentionPeriodHrs: type: integer + deprecated: true + description: > + Retention period *in nanoseconds* for the new bucket. This key's name has been misleading since OSS 2.0 GA, + please transition to use `retentionPeriodSeconds` required: - username - org @@ -11741,7 +11760,7 @@ components: type: string operator: type: string - enum: ["equal"] + enum: ["equal", "notequal", "equalregex", "notequalregex"] StatusRule: type: object properties: @@ -12036,12 +12055,10 @@ components: - retention_policy DBRPs: properties: - notificationEndpoints: + content: type: array items: $ref: "#/components/schemas/DBRP" - links: - $ref: "#/components/schemas/Links" DBRPUpdate: properties: database: diff --git a/api-docs/cloud/swaggerV1Compat.yml b/api-docs/cloud/swaggerV1Compat.yml index b281383be..9721e6493 100644 --- a/api-docs/cloud/swaggerV1Compat.yml +++ b/api-docs/cloud/swaggerV1Compat.yml @@ -118,7 +118,7 @@ paths: name: Accept schema: type: string - description: Specifies how query results should be encoded in the response. **Note:** When using `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps. + description: Specifies how query results should be encoded in the response. default: application/json enum: - application/json