Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #2015 from zhulongcheng/trace-span 

docs(http): add OpenTracing span
pull/10616/head
Chris Goller 2018-12-20 20:46:10 -06:00 committed by GitHub
parent b59f71697c 03c4ef1898
commit 532a3b7294
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 163 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

163
http/swagger.yml
View File

@ -10,6 +10,8 @@ paths:
summary: Exchange basic auth credentials for session summary: Exchange basic auth credentials for session
security: security:
- basicAuth: [] - basicAuth: []
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'204': '204':
description: succesfully authenticated description: succesfully authenticated
@ -22,6 +24,8 @@ paths:
/signout: /signout:
post: post:
summary: Expire the current session summary: Expire the current session
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'204': '204':
description: session successfully expired description: session successfully expired
@ -34,6 +38,8 @@ paths:
/: /:
get: get:
summary: Map of all top level routes available summary: Map of all top level routes available
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
default: default:
description: All routes description: All routes
@ -46,6 +52,8 @@ paths:
tags: tags:
- Setup - Setup
summary: check if database has default user, org, bucket created, returns true if not. summary: check if database has default user, org, bucket created, returns true if not.
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: description:
@ -58,6 +66,8 @@ paths:
tags: tags:
- Setup - Setup
summary: post onboarding request, to setup initial user, org and bucket summary: post onboarding request, to setup initial user, org and bucket
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: source to create description: source to create
required: true required: true
@ -77,6 +87,7 @@ paths:
tags: tags:
- Telegrafs - Telegrafs
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -101,6 +112,7 @@ paths:
- Telegrafs - Telegrafs
summary: Create a telegraf config summary: Create a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -133,6 +145,7 @@ paths:
- Telegrafs - Telegrafs
summary: Retrieve a telegraf config summary: Retrieve a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -165,6 +178,7 @@ paths:
- Telegrafs - Telegrafs
summary: Update a telegraf config summary: Update a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -197,6 +211,7 @@ paths:
- Telegrafs - Telegrafs
summary: list all labels for a telegraf config summary: list all labels for a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -226,6 +241,7 @@ paths:
- Telegrafs - Telegrafs
summary: add a label to a telegraf config summary: add a label to a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -266,6 +282,7 @@ paths:
- Telegrafs - Telegrafs
summary: delete a label from a telegraf config summary: delete a label from a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -298,6 +315,7 @@ paths:
- Telegrafs - Telegrafs
summary: update a label from a telegraf config summary: update a label from a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -339,6 +357,7 @@ paths:
- Telegrafs - Telegrafs
summary: List all users with member privileges for a telegraf config summary: List all users with member privileges for a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -364,6 +383,7 @@ paths:
- Telegrafs - Telegrafs
summary: Add telegraf config member summary: Add telegraf config member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -397,6 +417,7 @@ paths:
- Telegrafs - Telegrafs
summary: removes a member from a telegraf config summary: removes a member from a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -425,6 +446,7 @@ paths:
- Telegrafs - Telegrafs
summary: List all owners of a telegraf config summary: List all owners of a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -450,6 +472,7 @@ paths:
- Telegrafs - Telegrafs
summary: Add telegraf config owner summary: Add telegraf config owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: telegrafID name: telegrafID
schema: schema:
@ -483,6 +506,7 @@ paths:
- Telegrafs - Telegrafs
summary: removes an owner from a telegraf config summary: removes an owner from a telegraf config
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -510,6 +534,7 @@ paths:
- Macros - Macros
summary: get all macros summary: get all macros
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
required: true required: true
@ -539,6 +564,8 @@ paths:
summary: create a macro summary: create a macro
tags: tags:
- Macros - Macros
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: macro to create description: macro to create
required: true required: true
@ -565,6 +592,7 @@ paths:
- Macros - Macros
summary: delete a macro summary: delete a macro
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: macroID name: macroID
required: true required: true
@ -585,6 +613,7 @@ paths:
tags: tags:
- Macros - Macros
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: macroID name: macroID
required: true required: true
@ -616,6 +645,7 @@ paths:
tags: tags:
- Macros - Macros
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: macroID name: macroID
required: true required: true
@ -648,6 +678,7 @@ paths:
- Write - Write
summary: write time-series data into influxdb summary: write time-series data into influxdb
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: header - in: header
name: Content-Encoding name: Content-Encoding
description: when present, its value indicates to the database that compression is applied to the line-protocol body. description: when present, its value indicates to the database that compression is applied to the line-protocol body.
@ -765,6 +796,8 @@ paths:
tags: tags:
- Ready - Ready
summary: Get the readiness of a instance at startup. Allow us to confirm the instance is prepared to accept requests. summary: Get the readiness of a instance at startup. Allow us to confirm the instance is prepared to accept requests.
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: the instance is ready description: the instance is ready
@ -789,6 +822,8 @@ paths:
tags: tags:
- Health - Health
summary: Get the health of an instance anytime during execution. Allow us to check if the instance is still healthy. summary: Get the health of an instance anytime during execution. Allow us to check if the instance is still healthy.
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: the instance is healthy description: the instance is healthy
@ -814,6 +849,7 @@ paths:
- Sources - Sources
summary: Creates a Source summary: Creates a Source
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -845,6 +881,7 @@ paths:
- Sources - Sources
summary: Get all sources summary: Get all sources
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -870,6 +907,7 @@ paths:
- Sources - Sources
summary: Updates a Source summary: Updates a Source
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: sourceID name: sourceID
schema: schema:
@ -907,6 +945,7 @@ paths:
- Sources - Sources
summary: Get a source summary: Get a source
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: sourceID name: sourceID
schema: schema:
@ -938,6 +977,7 @@ paths:
- Sources - Sources
summary: Get a sources health summary: Get a sources health
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: sourceID name: sourceID
schema: schema:
@ -970,6 +1010,7 @@ paths:
- Buckets - Buckets
summary: Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source) summary: Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source)
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: sourceID name: sourceID
schema: schema:
@ -1007,6 +1048,7 @@ paths:
- Views - Views
summary: A view contains information about the visual representation of data summary: A view contains information about the visual representation of data
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -1038,6 +1080,7 @@ paths:
- Views - Views
summary: Get all views summary: Get all views
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -1076,6 +1119,7 @@ paths:
- Views - Views
summary: Get a single View summary: Get a single View
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1113,6 +1157,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/View" $ref: "#/components/schemas/View"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1143,6 +1188,7 @@ paths:
- Views - Views
summary: Delete a view summary: Delete a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1170,6 +1216,7 @@ paths:
- Views - Views
summary: list all labels for a view summary: list all labels for a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1199,6 +1246,7 @@ paths:
- Views - Views
summary: add a label to a view summary: add a label to a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1239,6 +1287,7 @@ paths:
- Views - Views
summary: delete a label from a view summary: delete a label from a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1271,6 +1320,7 @@ paths:
- Views - Views
summary: update a label from a view summary: update a label from a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1312,6 +1362,7 @@ paths:
- Views - Views
summary: List all view members summary: List all view members
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1337,6 +1388,7 @@ paths:
- Views - Views
summary: Add view member summary: Add view member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1370,6 +1422,7 @@ paths:
- Views - Views
summary: removes a member from an view summary: removes a member from an view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -1398,6 +1451,7 @@ paths:
- Views - Views
summary: List all view owners summary: List all view owners
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1423,6 +1477,7 @@ paths:
- Views - Views
summary: Add view owner summary: Add view owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: viewID name: viewID
schema: schema:
@ -1456,6 +1511,7 @@ paths:
- Views - Views
summary: removes an owner from a view summary: removes an owner from a view
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -1483,6 +1539,7 @@ paths:
- Dashboards - Dashboards
summary: Create a dashboard summary: Create a dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -1514,6 +1571,7 @@ paths:
- Dashboards - Dashboards
summary: Get all dashboards summary: Get all dashboards
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: owner name: owner
description: specifies the owner id to return resources for description: specifies the owner id to return resources for
@ -1554,6 +1612,7 @@ paths:
- Dashboards - Dashboards
summary: Get a single Dashboard summary: Get a single Dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1591,6 +1650,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Dashboard" $ref: "#/components/schemas/Dashboard"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1621,6 +1681,7 @@ paths:
- Dashboards - Dashboards
summary: Delete a dashboard summary: Delete a dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1656,6 +1717,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Cells" $ref: "#/components/schemas/Cells"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1694,6 +1756,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/CreateCell" $ref: "#/components/schemas/CreateCell"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1733,6 +1796,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/CellUpdate" $ref: "#/components/schemas/CellUpdate"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1770,6 +1834,7 @@ paths:
- Dashboards - Dashboards
summary: Delete a dashboard cell summary: Delete a dashboard cell
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1803,6 +1868,7 @@ paths:
- Dashboards - Dashboards
summary: list all labels for a dashboard summary: list all labels for a dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1832,6 +1898,7 @@ paths:
- Dashboards - Dashboards
summary: add a label to a dashboard summary: add a label to a dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1873,6 +1940,7 @@ paths:
- Dashboards - Dashboards
summary: List all dashboard members summary: List all dashboard members
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1898,6 +1966,7 @@ paths:
- Dashboards - Dashboards
summary: Add dashboard member summary: Add dashboard member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1931,6 +2000,7 @@ paths:
- Dashboards - Dashboards
summary: removes a member from an dashboard summary: removes a member from an dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -1959,6 +2029,7 @@ paths:
- Dashboards - Dashboards
summary: List all dashboard owners summary: List all dashboard owners
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -1984,6 +2055,7 @@ paths:
- Dashboards - Dashboards
summary: Add dashboard owner summary: Add dashboard owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: dashboardID name: dashboardID
schema: schema:
@ -2017,6 +2089,7 @@ paths:
- Dashboards - Dashboards
summary: removes an owner from an dashboard summary: removes an owner from an dashboard
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -2044,6 +2117,7 @@ paths:
tags: tags:
- Query - Query
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: header - in: header
name: Content-Type name: Content-Type
schema: schema:
@ -2077,6 +2151,7 @@ paths:
tags: tags:
- Query - Query
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: header - in: header
name: Content-Type name: Content-Type
schema: schema:
@ -2106,6 +2181,8 @@ paths:
get: get:
tags: tags:
- Query - Query
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: Suggestions for next functions in call chain description: Suggestions for next functions in call chain
@ -2121,6 +2198,7 @@ paths:
$ref: "#/components/schemas/Error" $ref: "#/components/schemas/Error"
/query/suggestions/{name}: /query/suggestions/{name}:
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: name name: name
schema: schema:
@ -2149,6 +2227,7 @@ paths:
- Authorizations - Authorizations
summary: List all authorizations summary: List all authorizations
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: userID name: userID
schema: schema:
@ -2176,6 +2255,8 @@ paths:
tags: tags:
- Authorizations - Authorizations
summary: Create an authorization summary: Create an authorization
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: authorization to create description: authorization to create
required: true required: true
@ -2202,6 +2283,7 @@ paths:
- Authorizations - Authorizations
summary: Retrieve an authorization summary: Retrieve an authorization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: authID name: authID
schema: schema:
@ -2233,6 +2315,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Authorization" $ref: "#/components/schemas/Authorization"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: authID name: authID
schema: schema:
@ -2257,6 +2340,7 @@ paths:
- Authorizations - Authorizations
summary: Delete a authorization summary: Delete a authorization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: authID name: authID
schema: schema:
@ -2278,6 +2362,7 @@ paths:
- Query - Query
summary: analyze an influxql or flux query summary: analyze an influxql or flux query
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: header - in: header
name: Content-Type name: Content-Type
schema: schema:
@ -2318,6 +2403,7 @@ paths:
- Query - Query
summary: query influx with specified return formatting. The spec and query fields are mutually exclusive. summary: query influx with specified return formatting. The spec and query fields are mutually exclusive.
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -2383,6 +2469,7 @@ paths:
- Query - Query
summary: query an influx summary: query an influx
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: header - in: header
name: Accept name: Accept
description: specifies the return content format. Each response content type will have its own dialect options. description: specifies the return content format. Each response content type will have its own dialect options.
@ -2476,6 +2563,7 @@ paths:
- Buckets - Buckets
summary: List all buckets summary: List all buckets
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- $ref: "#/components/parameters/Offset" - $ref: "#/components/parameters/Offset"
- $ref: "#/components/parameters/Limit" - $ref: "#/components/parameters/Limit"
- in: query - in: query
@ -2511,6 +2599,7 @@ paths:
- Buckets - Buckets
summary: Create a bucket summary: Create a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: org name: org
description: specifies the organization of the resource description: specifies the organization of the resource
@ -2543,6 +2632,7 @@ paths:
- Buckets - Buckets
summary: Retrieve a bucket summary: Retrieve a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2574,6 +2664,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Bucket" $ref: "#/components/schemas/Bucket"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2598,6 +2689,7 @@ paths:
- Buckets - Buckets
summary: Delete a bucket summary: Delete a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2625,6 +2717,7 @@ paths:
- Buckets - Buckets
summary: list all labels for a bucket summary: list all labels for a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2654,6 +2747,7 @@ paths:
- Buckets - Buckets
summary: add a label to a bucket summary: add a label to a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2694,6 +2788,7 @@ paths:
- Buckets - Buckets
summary: delete a label from a bucket summary: delete a label from a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2726,6 +2821,7 @@ paths:
- Buckets - Buckets
summary: update a label from a bucket summary: update a label from a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2767,6 +2863,7 @@ paths:
- Buckets - Buckets
summary: List all users with member privileges for a bucket summary: List all users with member privileges for a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2792,6 +2889,7 @@ paths:
- Buckets - Buckets
summary: Add bucket member summary: Add bucket member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2825,6 +2923,7 @@ paths:
- Buckets - Buckets
summary: removes a member from an bucket summary: removes a member from an bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -2853,6 +2952,7 @@ paths:
- Buckets - Buckets
summary: List all owners of a bucket summary: List all owners of a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2878,6 +2978,7 @@ paths:
- Buckets - Buckets
summary: Add bucket owner summary: Add bucket owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: bucketID name: bucketID
schema: schema:
@ -2911,6 +3012,7 @@ paths:
- Buckets - Buckets
summary: removes an owner from a bucket summary: removes an owner from a bucket
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -2954,6 +3056,8 @@ paths:
tags: tags:
- Organizations - Organizations
summary: Create an organization summary: Create an organization
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: organization to create description: organization to create
required: true required: true
@ -2980,6 +3084,7 @@ paths:
- Organizations - Organizations
summary: Retrieve an organization summary: Retrieve an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3011,6 +3116,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Organization" $ref: "#/components/schemas/Organization"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3035,6 +3141,7 @@ paths:
- Organizations - Organizations
summary: Delete an organization summary: Delete an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3062,6 +3169,7 @@ paths:
- Organizations - Organizations
summary: list all labels for a organization summary: list all labels for a organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3091,6 +3199,7 @@ paths:
- Organizations - Organizations
summary: add a label to an organization summary: add a label to an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3131,6 +3240,7 @@ paths:
- Organizations - Organizations
summary: delete a label from an organization summary: delete a label from an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3163,6 +3273,7 @@ paths:
- Organizations - Organizations
summary: update a label from an organization summary: update a label from an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3204,6 +3315,7 @@ paths:
- Organizations - Organizations
summary: List all secret keys for an organization summary: List all secret keys for an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3229,6 +3341,7 @@ paths:
- Organizations - Organizations
summary: Apply patch to the provided secrets summary: Apply patch to the provided secrets
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3258,6 +3371,7 @@ paths:
- Organizations - Organizations
summary: delete provided secrets summary: delete provided secrets
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3287,6 +3401,7 @@ paths:
- Organizations - Organizations
summary: List all members of an organization summary: List all members of an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3312,6 +3427,7 @@ paths:
- Organizations - Organizations
summary: Add organization member summary: Add organization member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3345,6 +3461,7 @@ paths:
- Organizations - Organizations
summary: removes a member from an organization summary: removes a member from an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -3373,6 +3490,7 @@ paths:
- Organizations - Organizations
summary: List all owners of an organization summary: List all owners of an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3398,6 +3516,7 @@ paths:
- Organizations - Organizations
summary: Add organization owner summary: Add organization owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: orgID name: orgID
schema: schema:
@ -3431,6 +3550,7 @@ paths:
- Organizations - Organizations
summary: removes an owner from an organization summary: removes an owner from an organization
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -3458,6 +3578,7 @@ paths:
- Tasks - Tasks
summary: List tasks. summary: List tasks.
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: query - in: query
name: after name: after
schema: schema:
@ -3498,6 +3619,8 @@ paths:
tags: tags:
- Tasks - Tasks
summary: Create a new task summary: Create a new task
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: task to create description: task to create
required: true required: true
@ -3524,6 +3647,7 @@ paths:
- Tasks - Tasks
summary: Retrieve an task summary: Retrieve an task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3556,6 +3680,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/Task" $ref: "#/components/schemas/Task"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3581,6 +3706,7 @@ paths:
summary: Delete a task summary: Delete a task
description: Deletes a task and all associated records description: Deletes a task and all associated records
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3602,6 +3728,7 @@ paths:
- Tasks - Tasks
summary: Retrieve list of run records for a task summary: Retrieve list of run records for a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3659,6 +3786,7 @@ paths:
- Tasks - Tasks
summary: Retrieve a single run record for a task summary: Retrieve a single run record for a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3690,6 +3818,7 @@ paths:
- Tasks - Tasks
summary: Retry a task run summary: Retry a task run
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3721,6 +3850,7 @@ paths:
- Tasks - Tasks
summary: Retrieve all logs for a task summary: Retrieve all logs for a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3746,6 +3876,7 @@ paths:
- Tasks - Tasks
summary: Retrieve all logs for a run summary: Retrieve all logs for a run
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3777,6 +3908,7 @@ paths:
- Tasks - Tasks
summary: list all labels for a task summary: list all labels for a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3808,6 +3940,7 @@ paths:
- Tasks - Tasks
summary: add a label to a task summary: add a label to a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3850,6 +3983,7 @@ paths:
- Tasks - Tasks
summary: delete a label from a task summary: delete a label from a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3882,6 +4016,7 @@ paths:
- Tasks - Tasks
summary: update a label from a task summary: update a label from a task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3921,6 +4056,8 @@ paths:
tags: tags:
- Users - Users
summary: Returns currently authenticated user summary: Returns currently authenticated user
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: currently authenticated user description: currently authenticated user
@ -3941,6 +4078,8 @@ paths:
summary: Update password summary: Update password
security: security:
- basicAuth: [] - basicAuth: []
parameters:
- $ref: '#/components/parameters/TraceSpan'
requestBody: requestBody:
description: new password description: new password
required: true required: true
@ -3964,6 +4103,7 @@ paths:
- Tasks - Tasks
summary: List all task members summary: List all task members
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -3989,6 +4129,7 @@ paths:
- Tasks - Tasks
summary: Add task member summary: Add task member
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -4022,6 +4163,7 @@ paths:
- Tasks - Tasks
summary: removes a member from an task summary: removes a member from an task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4050,6 +4192,7 @@ paths:
- Tasks - Tasks
summary: List all task owners summary: List all task owners
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -4075,6 +4218,7 @@ paths:
- Tasks - Tasks
summary: Add task owner summary: Add task owner
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: taskID name: taskID
schema: schema:
@ -4108,6 +4252,7 @@ paths:
- Tasks - Tasks
summary: removes an owner from an task summary: removes an owner from an task
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4134,6 +4279,8 @@ paths:
tags: tags:
- Users - Users
summary: List all users summary: List all users
parameters:
- $ref: '#/components/parameters/TraceSpan'
responses: responses:
'200': '200':
description: a list of users description: a list of users
@ -4177,6 +4324,7 @@ paths:
- Users - Users
summary: Retrieve a user summary: Retrieve a user
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4208,6 +4356,7 @@ paths:
schema: schema:
$ref: "#/components/schemas/User" $ref: "#/components/schemas/User"
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4232,6 +4381,7 @@ paths:
- Users - Users
summary: deletes a user summary: deletes a user
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4255,6 +4405,7 @@ paths:
security: security:
- basicAuth: [] - basicAuth: []
parameters: parameters:
- $ref: '#/components/parameters/TraceSpan'
- in: path - in: path
name: userID name: userID
schema: schema:
@ -4312,6 +4463,18 @@ components:
required: false required: false
schema: schema:
type: string type: string
TraceSpan:
in: header
name: Zap-Trace-Span
description: OpenTracing span context
example:
trace_id: '1'
span_id: '1'
baggage:
key: value
required: false
schema:
type: string
schemas: schemas:
LanguageRequest: LanguageRequest:
description: flux query to be analyzed. description: flux query to be analyzed.