diff --git a/api-docs/v2.0/swagger.yml b/api-docs/v2.0/swagger.yml index a481596f8..de269f28c 100644 --- a/api-docs/v2.0/swagger.yml +++ b/api-docs/v2.0/swagger.yml @@ -12,17 +12,17 @@ paths: security: - BasicAuth: [] parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '204': + "204": description: Successfully authenticated - '401': + "401": description: Unauthorized access content: application/json: schema: $ref: "#/components/schemas/Error" - '403': + "403": description: user account is disabled content: application/json: @@ -39,11 +39,11 @@ paths: operationId: PostSignout summary: Expire the current session parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '204': + "204": description: Session successfully expired - '401': + "401": description: Unauthorized access content: application/json: @@ -60,7 +60,7 @@ paths: operationId: GetRoutes summary: Map of all top level routes available parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: default: description: All routes @@ -76,11 +76,10 @@ paths: summary: Check if database has default user, org, bucket description: Returns `true` if no default user, organization, or bucket has been created. parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': - description: - allowed true or false + "200": + description: allowed true or false content: application/json: schema: @@ -92,7 +91,7 @@ paths: summary: Set up initial user, org and bucket description: Post an onboarding request to set up initial user, org and bucket. parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Source to create required: true @@ -101,31 +100,37 @@ paths: schema: $ref: "#/components/schemas/OnboardingRequest" responses: - '201': + "201": description: Created default user, bucket, org content: application/json: schema: $ref: "#/components/schemas/OnboardingResponse" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" /documents/templates: get: operationId: GetDocumentsTemplates tags: - Templates parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: org - description: Specifies the name of the organization of the template. - schema: - type: string - - in: query - name: orgID - description: Specifies the organization ID of the template. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: org + description: Specifies the name of the organization of the template. + schema: + type: string + - in: query + name: orgID + description: Specifies the organization ID of the template. + schema: + type: string responses: - '200': + "200": description: A list of template documents content: application/json: @@ -143,7 +148,7 @@ paths: - Templates summary: Create a template parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Template that will be created required: true @@ -152,7 +157,7 @@ paths: schema: $ref: "#/components/schemas/DocumentCreate" responses: - '201': + "201": description: Template created content: application/json: @@ -164,13 +169,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/documents/templates/{templateID}': + "/documents/templates/{templateID}": get: operationId: GetDocumentsTemplatesID tags: - Templates parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -178,7 +183,7 @@ paths: required: true description: The template ID. responses: - '200': + "200": description: The template requested content: application/json: @@ -195,7 +200,7 @@ paths: tags: - Templates parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -210,7 +215,7 @@ paths: schema: $ref: "#/components/schemas/DocumentUpdate" responses: - '200': + "200": description: The newly updated template content: application/json: @@ -228,7 +233,7 @@ paths: - Templates summary: Delete a template parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -236,7 +241,7 @@ paths: required: true description: The template ID. responses: - '204': + "204": description: Delete has been accepted default: description: Unexpected error @@ -244,14 +249,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/documents/templates/{templateID}/labels': + "/documents/templates/{templateID}/labels": get: operationId: GetDocumentsTemplatesIDLabels tags: - Templates summary: List all labels for a template parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -259,7 +264,7 @@ paths: required: true description: The template ID. responses: - '200': + "200": description: A list of all labels for a template content: application/json: @@ -277,7 +282,7 @@ paths: - Templates summary: Add a label to a template parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -292,7 +297,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label added to the template content: application/json: @@ -304,14 +309,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/documents/templates/{templateID}/labels/{labelID}': + "/documents/templates/{templateID}/labels/{labelID}": delete: operationId: DeleteDocumentsTemplatesIDLabelsID tags: - Templates summary: Delete a label from a template parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: templateID schema: @@ -325,9 +330,9 @@ paths: required: true description: The label ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Template not found content: application/json: @@ -339,18 +344,233 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + /dbrps: + get: + operationId: GetDPRPs + tags: + - DBRPs + summary: List all database retention policy mappings + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + required: true + description: Specifies the organization ID to filter on + schema: + type: string + - in: query + name: id + description: Specifies the mapping ID to filter on + schema: + type: string + - in: query + name: bucketID + description: Specifies the bucket ID to filter on + schema: + type: string + - in: query + name: default + description: Specifies filtering on default + schema: + type: boolean + - in: query + name: db + description: Specifies the database to filter on + schema: + type: string + - in: query + name: rp + description: Specifies the retention policy to filter on + schema: + type: string + responses: + "200": + description: A list of all database retention policy mappings + content: + application/json: + schema: + $ref: "#/components/schemas/DBRPs" + "400": + description: if any of the parameter passed is invalid + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + post: + operationId: PostDBRP + tags: + - DBRPs + summary: Add a database retention policy mapping + parameters: + - $ref: "#/components/parameters/TraceSpan" + requestBody: + description: The database retention policy mapping to add + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DBRP" + responses: + "201": + description: Database retention policy mapping created + content: + application/json: + schema: + $ref: "#/components/schemas/DBRP" + "400": + description: if any of the IDs in the mapping is invalid + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/dprps/{dbrpID}": + get: + operationId: GetDBRPsID + tags: + - DBRPs + summary: Retrieve a database retention policy mapping + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + required: true + description: Specifies the organization ID of the mapping + schema: + type: string + - in: path + name: dbrpID + schema: + type: string + required: true + description: The database retention policy mapping ID + responses: + "200": + description: The database retention policy requested + content: + application/json: + schema: + $ref: "#/components/schemas/DBRP" + "400": + description: if any of the IDs passed is invalid + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + patch: + operationId: PatchDBRPID + tags: + - DBRPs + summary: Update a database retention policy mapping + requestBody: + description: Database retention policy update to apply + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DBRPUpdate" + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + required: true + description: Specifies the organization ID of the mapping + schema: + type: string + - in: path + name: dbrpID + schema: + type: string + required: true + description: The database retention policy mapping. + responses: + "200": + description: An updated mapping + content: + application/json: + schema: + $ref: "#/components/schemas/DBRP" + "404": + description: The mapping was not found + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "400": + description: if any of the IDs passed is invalid + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + delete: + operationId: DeleteDBRPID + tags: + - DBRPs + summary: Delete a database retention policy + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + required: true + description: Specifies the organization ID of the mapping + schema: + type: string + - in: path + name: dbrpID + schema: + type: string + required: true + description: The database retention policy mapping + responses: + "204": + description: Delete has been accepted + "400": + description: if any of the IDs passed is invalid + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" /telegraf/plugins: get: operationId: GetTelegrafPlugins parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: type - description: The type of plugin desired. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: type + description: The type of plugin desired. + schema: + type: string responses: - '200': + "200": description: A list of Telegraf plugins. content: application/json: @@ -368,14 +588,14 @@ paths: tags: - Telegrafs parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: orgID - description: The organization ID the Telegraf config belongs to. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + description: The organization ID the Telegraf config belongs to. + schema: + type: string responses: - '200': + "200": description: A list of Telegraf configs content: application/json: @@ -393,7 +613,7 @@ paths: - Telegrafs summary: Create a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Telegraf config to create required: true @@ -402,7 +622,7 @@ paths: schema: $ref: "#/components/schemas/TelegrafRequest" responses: - '201': + "201": description: Telegraf config created content: application/json: @@ -414,14 +634,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}': + "/telegrafs/{telegrafID}": get: operationId: GetTelegrafsID tags: - Telegrafs summary: Retrieve a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -439,7 +659,7 @@ paths: - application/json - application/octet-stream responses: - '200': + "200": description: Telegraf config details content: application/toml: @@ -465,7 +685,7 @@ paths: - Telegrafs summary: Update a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -480,7 +700,7 @@ paths: schema: $ref: "#/components/schemas/TelegrafRequest" responses: - '200': + "200": description: An updated Telegraf config content: application/json: @@ -498,7 +718,7 @@ paths: - Telegrafs summary: Delete a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -506,7 +726,7 @@ paths: required: true description: The Telegraf config ID. responses: - '204': + "204": description: Delete has been accepted default: description: Unexpected error @@ -514,14 +734,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/labels': + "/telegrafs/{telegrafID}/labels": get: operationId: GetTelegrafsIDLabels tags: - Telegrafs summary: List all labels for a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -529,7 +749,7 @@ paths: required: true description: The Telegraf config ID. responses: - '200': + "200": description: A list of all labels for a Telegraf config content: application/json: @@ -547,7 +767,7 @@ paths: - Telegrafs summary: Add a label to a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -562,7 +782,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label added to the Telegraf config content: application/json: @@ -574,14 +794,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/labels/{labelID}': + "/telegrafs/{telegrafID}/labels/{labelID}": delete: operationId: DeleteTelegrafsIDLabelsID tags: - Telegrafs summary: Delete a label from a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -595,9 +815,9 @@ paths: required: true description: The label ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Telegraf config not found content: application/json: @@ -609,7 +829,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/members': + "/telegrafs/{telegrafID}/members": get: operationId: GetTelegrafsIDMembers tags: @@ -617,7 +837,7 @@ paths: - Telegrafs summary: List all users with member privileges for a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -625,7 +845,7 @@ paths: required: true description: The Telegraf config ID. responses: - '200': + "200": description: A list of Telegraf config members content: application/json: @@ -644,7 +864,7 @@ paths: - Telegrafs summary: Add a member to a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -659,7 +879,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Member added to Telegraf config content: application/json: @@ -671,7 +891,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/members/{userID}': + "/telegrafs/{telegrafID}/members/{userID}": delete: operationId: DeleteTelegrafsIDMembersID tags: @@ -679,7 +899,7 @@ paths: - Telegrafs summary: Remove a member from a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -693,7 +913,7 @@ paths: required: true description: The Telegraf config ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -701,7 +921,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/owners': + "/telegrafs/{telegrafID}/owners": get: operationId: GetTelegrafsIDOwners tags: @@ -709,7 +929,7 @@ paths: - Telegrafs summary: List all owners of a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -717,7 +937,7 @@ paths: required: true description: The Telegraf config ID. responses: - '200': + "200": description: A list of Telegraf config owners content: application/json: @@ -736,7 +956,7 @@ paths: - Telegrafs summary: Add an owner to a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: telegrafID schema: @@ -751,7 +971,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Telegraf config owner added content: application/json: @@ -763,7 +983,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/telegrafs/{telegrafID}/owners/{userID}': + "/telegrafs/{telegrafID}/owners/{userID}": delete: operationId: DeleteTelegrafsIDOwnersID tags: @@ -771,7 +991,7 @@ paths: - Telegrafs summary: Remove an owner from a Telegraf config parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -785,7 +1005,7 @@ paths: required: true description: The Telegraf config ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -800,31 +1020,31 @@ paths: - ScraperTargets summary: Get all scraper targets parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: name - description: Specifies the name of the scraper target. - schema: - type: string - - in: query - name: id - description: List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. - schema: - type: array - items: - type: string - - in: query - name: orgID - description: Specifies the organization ID of the scraper target. - schema: - type: string - - in: query - name: org - description: Specifies the organization name of the scraper target. - schema: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: name + description: Specifies the name of the scraper target. + schema: + type: string + - in: query + name: id + description: List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. + schema: + type: array + items: type: string + - in: query + name: orgID + description: Specifies the organization ID of the scraper target. + schema: + type: string + - in: query + name: org + description: Specifies the organization name of the scraper target. + schema: + type: string responses: - '200': + "200": description: All scraper targets content: application/json: @@ -836,7 +1056,7 @@ paths: tags: - ScraperTargets parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Scraper target to create required: true @@ -845,7 +1065,7 @@ paths: schema: $ref: "#/components/schemas/ScraperTargetRequest" responses: - '201': + "201": description: Scraper target created content: application/json: @@ -857,14 +1077,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}': + "/scrapers/{scraperTargetID}": get: operationId: GetScrapersID tags: - ScraperTargets summary: Get a scraper target by ID parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID required: true @@ -872,7 +1092,7 @@ paths: type: string description: The scraper target ID. responses: - '200': + "200": description: Scraper target updated content: application/json: @@ -890,7 +1110,7 @@ paths: - ScraperTargets summary: Delete a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID required: true @@ -898,7 +1118,7 @@ paths: type: string description: The scraper target ID. responses: - '204': + "204": description: Scraper target deleted default: description: Internal server error @@ -912,7 +1132,7 @@ paths: tags: - ScraperTargets parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID required: true @@ -927,7 +1147,7 @@ paths: schema: $ref: "#/components/schemas/ScraperTargetRequest" responses: - '200': + "200": description: Scraper target updated content: application/json: @@ -939,14 +1159,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/labels': + "/scrapers/{scraperTargetID}/labels": get: operationId: GetScrapersIDLabels tags: - ScraperTargets summary: List all labels for a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -954,7 +1174,7 @@ paths: required: true description: The scraper target ID. responses: - '200': + "200": description: A list of all labels for a scraper target content: application/json: @@ -972,7 +1192,7 @@ paths: - ScraperTargets summary: Add a label to a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -987,7 +1207,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The newly added label content: application/json: @@ -999,14 +1219,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/labels/{labelID}': + "/scrapers/{scraperTargetID}/labels/{labelID}": delete: operationId: DeleteScrapersIDLabelsID tags: - ScraperTargets summary: Delete a label from a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1020,9 +1240,9 @@ paths: required: true description: The label ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Scraper target not found content: application/json: @@ -1040,7 +1260,7 @@ paths: - ScraperTargets summary: Update a label on a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1061,9 +1281,9 @@ paths: schema: $ref: "#/components/schemas/Label" responses: - '200': + "200": description: Updated successfully - '404': + "404": description: Scraper target not found content: application/json: @@ -1075,7 +1295,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/members': + "/scrapers/{scraperTargetID}/members": get: operationId: GetScrapersIDMembers tags: @@ -1083,7 +1303,7 @@ paths: - ScraperTargets summary: List all users with member privileges for a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1091,7 +1311,7 @@ paths: required: true description: The scraper target ID. responses: - '200': + "200": description: A list of scraper target members content: application/json: @@ -1110,7 +1330,7 @@ paths: - ScraperTargets summary: Add a member to a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1125,7 +1345,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Member added to scraper targets content: application/json: @@ -1137,7 +1357,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/members/{userID}': + "/scrapers/{scraperTargetID}/members/{userID}": delete: operationId: DeleteScrapersIDMembersID tags: @@ -1145,7 +1365,7 @@ paths: - ScraperTargets summary: Remove a member from a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -1159,7 +1379,7 @@ paths: required: true description: The scraper target ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -1167,7 +1387,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/owners': + "/scrapers/{scraperTargetID}/owners": get: operationId: GetScrapersIDOwners tags: @@ -1175,7 +1395,7 @@ paths: - ScraperTargets summary: List all owners of a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1183,7 +1403,7 @@ paths: required: true description: The scraper target ID. responses: - '200': + "200": description: A list of scraper target owners content: application/json: @@ -1202,7 +1422,7 @@ paths: - ScraperTargets summary: Add an owner to a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: scraperTargetID schema: @@ -1217,7 +1437,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Scraper target owner added content: application/json: @@ -1229,7 +1449,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/scrapers/{scraperTargetID}/owners/{userID}': + "/scrapers/{scraperTargetID}/owners/{userID}": delete: operationId: DeleteScrapersIDOwnersID tags: @@ -1237,7 +1457,7 @@ paths: - ScraperTargets summary: Remove an owner from a scraper target parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -1251,7 +1471,7 @@ paths: required: true description: The scraper target ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -1266,7 +1486,7 @@ paths: - Variables summary: Get all variables parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: query name: org description: The organization name. @@ -1278,13 +1498,13 @@ paths: schema: type: string responses: - '200': + "200": description: All variables for an organization content: application/json: schema: $ref: "#/components/schemas/Variables" - '400': + "400": description: Invalid request content: application/json: @@ -1302,7 +1522,7 @@ paths: tags: - Variables parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Variable to create required: true @@ -1311,7 +1531,7 @@ paths: schema: $ref: "#/components/schemas/Variable" responses: - '201': + "201": description: Variable created content: application/json: @@ -1323,14 +1543,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/variables/{variableID}': + "/variables/{variableID}": get: operationId: GetVariablesID tags: - Variables summary: Get a variable parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID required: true @@ -1338,13 +1558,13 @@ paths: type: string description: The variable ID. responses: - '200': + "200": description: Variable found content: application/json: schema: $ref: "#/components/schemas/Variable" - '404': + "404": description: Variable not found content: application/json: @@ -1362,7 +1582,7 @@ paths: - Variables summary: Delete a variable parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID required: true @@ -1370,7 +1590,7 @@ paths: type: string description: The variable ID. responses: - '204': + "204": description: Variable deleted default: description: Internal server error @@ -1384,7 +1604,7 @@ paths: tags: - Variables parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID required: true @@ -1399,7 +1619,7 @@ paths: schema: $ref: "#/components/schemas/Variable" responses: - '200': + "200": description: Variable updated content: application/json: @@ -1417,7 +1637,7 @@ paths: tags: - Variables parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID required: true @@ -1432,7 +1652,7 @@ paths: schema: $ref: "#/components/schemas/Variable" responses: - '200': + "200": description: Variable updated content: application/json: @@ -1444,14 +1664,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/variables/{variableID}/labels': + "/variables/{variableID}/labels": get: operationId: GetVariablesIDLabels tags: - Variables summary: List all labels for a variable parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID schema: @@ -1459,7 +1679,7 @@ paths: required: true description: The variable ID. responses: - '200': + "200": description: A list of all labels for a variable content: application/json: @@ -1477,7 +1697,7 @@ paths: - Variables summary: Add a label to a variable parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID schema: @@ -1492,7 +1712,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The newly added label content: application/json: @@ -1504,14 +1724,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/variables/{variableID}/labels/{labelID}': + "/variables/{variableID}/labels/{labelID}": delete: operationId: DeleteVariablesIDLabelsID tags: - Variables summary: Delete a label from a variable parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: variableID schema: @@ -1525,9 +1745,9 @@ paths: required: true description: The label ID to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Variable not found content: application/json: @@ -1553,7 +1773,7 @@ paths: schema: type: string parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: header name: Content-Encoding description: When present, its value indicates to the database that compression is applied to the line-protocol body. @@ -1615,33 +1835,33 @@ paths: schema: $ref: "#/components/schemas/WritePrecision" responses: - '204': + "204": description: Write data is correctly formatted and accepted for writing to the bucket. - '400': + "400": description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written. content: application/json: schema: $ref: "#/components/schemas/LineProtocolError" - '401': + "401": description: Token does not have sufficient permissions to write to this organization and bucket or the organization and bucket do not exist. content: application/json: schema: $ref: "#/components/schemas/Error" - '403': + "403": description: No token was sent and they are required. content: application/json: schema: $ref: "#/components/schemas/Error" - '413': + "413": description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written. content: application/json: schema: $ref: "#/components/schemas/LineProtocolLengthError" - '429': + "429": description: Token is temporarily over quota. The Retry-After header describes when to try the write again. headers: Retry-After: @@ -1649,7 +1869,7 @@ paths: schema: type: integer format: int32 - '503': + "503": description: Server is temporarily unavailable to accept writes. The Retry-After header describes when to try the write again. headers: Retry-After: @@ -1667,14 +1887,14 @@ paths: post: summary: Delete time series data from InfluxDB requestBody: - description: Predicate delete request - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/DeletePredicateRequest" + description: Predicate delete request + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DeletePredicateRequest" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: query name: org description: Specifies the organization to delete data from. @@ -1699,21 +1919,21 @@ paths: type: string description: Only points from this bucket ID are deleted. responses: - '204': + "204": description: delete has been accepted - '400': + "400": description: invalid request. content: application/json: schema: $ref: "#/components/schemas/Error" - '404': + "404": description: the bucket or organization is not found. content: application/json: schema: $ref: "#/components/schemas/Error" - '403': + "403": description: no token was sent or does not have sufficient permissions. content: application/json: @@ -1727,16 +1947,16 @@ paths: $ref: "#/components/schemas/Error" /ready: servers: - - url: / + - url: / get: operationId: GetReady tags: - Ready summary: Get the readiness of an instance at startup parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: The instance is ready content: application/json: @@ -1750,22 +1970,22 @@ paths: $ref: "#/components/schemas/Error" /health: servers: - - url: / + - url: / get: operationId: GetHealth tags: - Health summary: Get the health of an instance parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: The instance is healthy content: application/json: schema: $ref: "#/components/schemas/HealthCheck" - '503': + "503": description: The instance is unhealthy content: application/json: @@ -1784,16 +2004,16 @@ paths: - Sources summary: Creates a source parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: - description: Source to create - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Source" + description: Source to create + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Source" responses: - '201': + "201": description: Created Source content: application/json: @@ -1811,14 +2031,14 @@ paths: - Sources summary: Get all sources parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: org - description: The organization name. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: org + description: The organization name. + schema: + type: string responses: - '200': + "200": description: All sources content: application/json: @@ -1837,7 +2057,7 @@ paths: - Sources summary: Delete a source parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: sourceID schema: @@ -1845,9 +2065,9 @@ paths: required: true description: The source ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: View not found content: application/json: @@ -1865,28 +2085,28 @@ paths: - Sources summary: Update a Source parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: sourceID - schema: - type: string - required: true - description: The source ID. - requestBody: - description: Source update + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: sourceID + schema: + type: string required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Source" + description: The source ID. + requestBody: + description: Source update + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Source" responses: - '200': + "200": description: Created Source content: application/json: schema: $ref: "#/components/schemas/Source" - '404': + "404": description: Source not found content: application/json: @@ -1904,21 +2124,21 @@ paths: - Sources summary: Get a source parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: sourceID - schema: - type: string - required: true - description: The source ID. + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: sourceID + schema: + type: string + required: true + description: The source ID. responses: - '200': + "200": description: A source content: application/json: schema: $ref: "#/components/schemas/Source" - '404': + "404": description: Source not found content: application/json: @@ -1937,21 +2157,21 @@ paths: - Sources summary: Get the health of a source parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: sourceID - schema: - type: string - required: true - description: The source ID. + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: sourceID + schema: + type: string + required: true + description: The source ID. responses: - '200': + "200": description: The source is healthy content: application/json: schema: $ref: "#/components/schemas/HealthCheck" - '503': + "503": description: The source is not healthy content: application/json: @@ -1971,26 +2191,26 @@ paths: - Buckets summary: Get buckets in a source parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: sourceID - schema: - type: string - required: true - description: The source ID. - - in: query - name: org - description: The organization name. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: sourceID + schema: + type: string + required: true + description: The source ID. + - in: query + name: org + description: The organization name. + schema: + type: string responses: - '200': + "200": description: A source content: application/json: schema: $ref: "#/components/schemas/Buckets" - '404': + "404": description: Source not found content: application/json: @@ -2009,14 +2229,14 @@ paths: - Labels summary: Create a label requestBody: - description: Label to create - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/LabelCreateRequest" + description: Label to create + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/LabelCreateRequest" responses: - '201': + "201": description: Added label content: application/json: @@ -2034,14 +2254,14 @@ paths: - Labels summary: Get all labels parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: orgID - description: The organization ID. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: orgID + description: The organization ID. + schema: + type: string responses: - '200': + "200": description: All labels content: application/json: @@ -2060,7 +2280,7 @@ paths: - Labels summary: Get a label parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: labelID schema: @@ -2068,7 +2288,7 @@ paths: required: true description: The ID of the label to update. responses: - '200': + "200": description: A label content: application/json: @@ -2086,14 +2306,14 @@ paths: - Labels summary: Update a label requestBody: - description: Label update - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/LabelUpdate" + description: Label update + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/LabelUpdate" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: labelID schema: @@ -2101,13 +2321,13 @@ paths: required: true description: The ID of the label to update. responses: - '200': + "200": description: Updated label content: application/json: schema: $ref: "#/components/schemas/LabelResponse" - '404': + "404": description: Label not found content: application/json: @@ -2125,7 +2345,7 @@ paths: - Labels summary: Delete a label parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: labelID schema: @@ -2133,9 +2353,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Label not found content: application/json: @@ -2154,16 +2374,16 @@ paths: - Dashboards summary: Create a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: - description: Dashboard to create - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDashboardRequest" + description: Dashboard to create + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateDashboardRequest" responses: - '201': + "201": description: Added dashboard content: application/json: @@ -2183,40 +2403,40 @@ paths: - Dashboards summary: Get all dashboards parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: query - name: owner - description: The owner ID. - schema: - type: string - - in: query - name: sortBy - description: The column to sort by. - schema: - type: string - enum: - - "ID" - - "CreatedAt" - - "UpdatedAt" - - in: query - name: id - description: List of dashboard IDs to return. If both `id and `owner` are specified, only `id` is used. - schema: - type: array - items: - type: string - - in: query - name: orgID - description: The organization ID. - schema: - type: string - - in: query - name: org - description: The organization name. - schema: + - $ref: "#/components/parameters/TraceSpan" + - in: query + name: owner + description: The owner ID. + schema: + type: string + - in: query + name: sortBy + description: The column to sort by. + schema: + type: string + enum: + - "ID" + - "CreatedAt" + - "UpdatedAt" + - in: query + name: id + description: List of dashboard IDs to return. If both `id and `owner` are specified, only `id` is used. + schema: + type: array + items: type: string + - in: query + name: orgID + description: The organization ID. + schema: + type: string + - in: query + name: org + description: The organization name. + schema: + type: string responses: - '200': + "200": description: All dashboards content: application/json: @@ -2228,73 +2448,73 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}': + "/dashboards/{dashboardID}": get: operationId: GetDashboardsID tags: - Dashboards summary: Get a Dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: path - name: dashboardID - schema: - type: string - required: true - description: The ID of the dashboard to update. - - in: query - name: include - required: false - schema: - type: string - enum: - - properties - description: Includes the cell view properties in the response if set to `properties` + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: dashboardID + schema: + type: string + required: true + description: The ID of the dashboard to update. + - in: query + name: include + required: false + schema: + type: string + enum: + - properties + description: Includes the cell view properties in the response if set to `properties` responses: - '200': - description: Get a single dashboard - content: - application/json: - schema: - oneOf: - - $ref: "#/components/schemas/Dashboard" - - $ref: "#/components/schemas/DashboardWithViewProperties" - '404': - description: Dashboard not found - content: - application/json: - schema: - $ref: "#/components/schemas/Error" - default: - description: Unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + "200": + description: Get a single dashboard + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/Dashboard" + - $ref: "#/components/schemas/DashboardWithViewProperties" + "404": + description: Dashboard not found + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" patch: operationId: PatchDashboardsID tags: - Dashboards summary: Update a dashboard requestBody: - description: Patching of a dashboard - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: optional, when provided will replace the name - type: string - description: - description: optional, when provided will replace the description - type: string - cells: - description: optional, when provided will replace all existing cells with the cells provided - $ref: "#/components/schemas/CellWithViewProperties" + description: Patching of a dashboard + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: optional, when provided will replace the name + type: string + description: + description: optional, when provided will replace the description + type: string + cells: + description: optional, when provided will replace all existing cells with the cells provided + $ref: "#/components/schemas/CellWithViewProperties" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2302,13 +2522,13 @@ paths: required: true description: The ID of the dashboard to update. responses: - '200': + "200": description: Updated dashboard content: application/json: schema: $ref: "#/components/schemas/Dashboard" - '404': + "404": description: Dashboard not found content: application/json: @@ -2326,7 +2546,7 @@ paths: - Dashboards summary: Delete a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2334,9 +2554,9 @@ paths: required: true description: The ID of the dashboard to update. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Dashboard not found content: application/json: @@ -2348,7 +2568,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/cells': + "/dashboards/{dashboardID}/cells": put: operationId: PutDashboardsIDCells tags: @@ -2357,13 +2577,13 @@ paths: summary: Replace cells in a dashboard description: Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells. requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Cells" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Cells" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2371,13 +2591,13 @@ paths: required: true description: The ID of the dashboard to update. responses: - '201': + "201": description: Replaced dashboard cells content: application/json: schema: $ref: "#/components/schemas/Dashboard" - '404': + "404": description: Dashboard not found content: application/json: @@ -2396,14 +2616,14 @@ paths: - Dashboards summary: Create a dashboard cell requestBody: - description: Cell that will be added - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/CreateCell" + description: Cell that will be added + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CreateCell" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2411,13 +2631,13 @@ paths: required: true description: The ID of the dashboard to update. responses: - '201': + "201": description: Cell successfully added content: application/json: schema: $ref: "#/components/schemas/Cell" - '404': + "404": description: Dashboard not found content: application/json: @@ -2429,7 +2649,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/cells/{cellID}': + "/dashboards/{dashboardID}/cells/{cellID}": patch: operationId: PatchDashboardsIDCellsID tags: @@ -2438,13 +2658,13 @@ paths: summary: Update the non-positional information related to a cell description: Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts. requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/CellUpdate" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/CellUpdate" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2458,13 +2678,13 @@ paths: required: true description: The ID of the cell to update. responses: - '200': + "200": description: Updated dashboard cell content: application/json: schema: $ref: "#/components/schemas/Cell" - '404': + "404": description: Cell or dashboard not found content: application/json: @@ -2483,7 +2703,7 @@ paths: - Dashboards summary: Delete a dashboard cell parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2497,9 +2717,9 @@ paths: required: true description: The ID of the cell to delete. responses: - '204': + "204": description: Cell successfully deleted - '404': + "404": description: Cell or dashboard not found content: application/json: @@ -2511,7 +2731,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/cells/{cellID}/view': + "/dashboards/{dashboardID}/cells/{cellID}/view": get: operationId: GetDashboardsIDCellsIDView tags: @@ -2520,7 +2740,7 @@ paths: - Views summary: Retrieve the view for a cell parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2534,13 +2754,13 @@ paths: required: true description: The cell ID. responses: - '200': + "200": description: A dashboard cells view content: application/json: schema: $ref: "#/components/schemas/View" - '404': + "404": description: Cell or dashboard not found content: application/json: @@ -2560,13 +2780,13 @@ paths: - Views summary: Update the view for a cell requestBody: - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/View" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/View" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2580,13 +2800,13 @@ paths: required: true description: The ID of the cell to update. responses: - '200': + "200": description: Updated cell view content: application/json: schema: $ref: "#/components/schemas/View" - '404': + "404": description: Cell or dashboard not found content: application/json: @@ -2598,14 +2818,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/labels': + "/dashboards/{dashboardID}/labels": get: operationId: GetDashboardsIDLabels tags: - Dashboards summary: list all labels for a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2613,7 +2833,7 @@ paths: required: true description: The dashboard ID. responses: - '200': + "200": description: A list of all labels for a dashboard content: application/json: @@ -2631,7 +2851,7 @@ paths: - Dashboards summary: Add a label to a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2646,7 +2866,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label added to the dashboard content: application/json: @@ -2658,14 +2878,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/labels/{labelID}': + "/dashboards/{dashboardID}/labels/{labelID}": delete: operationId: DeleteDashboardsIDLabelsID tags: - Dashboards summary: Delete a label from a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2679,9 +2899,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Dashboard not found content: application/json: @@ -2693,7 +2913,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/members': + "/dashboards/{dashboardID}/members": get: operationId: GetDashboardsIDMembers tags: @@ -2701,7 +2921,7 @@ paths: - Dashboards summary: List all dashboard members parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2709,7 +2929,7 @@ paths: required: true description: The dashboard ID. responses: - '200': + "200": description: A list of users who have member privileges for a dashboard content: application/json: @@ -2728,7 +2948,7 @@ paths: - Dashboards summary: Add a member to a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2743,7 +2963,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Added to dashboard members content: application/json: @@ -2755,7 +2975,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/members/{userID}': + "/dashboards/{dashboardID}/members/{userID}": delete: operationId: DeleteDashboardsIDMembersID tags: @@ -2763,7 +2983,7 @@ paths: - Dashboards summary: Remove a member from a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -2777,7 +2997,7 @@ paths: required: true description: The dashboard ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -2785,7 +3005,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/owners': + "/dashboards/{dashboardID}/owners": get: operationId: GetDashboardsIDOwners tags: @@ -2793,7 +3013,7 @@ paths: - Dashboards summary: List all dashboard owners parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2801,7 +3021,7 @@ paths: required: true description: The dashboard ID. responses: - '200': + "200": description: A list of users who have owner privileges for a dashboard content: application/json: @@ -2820,7 +3040,7 @@ paths: - Dashboards summary: Add an owner to a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: dashboardID schema: @@ -2835,7 +3055,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Added to dashboard owners content: application/json: @@ -2847,7 +3067,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/owners/{userID}': + "/dashboards/{dashboardID}/owners/{userID}": delete: operationId: DeleteDashboardsIDOwnersID tags: @@ -2855,7 +3075,7 @@ paths: - Dashboards summary: Remove an owner from a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -2869,7 +3089,7 @@ paths: required: true description: The dashboard ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -2877,7 +3097,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/dashboards/{dashboardID}/logs': + "/dashboards/{dashboardID}/logs": get: operationId: GetDashboardsIDLogs tags: @@ -2885,9 +3105,9 @@ paths: - OperationLogs summary: Retrieve operation logs for a dashboard parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: path name: dashboardID required: true @@ -2895,7 +3115,7 @@ paths: schema: type: string responses: - '200': + "200": description: Operation logs for the dashboard content: application/json: @@ -2914,13 +3134,13 @@ paths: tags: - Query parameters: - - $ref: '#/components/parameters/TraceSpan' - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json + - $ref: "#/components/parameters/TraceSpan" + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json requestBody: description: Analyzed Flux query to generate abstract syntax tree. content: @@ -2928,7 +3148,7 @@ paths: schema: $ref: "#/components/schemas/LanguageRequest" responses: - '200': + "200": description: Abstract syntax tree of flux query. content: application/json: @@ -2946,9 +3166,9 @@ paths: tags: - Query parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: Suggestions for next functions in call chain content: application/json: @@ -2960,13 +3180,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/query/suggestions/{name}': + "/query/suggestions/{name}": get: operationId: GetQuerySuggestionsName tags: - Query parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: name schema: @@ -2974,7 +3194,7 @@ paths: required: true description: The name of the branching suggestion. responses: - '200': + "200": description: Suggestions for next functions in call chain content: application/json: @@ -2993,7 +3213,7 @@ paths: - Authorizations summary: List all authorizations parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: query name: userID schema: @@ -3015,7 +3235,7 @@ paths: type: string description: Only show authorizations that belong to a organization name. responses: - '200': + "200": description: A list of authorizations content: application/json: @@ -3033,7 +3253,7 @@ paths: - Authorizations summary: Create an authorization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Authorization to create required: true @@ -3042,13 +3262,13 @@ paths: schema: $ref: "#/components/schemas/Authorization" responses: - '201': + "201": description: Authorization created content: application/json: schema: $ref: "#/components/schemas/Authorization" - '400': + "400": description: Invalid request content: application/json: @@ -3067,7 +3287,7 @@ paths: - Authorizations summary: Retrieve an authorization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: authID schema: @@ -3075,7 +3295,7 @@ paths: required: true description: The ID of the authorization to get. responses: - '200': + "200": description: Authorization details content: application/json: @@ -3100,7 +3320,7 @@ paths: schema: $ref: "#/components/schemas/AuthorizationUpdateRequest" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: authID schema: @@ -3108,7 +3328,7 @@ paths: required: true description: The ID of the authorization to update. responses: - '200': + "200": description: The active or inactie authorization content: application/json: @@ -3126,7 +3346,7 @@ paths: - Authorizations summary: Delete a authorization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: authID schema: @@ -3134,7 +3354,7 @@ paths: required: true description: The ID of the authorization to delete. responses: - '204': + "204": description: Authorization deleted default: description: Unexpected error @@ -3149,7 +3369,7 @@ paths: - Query summary: Analyze an InfluxQL or Flux query parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: header name: Content-Type schema: @@ -3157,33 +3377,33 @@ paths: enum: - application/json requestBody: - description: Flux or InfluxQL query to analyze + description: Flux or InfluxQL query to analyze + content: + application/json: + schema: + $ref: "#/components/schemas/Query" + responses: + "200": + description: Query analyze results. Errors will be empty if the query is valid. content: application/json: schema: - $ref: "#/components/schemas/Query" - responses: - '200': - description: Query analyze results. Errors will be empty if the query is valid. - content: - application/json: - schema: - $ref: "#/components/schemas/AnalyzeQueryResponse" - default: - description: Internal server error - headers: - X-Influx-Error: - description: Error string describing the problem - schema: - type: string - X-Influx-Reference: - description: Reference code unique to the error type - schema: - type: integer - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: "#/components/schemas/AnalyzeQueryResponse" + default: + description: Internal server error + headers: + X-Influx-Error: + description: Error string describing the problem + schema: + type: string + X-Influx-Reference: + description: Reference code unique to the error type + schema: + type: integer + content: + application/json: + schema: + $ref: "#/components/schemas/Error" /query: post: operationId: PostQuery @@ -3191,7 +3411,7 @@ paths: - Query summary: Query InfluxDB parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: header name: Accept-Encoding description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. @@ -3220,61 +3440,61 @@ paths: schema: type: string requestBody: - description: Flux query or specification to execute + description: Flux query or specification to execute + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/Query" + - $ref: "#/components/schemas/InfluxQLQuery" + application/vnd.flux: + schema: + type: string + responses: + "200": + description: Query results + headers: + Content-Encoding: + description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body + schema: + type: string + description: Specifies that the response in the body is encoded with gzip or not encoded with identity. + default: identity + enum: + - gzip + - identity + Trace-Id: + description: The Trace-Id header reports the request's trace ID, if one was generated. + schema: + type: string + description: Specifies the request's trace ID. + content: + text/csv: + schema: + type: string + example: > + result,table,_start,_stop,_time,region,host,_value + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 + mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 + application/vnd.influx.arrow: + schema: + type: string + format: binary + "429": + description: Token is temporarily over quota. The Retry-After header describes when to try the read again. + headers: + Retry-After: + description: A non-negative decimal integer indicating the seconds to delay after the response is received. + schema: + type: integer + format: int32 + default: + description: Error processing query content: application/json: schema: - oneOf: - - $ref: "#/components/schemas/Query" - - $ref: "#/components/schemas/InfluxQLQuery" - application/vnd.flux: - schema: - type: string - responses: - '200': - description: Query results - headers: - Content-Encoding: - description: The Content-Encoding entity header is used to compress the media-type. When present, its value indicates which encodings were applied to the entity-body - schema: - type: string - description: Specifies that the response in the body is encoded with gzip or not encoded with identity. - default: identity - enum: - - gzip - - identity - Trace-Id: - description: The Trace-Id header reports the request's trace ID, if one was generated. - schema: - type: string - description: Specifies the request's trace ID. - content: - text/csv: - schema: - type: string - example: > - result,table,_start,_stop,_time,region,host,_value - mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:00Z,east,A,15.43 - mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:20Z,east,B,59.25 - mean,0,2018-05-08T20:50:00Z,2018-05-08T20:51:00Z,2018-05-08T20:50:40Z,east,C,52.62 - application/vnd.influx.arrow: - schema: - type: string - format: binary - '429': - description: Token is temporarily over quota. The Retry-After header describes when to try the read again. - headers: - Retry-After: - description: A non-negative decimal integer indicating the seconds to delay after the response is received. - schema: - type: integer - format: int32 - default: - description: Error processing query - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: "#/components/schemas/Error" /buckets: get: operationId: GetBuckets @@ -3282,26 +3502,26 @@ paths: - Buckets summary: List all buckets parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: "#/components/parameters/Offset" - - $ref: "#/components/parameters/Limit" - - in: query - name: org - description: The organization name. - schema: - type: string - - in: query - name: orgID - description: The organization ID. - schema: - type: string - - in: query - name: name - description: Only returns buckets with a specific name. - schema: - type: string + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" + - in: query + name: org + description: The organization name. + schema: + type: string + - in: query + name: orgID + description: The organization ID. + schema: + type: string + - in: query + name: name + description: Only returns buckets with a specific name. + schema: + type: string responses: - '200': + "200": description: A list of buckets content: application/json: @@ -3319,7 +3539,7 @@ paths: - Buckets summary: Create a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Bucket to create required: true @@ -3328,7 +3548,7 @@ paths: schema: $ref: "#/components/schemas/PostBucketRequest" responses: - '201': + "201": description: Bucket created content: application/json: @@ -3346,14 +3566,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}': + "/buckets/{bucketID}": get: operationId: GetBucketsID tags: - Buckets summary: Retrieve a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3361,7 +3581,7 @@ paths: required: true description: The bucket ID. responses: - '200': + "200": description: Bucket details content: application/json: @@ -3386,7 +3606,7 @@ paths: schema: $ref: "#/components/schemas/Bucket" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3394,7 +3614,7 @@ paths: required: true description: The bucket ID. responses: - '200': + "200": description: An updated bucket content: application/json: @@ -3412,7 +3632,7 @@ paths: - Buckets summary: Delete a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3420,9 +3640,9 @@ paths: required: true description: The ID of the bucket to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Bucket not found content: application/json: @@ -3434,14 +3654,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/labels': + "/buckets/{bucketID}/labels": get: operationId: GetBucketsIDLabels tags: - Buckets summary: List all labels for a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3449,7 +3669,7 @@ paths: required: true description: The bucket ID. responses: - '200': + "200": description: A list of all labels for a bucket content: application/json: @@ -3467,7 +3687,7 @@ paths: - Buckets summary: Add a label to a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3482,7 +3702,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The newly added label content: application/json: @@ -3494,14 +3714,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/labels/{labelID}': + "/buckets/{bucketID}/labels/{labelID}": delete: operationId: DeleteBucketsIDLabelsID tags: - Buckets summary: delete a label from a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3515,9 +3735,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Bucket not found content: application/json: @@ -3529,7 +3749,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/members': + "/buckets/{bucketID}/members": get: operationId: GetBucketsIDMembers tags: @@ -3537,7 +3757,7 @@ paths: - Buckets summary: List all users with member privileges for a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3545,7 +3765,7 @@ paths: required: true description: The bucket ID. responses: - '200': + "200": description: A list of bucket members content: application/json: @@ -3564,7 +3784,7 @@ paths: - Buckets summary: Add a member to a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3579,7 +3799,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Member added to bucket content: application/json: @@ -3591,7 +3811,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/members/{userID}': + "/buckets/{bucketID}/members/{userID}": delete: operationId: DeleteBucketsIDMembersID tags: @@ -3599,7 +3819,7 @@ paths: - Buckets summary: Remove a member from a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -3613,7 +3833,7 @@ paths: required: true description: The bucket ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -3621,7 +3841,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/owners': + "/buckets/{bucketID}/owners": get: operationId: GetBucketsIDOwners tags: @@ -3629,7 +3849,7 @@ paths: - Buckets summary: List all owners of a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3637,7 +3857,7 @@ paths: required: true description: The bucket ID. responses: - '200': + "200": description: A list of bucket owners content: application/json: @@ -3656,7 +3876,7 @@ paths: - Buckets summary: Add an owner to a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: bucketID schema: @@ -3671,7 +3891,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Bucket owner added content: application/json: @@ -3683,7 +3903,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/owners/{userID}': + "/buckets/{bucketID}/owners/{userID}": delete: operationId: DeleteBucketsIDOwnersID tags: @@ -3691,7 +3911,7 @@ paths: - Buckets summary: Remove an owner from a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -3705,7 +3925,7 @@ paths: required: true description: The bucket ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -3713,7 +3933,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/buckets/{bucketID}/logs': + "/buckets/{bucketID}/logs": get: operationId: GetBucketsIDLogs tags: @@ -3721,9 +3941,9 @@ paths: - OperationLogs summary: Retrieve operation logs for a bucket parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: path name: bucketID required: true @@ -3731,7 +3951,7 @@ paths: schema: type: string responses: - '200': + "200": description: Operation logs for the bucket content: application/json: @@ -3750,7 +3970,7 @@ paths: - Organizations summary: List all organizations parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: query name: org schema: @@ -3767,7 +3987,7 @@ paths: type: string description: Filter organizations to a specific user ID. responses: - '200': + "200": description: A list of organizations content: application/json: @@ -3785,7 +4005,7 @@ paths: - Organizations summary: Create an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Organization to create required: true @@ -3794,7 +4014,7 @@ paths: schema: $ref: "#/components/schemas/Organization" responses: - '201': + "201": description: Organization created content: application/json: @@ -3806,14 +4026,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}': + "/orgs/{orgID}": get: operationId: GetOrgsID tags: - Organizations summary: Retrieve an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3821,7 +4041,7 @@ paths: required: true description: The ID of the organization to get. responses: - '200': + "200": description: Organization details content: application/json: @@ -3846,7 +4066,7 @@ paths: schema: $ref: "#/components/schemas/Organization" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3854,7 +4074,7 @@ paths: required: true description: The ID of the organization to get. responses: - '200': + "200": description: Organization updated content: application/json: @@ -3872,7 +4092,7 @@ paths: - Organizations summary: Delete an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3880,9 +4100,9 @@ paths: required: true description: The ID of the organization to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Organization not found content: application/json: @@ -3894,14 +4114,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/labels': + "/orgs/{orgID}/labels": get: operationId: GetOrgsIDLabels tags: - Organizations summary: List all labels for a organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3909,7 +4129,7 @@ paths: required: true description: The organization ID. responses: - '200': + "200": description: A list of all labels for an organization content: application/json: @@ -3927,7 +4147,7 @@ paths: - Organizations summary: Add a label to an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3942,7 +4162,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: Returns the created label content: application/json: @@ -3954,14 +4174,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/labels/{labelID}': + "/orgs/{orgID}/labels/{labelID}": delete: operationId: DeleteOrgsIDLabelsID tags: - Organizations summary: Delete a label from an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -3975,9 +4195,9 @@ paths: required: true description: The label ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Organization not found content: application/json: @@ -3989,7 +4209,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/secrets': + "/orgs/{orgID}/secrets": get: operationId: GetOrgsIDSecrets tags: @@ -3997,7 +4217,7 @@ paths: - Organizations summary: List all secret keys for an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4005,7 +4225,7 @@ paths: required: true description: The organization ID. responses: - '200': + "200": description: A list of all secret keys content: application/json: @@ -4024,7 +4244,7 @@ paths: - Organizations summary: Update secrets in an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4039,7 +4259,7 @@ paths: schema: $ref: "#/components/schemas/Secrets" responses: - '204': + "204": description: Keys successfully patched default: description: Unexpected error @@ -4047,7 +4267,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/secrets/delete': # had to make this because swagger wouldn't let me have a request body with a DELETE + "/orgs/{orgID}/secrets/delete": # had to make this because swagger wouldn't let me have a request body with a DELETE post: operationId: PostOrgsIDSecrets tags: @@ -4055,7 +4275,7 @@ paths: - Organizations summary: Delete secrets from an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4070,7 +4290,7 @@ paths: schema: $ref: "#/components/schemas/SecretKeys" responses: - '204': + "204": description: Keys successfully patched default: description: Unexpected error @@ -4078,7 +4298,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/members': + "/orgs/{orgID}/members": get: operationId: GetOrgsIDMembers tags: @@ -4086,7 +4306,7 @@ paths: - Organizations summary: List all members of an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4094,13 +4314,13 @@ paths: required: true description: The organization ID. responses: - '200': + "200": description: A list of organization members content: application/json: schema: $ref: "#/components/schemas/ResourceMembers" - '404': + "404": description: Organization not found content: application/json: @@ -4119,7 +4339,7 @@ paths: - Organizations summary: Add a member to an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4134,7 +4354,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Added to organization created content: application/json: @@ -4146,7 +4366,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/members/{userID}': + "/orgs/{orgID}/members/{userID}": delete: operationId: DeleteOrgsIDMembersID tags: @@ -4154,7 +4374,7 @@ paths: - Organizations summary: Remove a member from an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -4168,7 +4388,7 @@ paths: required: true description: The organization ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -4176,7 +4396,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/owners': + "/orgs/{orgID}/owners": get: operationId: GetOrgsIDOwners tags: @@ -4184,7 +4404,7 @@ paths: - Organizations summary: List all owners of an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4192,13 +4412,13 @@ paths: required: true description: The organization ID. responses: - '200': + "200": description: A list of organization owners content: application/json: schema: $ref: "#/components/schemas/ResourceOwners" - '404': + "404": description: Organization not found content: application/json: @@ -4217,7 +4437,7 @@ paths: - Organizations summary: Add an owner to an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: orgID schema: @@ -4232,7 +4452,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Organization owner added content: application/json: @@ -4244,7 +4464,162 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/owners/{userID}': + "/orgs/{orgID}/invites": + post: + operationId: PostOrgsIDInvites + tags: + - Invites + - Organizations + summary: Creates an invite to an organization + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: orgID + schema: + type: string + required: true + description: The organization ID. + requestBody: + description: Invite to be sent + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Invite" + responses: + "201": + description: Invite sent + content: + application/json: + schema: + $ref: "#/components/schemas/Invite" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/orgs/{orgID}/invites/{inviteID}": + delete: + operationId: DeleteOrgsIDInviteID + tags: + - Invites + - Organizations + summary: Remove an invite to an organization + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: inviteID + schema: + type: string + required: true + description: The ID of the invite to remove. + - in: path + name: orgID + schema: + type: string + required: true + description: The organization ID. + responses: + "204": + description: Invite removed + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/orgs/{orgID}/invites/{inviteID}/resend": + post: + operationId: DeleteOrgsIDInviteID + tags: + - Invites + - Organizations + summary: Resends an invite + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: inviteID + schema: + type: string + required: true + description: The ID of the invite to resend. + - in: path + name: orgID + schema: + type: string + required: true + description: The organization ID. + responses: + "200": + description: Invite resent + content: + application/json: + schema: + $ref: "#/components/schemas/Invite" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/orgs/{orgID}/users": + get: + operationId: GetCloudUsers + tags: + - CloudUsers + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: orgID + description: Specifies the organization ID of the CloudUser. + required: true + schema: + type: string + responses: + "200": + description: A list of cloud users + content: + application/json: + schema: + $ref: "#/components/schemas/CloudUsers" + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/orgs/{orgID}/users/{userID}": + delete: + operationId: DeleteOrgsIDCloudUserID + tags: + - CloudUsers + - Organizations + summary: Deletes a cloud user + parameters: + - $ref: "#/components/parameters/TraceSpan" + - in: path + name: userID + schema: + type: string + required: true + description: The ID of the user to remove. + - in: path + name: orgID + schema: + type: string + required: true + description: The organization ID. + responses: + "204": + description: User removed + default: + description: Unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + "/orgs/{orgID}/owners/{userID}": delete: operationId: DeleteOrgsIDOwnersID tags: @@ -4252,7 +4627,7 @@ paths: - Organizations summary: Remove an owner from an organization parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -4266,7 +4641,7 @@ paths: required: true description: The organization ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -4274,7 +4649,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/orgs/{orgID}/logs': + "/orgs/{orgID}/logs": get: operationId: GetOrgsIDLogs tags: @@ -4282,9 +4657,9 @@ paths: - OperationLogs summary: Retrieve operation logs for an organization parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: path name: orgID required: true @@ -4292,7 +4667,7 @@ paths: schema: type: string responses: - '200': + "200": description: Operation logs for the organization content: application/json: @@ -4318,7 +4693,7 @@ paths: schema: $ref: "#/components/schemas/PkgCreate" responses: - '200': + "200": description: Influx package created content: application/json: @@ -4349,7 +4724,7 @@ paths: schema: $ref: "#/components/schemas/PkgApply" responses: - '200': + "200": description: > Influx package dry-run successful, no new resources created. The provided diff and summary will not have IDs for resources @@ -4358,7 +4733,7 @@ paths: application/json: schema: $ref: "#/components/schemas/PkgSummary" - '201': + "201": description: > Influx package applied successfully. Newly created resources created available in summary. The diff compares the state of the world before @@ -4398,7 +4773,7 @@ paths: type: string description: A collection of stackIDs to filter the list by. responses: - '200': + "200": description: Influx stacks found content: application/json: @@ -4477,7 +4852,7 @@ paths: items: type: string responses: - '201': + "201": description: Influx stack created content: application/json: @@ -4530,7 +4905,7 @@ paths: type: string description: The organization id of the user responses: - '204': + "204": description: Stack and all its associated resources are deleted default: description: Unexpected error @@ -4545,7 +4920,7 @@ paths: - Tasks summary: List all tasks parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: query name: name description: Returns task with a specific name. @@ -4588,7 +4963,7 @@ paths: default: 100 description: The number of tasks to return responses: - '200': + "200": description: A list of tasks content: application/json: @@ -4606,7 +4981,7 @@ paths: - Tasks summary: Create a new task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: Task to create required: true @@ -4615,7 +4990,7 @@ paths: schema: $ref: "#/components/schemas/TaskCreateRequest" responses: - '201': + "201": description: Task created content: application/json: @@ -4627,14 +5002,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}': + "/tasks/{taskID}": get: operationId: GetTasksID tags: - Tasks summary: Retrieve a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4642,7 +5017,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: Task details content: application/json: @@ -4668,7 +5043,7 @@ paths: schema: $ref: "#/components/schemas/TaskUpdateRequest" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4676,7 +5051,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: Task updated content: application/json: @@ -4695,7 +5070,7 @@ paths: summary: Delete a task description: Deletes a task and all associated records parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4703,7 +5078,7 @@ paths: required: true description: The ID of the task to delete. responses: - '204': + "204": description: Task deleted default: description: Unexpected error @@ -4711,14 +5086,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/runs': + "/tasks/{taskID}/runs": get: operationId: GetTasksIDRuns tags: - Tasks summary: List runs for a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4751,7 +5126,7 @@ paths: format: date-time description: Filter runs to those scheduled before this time, RFC3339 responses: - '200': + "200": description: A list of task runs content: application/json: @@ -4769,7 +5144,7 @@ paths: - Tasks summary: Manually start a task run, overriding the current schedule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4781,7 +5156,7 @@ paths: schema: $ref: "#/components/schemas/RunManually" responses: - '201': + "201": description: Run scheduled to start content: application/json: @@ -4793,14 +5168,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/runs/{runID}': + "/tasks/{taskID}/runs/{runID}": get: operationId: GetTasksIDRunsID tags: - Tasks summary: Retrieve a single run for a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4814,7 +5189,7 @@ paths: required: true description: The run ID. responses: - '200': + "200": description: The run record content: application/json: @@ -4832,7 +5207,7 @@ paths: - Tasks summary: Cancel a running task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4846,7 +5221,7 @@ paths: required: true description: The run ID. responses: - '204': + "204": description: Delete has been accepted default: description: Unexpected error @@ -4854,14 +5229,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/runs/{runID}/retry': + "/tasks/{taskID}/runs/{runID}/retry": post: operationId: PostTasksIDRunsIDRetry tags: - Tasks summary: Retry a task run parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4875,7 +5250,7 @@ paths: required: true description: The run ID. responses: - '200': + "200": description: Run that has been queued content: application/json: @@ -4887,14 +5262,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/logs': + "/tasks/{taskID}/logs": get: operationId: GetTasksIDLogs tags: - Tasks summary: Retrieve all logs for a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4902,7 +5277,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: All logs for a task content: application/json: @@ -4914,14 +5289,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/runs/{runID}/logs': + "/tasks/{taskID}/runs/{runID}/logs": get: operationId: GetTasksIDRunsIDLogs tags: - Tasks summary: Retrieve all logs for a run parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4935,7 +5310,7 @@ paths: required: true description: ID of run to get logs for. responses: - '200': + "200": description: All logs for a run content: application/json: @@ -4947,14 +5322,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/labels': + "/tasks/{taskID}/labels": get: operationId: GetTasksIDLabels tags: - Tasks summary: List all labels for a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4962,7 +5337,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: A list of all labels for a task content: application/json: @@ -4980,7 +5355,7 @@ paths: - Tasks summary: Add a label to a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -4995,7 +5370,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: A list of all labels for a task content: application/json: @@ -5007,14 +5382,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/labels/{labelID}': + "/tasks/{taskID}/labels/{labelID}": delete: operationId: DeleteTasksIDLabelsID tags: - Tasks summary: Delete a label from a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -5028,9 +5403,9 @@ paths: required: true description: The label ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Task not found content: application/json: @@ -5049,9 +5424,9 @@ paths: - Users summary: Return the feature flags for the currently authenticated user parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: Feature flags for the currently authenticated user content: application/json: @@ -5070,9 +5445,9 @@ paths: - Users summary: Return the current authenticated user parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: Currently authenticated user content: application/json: @@ -5093,7 +5468,7 @@ paths: security: - BasicAuth: [] parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: New password required: true @@ -5102,7 +5477,7 @@ paths: schema: $ref: "#/components/schemas/PasswordResetBody" responses: - '204': + "204": description: Password successfully updated default: description: Unsuccessful authentication @@ -5110,7 +5485,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/members': + "/tasks/{taskID}/members": get: operationId: GetTasksIDMembers tags: @@ -5118,7 +5493,7 @@ paths: - Tasks summary: List all task members parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -5126,7 +5501,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: A list of users who have member privileges for a task content: application/json: @@ -5145,7 +5520,7 @@ paths: - Tasks summary: Add a member to a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -5160,7 +5535,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Added to task members content: application/json: @@ -5172,7 +5547,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/members/{userID}': + "/tasks/{taskID}/members/{userID}": delete: operationId: DeleteTasksIDMembersID tags: @@ -5180,7 +5555,7 @@ paths: - Tasks summary: Remove a member from a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5194,7 +5569,7 @@ paths: required: true description: The task ID. responses: - '204': + "204": description: Member removed default: description: Unexpected error @@ -5202,7 +5577,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/owners': + "/tasks/{taskID}/owners": get: operationId: GetTasksIDOwners tags: @@ -5210,7 +5585,7 @@ paths: - Tasks summary: List all owners of a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -5218,7 +5593,7 @@ paths: required: true description: The task ID. responses: - '200': + "200": description: A list of users who have owner privileges for a task content: application/json: @@ -5237,7 +5612,7 @@ paths: - Tasks summary: Add an owner to a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: taskID schema: @@ -5252,7 +5627,7 @@ paths: schema: $ref: "#/components/schemas/AddResourceMemberRequestBody" responses: - '201': + "201": description: Added to task owners content: application/json: @@ -5264,7 +5639,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/tasks/{taskID}/owners/{userID}': + "/tasks/{taskID}/owners/{userID}": delete: operationId: DeleteTasksIDOwnersID tags: @@ -5272,7 +5647,7 @@ paths: - Tasks summary: Remove an owner from a task parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5286,7 +5661,7 @@ paths: required: true description: The task ID. responses: - '204': + "204": description: Owner removed default: description: Unexpected error @@ -5301,9 +5676,9 @@ paths: - Users summary: List all users parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" responses: - '200': + "200": description: A list of users content: application/json: @@ -5321,7 +5696,7 @@ paths: - Users summary: Create a user parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" requestBody: description: User to create required: true @@ -5330,7 +5705,7 @@ paths: schema: $ref: "#/components/schemas/User" responses: - '201': + "201": description: User created content: application/json: @@ -5342,14 +5717,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/users/{userID}': + "/users/{userID}": get: operationId: GetUsersID tags: - Users summary: Retrieve a user parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5357,7 +5732,7 @@ paths: required: true description: The user ID. responses: - '200': + "200": description: User details content: application/json: @@ -5382,7 +5757,7 @@ paths: schema: $ref: "#/components/schemas/User" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5390,7 +5765,7 @@ paths: required: true description: The ID of the user to update. responses: - '200': + "200": description: User updated content: application/json: @@ -5408,7 +5783,7 @@ paths: - Users summary: Delete a user parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5416,7 +5791,7 @@ paths: required: true description: The ID of the user to delete. responses: - '204': + "204": description: User deleted default: description: Unexpected error @@ -5424,16 +5799,16 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/users/{userID}/password': - put: - operationId: PutUsersIDPassword + "/users/{userID}/password": + post: + operationId: PostUsersIDPassword tags: - Users summary: Update a password security: - BasicAuth: [] parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: userID schema: @@ -5448,7 +5823,7 @@ paths: schema: $ref: "#/components/schemas/PasswordResetBody" responses: - '204': + "204": description: Password successfully updated default: description: Unsuccessful authentication @@ -5456,7 +5831,7 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/users/{userID}/logs': + "/users/{userID}/logs": get: operationId: GetUsersIDLogs tags: @@ -5464,9 +5839,9 @@ paths: - OperationLogs summary: Retrieve operation logs for a user parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: path name: userID required: true @@ -5474,7 +5849,7 @@ paths: schema: type: string responses: - '200': + "200": description: Operation logs for the user content: application/json: @@ -5490,12 +5865,12 @@ paths: get: operationId: GetChecks tags: - - Checks + - Checks summary: Get all checks parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: query name: orgID required: true @@ -5503,7 +5878,7 @@ paths: schema: type: string responses: - '200': + "200": description: A list of checks content: application/json: @@ -5514,7 +5889,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: "#/components/schemas/Error" post: operationId: CreateCheck tags: @@ -5526,9 +5901,9 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PostCheck" + $ref: "#/components/schemas/PostCheck" responses: - '201': + "201": description: Check created content: application/json: @@ -5540,14 +5915,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/checks/{checkID}': + "/checks/{checkID}": get: operationId: GetChecksID tags: - Checks summary: Get a check parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5555,7 +5930,7 @@ paths: required: true description: The check ID. responses: - '200': + "200": description: The check requested content: application/json: @@ -5580,7 +5955,7 @@ paths: schema: $ref: "#/components/schemas/Check" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5588,13 +5963,13 @@ paths: required: true description: The check ID. responses: - '200': + "200": description: An updated check content: application/json: schema: $ref: "#/components/schemas/Check" - '404': + "404": description: The check was not found content: application/json: @@ -5617,9 +5992,9 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CheckPatch" + $ref: "#/components/schemas/CheckPatch" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5627,13 +6002,13 @@ paths: required: true description: The check ID. responses: - '200': + "200": description: An updated check content: application/json: schema: $ref: "#/components/schemas/Check" - '404': + "404": description: The check was not found content: application/json: @@ -5651,7 +6026,7 @@ paths: - Checks summary: Delete a check parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5659,9 +6034,9 @@ paths: required: true description: The check ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: The check was not found content: application/json: @@ -5673,14 +6048,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/checks/{checkID}/labels': + "/checks/{checkID}/labels": get: operationId: GetChecksIDLabels tags: - Checks summary: List all labels for a check parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5688,7 +6063,7 @@ paths: required: true description: The check ID. responses: - '200': + "200": description: A list of all labels for a check content: application/json: @@ -5706,7 +6081,7 @@ paths: - Checks summary: Add a label to a check parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5721,7 +6096,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label was added to the check content: application/json: @@ -5733,14 +6108,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/checks/{checkID}/labels/{labelID}': + "/checks/{checkID}/labels/{labelID}": delete: operationId: DeleteChecksIDLabelsID tags: - Checks summary: Delete label from a check parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5754,9 +6129,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Check or label not found content: application/json: @@ -5772,12 +6147,12 @@ paths: get: operationId: GetNotificationRules tags: - - NotificationRules + - NotificationRules summary: Get all notification rules parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: query name: orgID required: true @@ -5797,7 +6172,7 @@ paths: pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ example: env:prod responses: - '200': + "200": description: A list of notification rules content: application/json: @@ -5808,7 +6183,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: "#/components/schemas/Error" post: operationId: CreateNotificationRule tags: @@ -5822,7 +6197,7 @@ paths: schema: $ref: "#/components/schemas/PostNotificationRule" responses: - '201': + "201": description: Notification rule created content: application/json: @@ -5834,14 +6209,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/checks/{checkID}/query': + "/checks/{checkID}/query": get: operationId: GetChecksIDQuery tags: - Checks summary: Get a check query parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: checkID schema: @@ -5849,19 +6224,19 @@ paths: required: true description: The check ID. responses: - '200': + "200": description: The check query requested content: application/json: schema: $ref: "#/components/schemas/FluxResponse" - '400': + "400": description: Invalid request content: application/json: schema: $ref: "#/components/schemas/Error" - '404': + "404": description: Check not found content: application/json: @@ -5873,14 +6248,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationRules/{ruleID}': + "/notificationRules/{ruleID}": get: operationId: GetNotificationRulesID tags: - NotificationRules summary: Get a notification rule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -5888,7 +6263,7 @@ paths: required: true description: The notification rule ID. responses: - '200': + "200": description: The notification rule requested content: application/json: @@ -5913,7 +6288,7 @@ paths: schema: $ref: "#/components/schemas/NotificationRule" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -5921,13 +6296,13 @@ paths: required: true description: The notification rule ID. responses: - '200': + "200": description: An updated notification rule content: application/json: schema: $ref: "#/components/schemas/NotificationRule" - '404': + "404": description: The notification rule was not found content: application/json: @@ -5952,7 +6327,7 @@ paths: schema: $ref: "#/components/schemas/NotificationRuleUpdate" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -5960,13 +6335,13 @@ paths: required: true description: The notification rule ID. responses: - '200': + "200": description: An updated notification rule content: application/json: schema: $ref: "#/components/schemas/NotificationRule" - '404': + "404": description: The notification rule was not found content: application/json: @@ -5984,7 +6359,7 @@ paths: - NotificationRules summary: Delete a notification rule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -5992,9 +6367,9 @@ paths: required: true description: The notification rule ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: The check was not found content: application/json: @@ -6006,14 +6381,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationRules/{ruleID}/labels': + "/notificationRules/{ruleID}/labels": get: operationId: GetNotificationRulesIDLabels tags: - NotificationRules summary: List all labels for a notification rule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -6021,7 +6396,7 @@ paths: required: true description: The notification rule ID. responses: - '200': + "200": description: A list of all labels for a notification rule content: application/json: @@ -6039,7 +6414,7 @@ paths: - NotificationRules summary: Add a label to a notification rule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -6054,7 +6429,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label was added to the notification rule content: application/json: @@ -6066,14 +6441,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationRules/{ruleID}/labels/{labelID}': + "/notificationRules/{ruleID}/labels/{labelID}": delete: operationId: DeleteNotificationRulesIDLabelsID tags: - NotificationRules summary: Delete label from a notification rule parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -6087,9 +6462,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Rule or label not found content: application/json: @@ -6101,14 +6476,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationRules/{ruleID}/query': + "/notificationRules/{ruleID}/query": get: operationId: GetNotificationRulesIDQuery tags: - Rules summary: Get a notification rule query parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: ruleID schema: @@ -6116,19 +6491,19 @@ paths: required: true description: The notification rule ID. responses: - '200': + "200": description: The notification rule query requested content: application/json: schema: $ref: "#/components/schemas/FluxResponse" - '400': + "400": description: Invalid request content: application/json: schema: $ref: "#/components/schemas/Error" - '404': + "404": description: Notification rule not found content: application/json: @@ -6144,12 +6519,12 @@ paths: get: operationId: GetNotificationEndpoints tags: - - NotificationEndpoints + - NotificationEndpoints summary: Get all notification endpoints parameters: - - $ref: '#/components/parameters/TraceSpan' - - $ref: '#/components/parameters/Offset' - - $ref: '#/components/parameters/Limit' + - $ref: "#/components/parameters/TraceSpan" + - $ref: "#/components/parameters/Offset" + - $ref: "#/components/parameters/Limit" - in: query name: orgID required: true @@ -6157,7 +6532,7 @@ paths: schema: type: string responses: - '200': + "200": description: A list of notification endpoints content: application/json: @@ -6168,7 +6543,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: "#/components/schemas/Error" post: operationId: CreateNotificationEndpoint tags: @@ -6182,7 +6557,7 @@ paths: schema: $ref: "#/components/schemas/PostNotificationEndpoint" responses: - '201': + "201": description: Notification endpoint created content: application/json: @@ -6194,14 +6569,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationEndpoints/{endpointID}': + "/notificationEndpoints/{endpointID}": get: operationId: GetNotificationEndpointsID tags: - NotificationEndpoints summary: Get a notification endpoint parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6209,7 +6584,7 @@ paths: required: true description: The notification endpoint ID. responses: - '200': + "200": description: The notification endpoint requested content: application/json: @@ -6234,7 +6609,7 @@ paths: schema: $ref: "#/components/schemas/NotificationEndpoint" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6242,13 +6617,13 @@ paths: required: true description: The notification endpoint ID. responses: - '200': + "200": description: An updated notification endpoint content: application/json: schema: $ref: "#/components/schemas/NotificationEndpoint" - '404': + "404": description: The notification endpoint was not found content: application/json: @@ -6273,7 +6648,7 @@ paths: schema: $ref: "#/components/schemas/NotificationEndpointUpdate" parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6281,13 +6656,13 @@ paths: required: true description: The notification endpoint ID. responses: - '200': + "200": description: An updated notification endpoint content: application/json: schema: $ref: "#/components/schemas/NotificationEndpoint" - '404': + "404": description: The notification endpoint was not found content: application/json: @@ -6305,7 +6680,7 @@ paths: - NotificationEndpoints summary: Delete a notification endpoint parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6313,9 +6688,9 @@ paths: required: true description: The notification endpoint ID. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: The endpoint was not found content: application/json: @@ -6327,14 +6702,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationEndpoints/{endpointID}/labels': + "/notificationEndpoints/{endpointID}/labels": get: operationId: GetNotificationEndpointsIDLabels tags: - NotificationEndpoints summary: List all labels for a notification endpoint parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6342,7 +6717,7 @@ paths: required: true description: The notification endpoint ID. responses: - '200': + "200": description: A list of all labels for a notification endpoint content: application/json: @@ -6360,7 +6735,7 @@ paths: - NotificationEndpoints summary: Add a label to a notification endpoint parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6375,7 +6750,7 @@ paths: schema: $ref: "#/components/schemas/LabelMapping" responses: - '201': + "201": description: The label was added to the notification endpoint content: application/json: @@ -6387,14 +6762,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - '/notificationEndpoints/{endpointID}/labels/{labelID}': + "/notificationEndpoints/{endpointID}/labels/{labelID}": delete: operationId: DeleteNotificationEndpointsIDLabelsID tags: - NotificationEndpoints summary: Delete a label from a notification endpoint parameters: - - $ref: '#/components/parameters/TraceSpan' + - $ref: "#/components/parameters/TraceSpan" - in: path name: endpointID schema: @@ -6408,9 +6783,9 @@ paths: required: true description: The ID of the label to delete. responses: - '204': + "204": description: Delete has been accepted - '404': + "404": description: Endpoint or label not found content: application/json: @@ -6458,8 +6833,8 @@ components: name: Zap-Trace-Span description: OpenTracing span context example: - trace_id: '1' - span_id: '1' + trace_id: "1" + span_id: "1" baggage: key: value required: false @@ -6732,7 +7107,7 @@ components: body: $ref: "#/components/schemas/Node" BinaryExpression: - description: uses binary operators to act on two operands in an expression + description: uses binary operators to act on two operands in an expression type: object properties: type: @@ -6948,42 +7323,42 @@ components: description: Type of AST node type: string Dialect: - description: Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions - type: object - properties: - header: - description: If true, the results will contain a header row - type: boolean - default: true - delimiter: - description: Separator between cells; the default is , - type: string - default: "," - maxLength: 1 - minLength: 1 - annotations: - description: Https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns - type: array - items: - type: string - enum: - - "group" - - "datatype" - - "default" - uniqueItems: true - commentPrefix: - description: Character prefixed to comment strings - type: string - default: "#" - maxLength: 1 - minLength: 0 - dateTimeFormat: - description: Format of timestamps - type: string - default: "RFC3339" - enum: - - RFC3339 - - RFC3339Nano + description: Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions + type: object + properties: + header: + description: If true, the results will contain a header row + type: boolean + default: true + delimiter: + description: Separator between cells; the default is , + type: string + default: "," + maxLength: 1 + minLength: 1 + annotations: + description: Https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns + type: array + items: + type: string + enum: + - "group" + - "datatype" + - "default" + uniqueItems: true + commentPrefix: + description: Character prefixed to comment strings + type: string + default: "#" + maxLength: 1 + minLength: 0 + dateTimeFormat: + description: Format of timestamps + type: string + default: "RFC3339" + enum: + - RFC3339 + - RFC3339Nano Permission: required: [action, resource] properties: @@ -6993,45 +7368,47 @@ components: - read - write resource: - type: object - required: [type] - properties: - type: - type: string - enum: - - authorizations - - buckets - - dashboards - - orgs - - sources - - tasks - - telegrafs - - users - - variables - - scrapers - - secrets - - labels - - views - - documents - - notificationRules - - notificationEndpoints - - checks - id: - type: string - nullable: true - description: If ID is set that is a permission for a specific resource. if it is not set it is a permission for all resources of that resource type. - name: - type: string - nullable: true - description: Optional name of the resource if the resource has a name field. - orgID: - type: string - nullable: true - description: If orgID is set that is a permission for all resources owned my that org. if it is not set it is a permission for all resources of that resource type. - org: - type: string - nullable: true - description: Optional name of the organization of the organization with orgID. + $ref: "#/components/schemas/Resource" + Resource: + type: object + required: [type] + properties: + type: + type: string + enum: + - authorizations + - buckets + - dashboards + - orgs + - sources + - tasks + - telegrafs + - users + - variables + - scrapers + - secrets + - labels + - views + - documents + - notificationRules + - notificationEndpoints + - checks + id: + type: string + nullable: true + description: If ID is set that is a permission for a specific resource. if it is not set it is a permission for all resources of that resource type. + name: + type: string + nullable: true + description: Optional name of the resource if the resource has a name field. + orgID: + type: string + nullable: true + description: If orgID is set that is a permission for all resources owned my that org. if it is not set it is a permission for all resources of that resource type. + org: + type: string + nullable: true + description: Optional name of the organization of the organization with orgID. AuthorizationUpdateRequest: properties: status: @@ -7473,9 +7850,9 @@ components: retentionPeriod: type: integer labelAssociations: - type: array - items: - $ref: "#/components/schemas/PkgSummaryLabel" + type: array + items: + $ref: "#/components/schemas/PkgSummaryLabel" checks: type: array items: @@ -7661,9 +8038,9 @@ components: arguments: $ref: "#/components/schemas/VariableProperties" labelAssociations: - type: array - items: - $ref: "#/components/schemas/PkgSummaryLabel" + type: array + items: + $ref: "#/components/schemas/PkgSummaryLabel" diff: type: object properties: @@ -7823,44 +8200,44 @@ components: new: type: object properties: - name: - type: string - description: - type: string - endpointName: - type: string - endpointID: - type: string - endpointType: - type: string - every: - type: string - offset: - type: string - messageTemplate: - type: string - status: - type: string - statusRules: - type: array - items: - type: object - properties: - currentLevel: - type: string - previousLevel: - type: string - tagRules: - type: array - items: - type: object - properties: - key: - type: string - value: - type: string - operator: - type: string + name: + type: string + description: + type: string + endpointName: + type: string + endpointID: + type: string + endpointType: + type: string + every: + type: string + offset: + type: string + messageTemplate: + type: string + status: + type: string + statusRules: + type: array + items: + type: object + properties: + currentLevel: + type: string + previousLevel: + type: string + tagRules: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + operator: + type: string old: type: object properties: @@ -8222,6 +8599,85 @@ components: TaskStatusType: type: string enum: [active, inactive] + Invite: + properties: + id: + description: the idpe id of the invite + readOnly: true + type: string + email: + type: string + role: + type: string + enum: + - member + - owner + expiresAt: + format: date-time + type: string + links: + type: object + readOnly: true + example: + self: "/api/v2/invites/1" + properties: + self: + type: string + format: uri + required: [id, email, role] + Invites: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri + invites: + type: array + items: + $ref: "#/components/schemas/Invite" + CloudUser: + properties: + id: + description: the idpe id of the user + readOnly: true + type: string + firstName: + type: string + lastName: + type: string + email: + type: string + role: + type: string + enum: + - member + - owner + links: + type: object + readOnly: true + example: + self: "/api/v2/cloud_users/1" + properties: + self: + type: string + format: uri + required: [id, email, role] + CloudUsers: + type: object + properties: + links: + type: object + properties: + self: + type: string + format: uri + users: + type: array + items: + $ref: "#/components/schemas/CloudUser" User: properties: id: @@ -8511,7 +8967,7 @@ components: description: Args are the arguments to the function type: array items: - $ref: '#/components/schemas/Field' + $ref: "#/components/schemas/Field" BuilderConfig: type: object properties: @@ -8522,11 +8978,11 @@ components: tags: type: array items: - $ref: '#/components/schemas/BuilderTagsType' + $ref: "#/components/schemas/BuilderTagsType" functions: type: array items: - $ref: '#/components/schemas/BuilderFunctionsType' + $ref: "#/components/schemas/BuilderFunctionsType" aggregateWindow: type: object properties: @@ -8542,10 +8998,10 @@ components: items: type: string aggregateFunctionType: - $ref: '#/components/schemas/BuilderAggregateFunctionType' + $ref: "#/components/schemas/BuilderAggregateFunctionType" BuilderAggregateFunctionType: type: string - enum: ['filter', 'group'] + enum: ["filter", "group"] BuilderFunctionsType: type: object properties: @@ -8558,14 +9014,14 @@ components: type: string description: The text of the Flux query. editMode: - $ref: '#/components/schemas/QueryEditMode' + $ref: "#/components/schemas/QueryEditMode" name: type: string builderConfig: - $ref: '#/components/schemas/BuilderConfig' + $ref: "#/components/schemas/BuilderConfig" QueryEditMode: type: string - enum: ['builder', 'advanced'] + enum: ["builder", "advanced"] Axis: type: object description: The description of a particular axis for a visualization. @@ -8591,13 +9047,13 @@ components: base: description: Base represents the radix for formatting axis values. type: string - enum: ['', '2', '10'] + enum: ["", "2", "10"] scale: - $ref: '#/components/schemas/AxisScale' + $ref: "#/components/schemas/AxisScale" AxisScale: description: 'Scale is the axis formatting scale. Supported: "log", "linear"' type: string - enum: ['log', 'linear'] + enum: ["log", "linear"] DashboardColor: type: object description: Defines an encoding of data value into color space. @@ -8672,16 +9128,16 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean axes: - $ref: '#/components/schemas/Axes' + $ref: "#/components/schemas/Axes" legend: - $ref: '#/components/schemas/Legend' + $ref: "#/components/schemas/Legend" xColumn: type: string yColumn: @@ -8692,7 +9148,7 @@ components: type: string enum: [overlaid, stacked] geom: - $ref: '#/components/schemas/XYGeom' + $ref: "#/components/schemas/XYGeom" XYGeom: type: string enum: [line, step, stacked, bar, monotoneX] @@ -8712,6 +9168,8 @@ components: - decimalPlaces - position properties: + timeFormat: + type: string type: type: string enum: [line-plus-single-stat] @@ -8726,16 +9184,16 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: description: If true, will display note when empty type: boolean axes: - $ref: '#/components/schemas/Axes' + $ref: "#/components/schemas/Axes" legend: - $ref: '#/components/schemas/Legend' + $ref: "#/components/schemas/Legend" xColumn: type: string yColumn: @@ -8750,7 +9208,7 @@ components: suffix: type: string decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' + $ref: "#/components/schemas/DecimalPlaces" ScatterViewProperties: type: object required: @@ -8789,7 +9247,7 @@ components: type: string shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -8866,7 +9324,7 @@ components: type: string shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -8930,7 +9388,7 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -8945,7 +9403,7 @@ components: tickSuffix: type: string legend: - $ref: '#/components/schemas/Legend' + $ref: "#/components/schemas/Legend" decimalPlaces: $ref: "#/components/schemas/DecimalPlaces" HistogramViewProperties: @@ -8978,7 +9436,7 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -9004,7 +9462,21 @@ components: type: integer GaugeViewProperties: type: object - required: [type, queries, colors, shape, note, showNoteWhenEmpty, prefix, tickPrefix, suffix, tickSuffix, legend, decimalPlaces] + required: + [ + type, + queries, + colors, + shape, + note, + showNoteWhenEmpty, + prefix, + tickPrefix, + suffix, + tickSuffix, + legend, + decimalPlaces, + ] properties: type: type: string @@ -9020,7 +9492,7 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -9035,7 +9507,7 @@ components: tickSuffix: type: string legend: - $ref: '#/components/schemas/Legend' + $ref: "#/components/schemas/Legend" decimalPlaces: $ref: "#/components/schemas/DecimalPlaces" TableViewProperties: @@ -9066,7 +9538,7 @@ components: $ref: "#/components/schemas/DashboardColor" shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string showNoteWhenEmpty: @@ -9099,14 +9571,14 @@ components: customization options type: array items: - $ref: '#/components/schemas/RenamableField' + $ref: "#/components/schemas/RenamableField" timeFormat: description: >- timeFormat describes the display format for time values according to moment.js date formatting type: string decimalPlaces: - $ref: '#/components/schemas/DecimalPlaces' + $ref: "#/components/schemas/DecimalPlaces" MarkdownViewProperties: type: object required: @@ -9119,7 +9591,7 @@ components: enum: [markdown] shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] note: type: string CheckViewProperties: @@ -9136,11 +9608,11 @@ components: enum: [check] shape: type: string - enum: ['chronograf-v2'] + enum: ["chronograf-v2"] checkID: type: string check: - $ref: '#/components/schemas/Check' + $ref: "#/components/schemas/Check" queries: type: array items: @@ -9153,12 +9625,12 @@ components: Axes: description: The viewport for a View's visualizations type: object - required: ['x', 'y'] + required: ["x", "y"] properties: x: - $ref: '#/components/schemas/Axis' + $ref: "#/components/schemas/Axis" "y": # Quoted to prevent YAML parser from interpreting y as shorthand for true. - $ref: '#/components/schemas/Axis' + $ref: "#/components/schemas/Axis" Legend: description: Legend define encoding of data into a view's legend type: object @@ -9266,36 +9738,36 @@ components: type: object example: variables: - - id: '1221432' - name: ":ok:" - selected: - - hello - arguments: - type: constant - values: - - howdy - - hello - - hi - - yo - - oy - - id: '1221432' - name: ":ok:" - selected: - - c - arguments: - type: map - values: - a: fdjaklfdjkldsfjlkjdsa - b: dfaksjfkljekfajekdljfas - c: fdjksajfdkfeawfeea - - id: '1221432' - name: ":ok:" - selected: - - host - arguments: - type: query - query: 'from(bucket: "foo") |> showMeasurements()' - language: flux + - id: "1221432" + name: ":ok:" + selected: + - hello + arguments: + type: constant + values: + - howdy + - hello + - hi + - yo + - oy + - id: "1221432" + name: ":ok:" + selected: + - c + arguments: + type: map + values: + a: fdjaklfdjkldsfjlkjdsa + b: dfaksjfkljekfajekdljfas + c: fdjksajfdkfeawfeea + - id: "1221432" + name: ":ok:" + selected: + - host + arguments: + type: query + query: 'from(bucket: "foo") |> showMeasurements()' + language: flux properties: variables: type: array @@ -9336,7 +9808,7 @@ components: name: type: string properties: - $ref: '#/components/schemas/ViewProperties' + $ref: "#/components/schemas/ViewProperties" Views: type: object properties: @@ -9575,7 +10047,7 @@ components: type: string format: date-time cells: - $ref: "#/components/schemas/Cells" + $ref: "#/components/schemas/Cells" labels: $ref: "#/components/schemas/Labels" Dashboards: @@ -9611,7 +10083,7 @@ components: type: string type: type: string - enum: ["v1","v2","self"] + enum: ["v1", "v2", "self"] url: type: string format: uri @@ -9666,7 +10138,7 @@ components: url: type: string description: The URL of the metrics endpoint. - example: http://localhost:9090/metrics + example: http://localhost:9090/metrics orgID: type: string description: The organization ID. @@ -9840,20 +10312,20 @@ components: orgID: type: string TelegrafRequestPlugin: - oneOf: - - $ref: '#/components/schemas/TelegrafPluginInputCpu' - - $ref: '#/components/schemas/TelegrafPluginInputDisk' - - $ref: '#/components/schemas/TelegrafPluginInputDiskio' - - $ref: '#/components/schemas/TelegrafPluginInputDocker' - - $ref: '#/components/schemas/TelegrafPluginInputFile' - - $ref: '#/components/schemas/TelegrafPluginInputKubernetes' - - $ref: '#/components/schemas/TelegrafPluginInputLogParser' - - $ref: '#/components/schemas/TelegrafPluginInputProcstat' - - $ref: '#/components/schemas/TelegrafPluginInputPrometheus' - - $ref: '#/components/schemas/TelegrafPluginInputRedis' - - $ref: '#/components/schemas/TelegrafPluginInputSyslog' - - $ref: '#/components/schemas/TelegrafPluginOutputFile' - - $ref: '#/components/schemas/TelegrafPluginOutputInfluxDBV2' + oneOf: + - $ref: "#/components/schemas/TelegrafPluginInputCpu" + - $ref: "#/components/schemas/TelegrafPluginInputDisk" + - $ref: "#/components/schemas/TelegrafPluginInputDiskio" + - $ref: "#/components/schemas/TelegrafPluginInputDocker" + - $ref: "#/components/schemas/TelegrafPluginInputFile" + - $ref: "#/components/schemas/TelegrafPluginInputKubernetes" + - $ref: "#/components/schemas/TelegrafPluginInputLogParser" + - $ref: "#/components/schemas/TelegrafPluginInputProcstat" + - $ref: "#/components/schemas/TelegrafPluginInputPrometheus" + - $ref: "#/components/schemas/TelegrafPluginInputRedis" + - $ref: "#/components/schemas/TelegrafPluginInputSyslog" + - $ref: "#/components/schemas/TelegrafPluginOutputFile" + - $ref: "#/components/schemas/TelegrafPluginOutputInfluxDBV2" TelegrafPluginInputCpu: type: object required: @@ -9883,8 +10355,7 @@ components: comment: type: string TelegrafPluginInputDiskio: - type: - object + type: object required: - name - type @@ -9898,8 +10369,7 @@ components: comment: type: string TelegrafPluginInputDocker: - type: - object + type: object required: - name - type @@ -9914,10 +10384,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputDockerConfig' + $ref: "#/components/schemas/TelegrafPluginInputDockerConfig" TelegrafPluginInputFile: - type: - object + type: object required: - name - type @@ -9932,10 +10401,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputFileConfig' + $ref: "#/components/schemas/TelegrafPluginInputFileConfig" TelegrafPluginInputKernel: - type: - object + type: object required: - name - type @@ -9949,8 +10417,7 @@ components: comment: type: string TelegrafPluginInputKubernetes: - type: - object + type: object required: - name - type @@ -9965,10 +10432,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputKubernetesConfig' + $ref: "#/components/schemas/TelegrafPluginInputKubernetesConfig" TelegrafPluginInputLogParser: - type: - object + type: object required: - name - type @@ -9983,10 +10449,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputLogParserConfig' + $ref: "#/components/schemas/TelegrafPluginInputLogParserConfig" TelegrafPluginInputMem: - type: - object + type: object required: - name - type @@ -10000,8 +10465,7 @@ components: comment: type: string TelegrafPluginInputNetResponse: - type: - object + type: object required: - name - type @@ -10015,8 +10479,7 @@ components: comment: type: string TelegrafPluginInputNet: - type: - object + type: object required: - name - type @@ -10030,8 +10493,7 @@ components: comment: type: string TelegrafPluginInputNginx: - type: - object + type: object required: - name - type @@ -10045,8 +10507,7 @@ components: comment: type: string TelegrafPluginInputProcesses: - type: - object + type: object required: - name - type @@ -10060,8 +10521,7 @@ components: comment: type: string TelegrafPluginInputProcstat: - type: - object + type: object required: - name - type @@ -10076,10 +10536,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputProcstatConfig' + $ref: "#/components/schemas/TelegrafPluginInputProcstatConfig" TelegrafPluginInputPrometheus: - type: - object + type: object required: - name - type @@ -10094,10 +10553,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputPrometheusConfig' + $ref: "#/components/schemas/TelegrafPluginInputPrometheusConfig" TelegrafPluginInputRedis: - type: - object + type: object required: - name - type @@ -10112,10 +10570,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputRedisConfig' + $ref: "#/components/schemas/TelegrafPluginInputRedisConfig" TelegrafPluginInputSyslog: - type: - object + type: object required: - name - type @@ -10130,10 +10587,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginInputSyslogConfig' + $ref: "#/components/schemas/TelegrafPluginInputSyslogConfig" TelegrafPluginInputSwap: - type: - object + type: object required: - name - type @@ -10147,8 +10603,7 @@ components: comment: type: string TelegrafPluginInputSystem: - type: - object + type: object required: - name - type @@ -10162,8 +10617,7 @@ components: comment: type: string TelegrafPluginInputTail: - type: - object + type: object required: - name - type @@ -10177,8 +10631,7 @@ components: comment: type: string TelegrafPluginOutputFile: - type: - object + type: object required: - name - type @@ -10193,10 +10646,9 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginOutputFileConfig' + $ref: "#/components/schemas/TelegrafPluginOutputFileConfig" TelegrafPluginOutputInfluxDBV2: - type: - object + type: object required: - name - type @@ -10211,7 +10663,7 @@ components: comment: type: string config: - $ref: '#/components/schemas/TelegrafPluginOutputInfluxDBV2Config' + $ref: "#/components/schemas/TelegrafPluginOutputInfluxDBV2Config" Telegraf: type: object allOf: @@ -10441,6 +10893,10 @@ components: enum: - pass - fail + version: + type: string + commit: + type: string Labels: type: array items: @@ -10461,7 +10917,7 @@ components: additionalProperties: type: string description: Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value. - example: {"color": "ffb3b3", "description": "this is a description"} + example: { "color": "ffb3b3", "description": "this is a description" } LabelCreateRequest: type: object required: [orgID] @@ -10475,7 +10931,7 @@ components: additionalProperties: type: string description: Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value. - example: {"color": "ffb3b3", "description": "this is a description"} + example: { "color": "ffb3b3", "description": "this is a description" } LabelUpdate: type: object properties: @@ -10484,7 +10940,7 @@ components: properties: type: object description: Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value. - example: {"color": "ffb3b3", "description": "this is a description"} + example: { "color": "ffb3b3", "description": "this is a description" } LabelMapping: type: object properties: @@ -10583,7 +11039,7 @@ components: discriminator: propertyName: type mapping: - deadman: "#/components/schemas/DeadmanCheck" + deadman: "#/components/schemas/DeadmanCheck" threshold: "#/components/schemas/ThresholdCheck" custom: "#/components/schemas/CustomCheck" Check: @@ -10713,7 +11169,7 @@ components: propertyName: type mapping: greater: "#/components/schemas/GreaterThreshold" - lesser: "#/components/schemas/LesserThreshold" + lesser: "#/components/schemas/LesserThreshold" range: "#/components/schemas/RangeThreshold" DeadmanCheck: allOf: @@ -10755,7 +11211,7 @@ components: description: The template used to generate and write a status message. type: string CustomCheck: - allOf: + allOf: - $ref: "#/components/schemas/CheckBase" - type: object properties: @@ -10766,7 +11222,7 @@ components: ThresholdBase: properties: level: - $ref: "#/components/schemas/CheckStatusLevel" + $ref: "#/components/schemas/CheckStatusLevel" allValues: description: If true, only alert if all values meet threshold. type: boolean @@ -10975,7 +11431,7 @@ components: type: string operator: type: string - enum: ["equal", "notequal", "equalregex","notequalregex"] + enum: ["equal", "notequal", "equalregex", "notequalregex"] StatusRule: type: object properties: @@ -11067,7 +11523,7 @@ components: propertyName: type mapping: slack: "#/components/schemas/SlackNotificationEndpoint" - pagerduty: "#/components/schemas/PagerDutyNotificationEndpoint" + pagerduty: "#/components/schemas/PagerDutyNotificationEndpoint" http: "#/components/schemas/HTTPNotificationEndpoint" NotificationEndpoint: allOf: @@ -11176,10 +11632,10 @@ components: type: string method: type: string - enum: ['POST', 'GET', 'PUT'] + enum: ["POST", "GET", "PUT"] authMethod: type: string - enum: ['none', 'basic', 'bearer'] + enum: ["none", "basic", "bearer"] contentTemplate: type: string headers: @@ -11189,7 +11645,55 @@ components: type: string NotificationEndpointType: type: string - enum: ['slack', 'pagerduty', 'http'] + enum: ["slack", "pagerduty", "http"] + DBRP: + required: + - orgID + - bucketID + - database + - retention_policy + properties: + id: + type: string + description: the mapping identifier + readOnly: true + orgID: + type: string + description: the organization ID that owns this mapping. + bucketID: + type: string + description: the bucket ID used as target for the translation. + database: + type: string + description: InfluxDB v1 database + retention_policy: + type: string + description: InfluxDB v1 retention policy + default: + type: boolean + description: Specify if this mapping represents the default retention policy for the database specificed. + links: + $ref: "#/components/schemas/Links" + DBRPs: + properties: + notificationEndpoints: + type: array + items: + $ref: "#/components/schemas/DBRP" + links: + $ref: "#/components/schemas/Links" + DBRPUpdate: + properties: + database: + type: string + description: InfluxDB v1 database + retention_policy: + type: string + description: InfluxDB v1 retention policy + default: + type: boolean + links: + $ref: "#/components/schemas/Links" securitySchemes: BasicAuth: type: http