Skip to content

Commit f15d785

Browse files
jstirnamanjstirnaman
committed
chore(monolith): Core HTTP API and OpenAPI .info content for Core and Enterprise
1 parent 4314589 commit f15d785

File tree

25 files changed

+15439
-423
lines changed

25 files changed

+15439
-423
lines changed

‎api-docs/cloud-serverless/v2/ref.yml

Lines changed: 14836 additions & 0 deletions
Large diffs are not rendered by default.

‎api-docs/influxdb/cloud/v1-compatibility/content/info.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
title: InfluxDB v1 HTTP API for InfluxDB Cloud
1+
title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM)
22
x-influxdata-short-title: v1 Compatibility API
3-
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints.
43
description: |
5-
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
4+
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
5+
6+
The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana.
67
78
This documentation is generated from the
89
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
910
license:
1011
name: MIT
1112
url: 'https://opensource.org/licenses/MIT'
13+
contact:
14+
name: InfluxData
15+
url: https://www.influxdata.com
16+
email: [email protected]

‎api-docs/influxdb/cloud/v1-compatibility/swaggerV1Compat.yml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
openapi: 3.0.0
22
info:
3-
title: InfluxDB v1 HTTP API for InfluxDB Cloud
3+
title: InfluxDB v1 HTTP API for InfluxDB Cloud (TSM)
44
version: ''
55
description: |
6-
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
6+
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
7+
8+
The `/write` and `/query` endpoints support InfluxDB 1.x client libraries and third-party integrations such as Grafana.
79
810
This documentation is generated from the
911
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
1012
license:
1113
name: MIT
1214
url: https://opensource.org/licenses/MIT
13-
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB Cloud using InfluxDB v1-compatible endpoints.
15+
contact:
16+
name: InfluxData
17+
url: https://www.influxdata.com
18+
email: [email protected]
1419
servers:
1520
- url: /
1621
security:
@@ -276,9 +281,9 @@ components:
276281
properties:
277282
results:
278283
description: |
279-
A resultset object that contains the `statement_id` and the `series` array.
284+
A resultset object that contains the `statement_id` and the `series` array.
280285
281-
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
286+
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
282287
items:
283288
properties:
284289
error:
@@ -327,12 +332,12 @@ components:
327332
type: integer
328333
type: object
329334
oneOf:
330-
- required:
331-
- statement_id
332-
- error
333-
- required:
334-
- statement_id
335-
- series
335+
- required:
336+
- statement_id
337+
- error
338+
- required:
339+
- statement_id
340+
- series
336341
type: array
337342
type: object
338343
InfluxQLCSVResponse:

‎api-docs/influxdb/cloud/v2/content/info.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
title: InfluxDB Cloud API Service
22
x-influxdata-short-title: v2 API
3-
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
43
description: |
5-
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
4+
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
5+
Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
66
77
This documentation is generated from the
88
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
99
version: 2.x
1010
license:
1111
name: MIT
1212
url: 'https://opensource.org/licenses/MIT'
13+
contact:
14+
name: InfluxData
15+
url: https://www.influxdata.com
16+
email: [email protected]

‎api-docs/influxdb/cloud/v2/ref.yml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@ info:
33
title: InfluxDB Cloud API Service
44
version: 2.x
55
description: |
6-
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2. Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
6+
The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
7+
Access the InfluxDB API using `/api/v2/` and InfluxDB v1-compatible endpoints.
78

89
This documentation is generated from the
910
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml).
1011
license:
1112
name: MIT
1213
url: https://opensource.org/licenses/MIT
13-
summary: The InfluxDB v2 HTTP API provides a programmatic interface for all interactions with InfluxDB v2.
14+
contact:
15+
name: InfluxData
16+
url: https://www.influxdata.com
17+
email: [email protected]
1418
servers:
1519
- url: https://{baseurl}
1620
description: InfluxDB Cloud API URL
@@ -14600,9 +14604,9 @@ components:
1460014604
properties:
1460114605
results:
1460214606
description: |
14603-
A resultset object that contains the `statement_id` and the `series` array.
14607+
A resultset object that contains the `statement_id` and the `series` array.
1460414608

14605-
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
14609+
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
1460614610
items:
1460714611
properties:
1460814612
error:
@@ -14651,12 +14655,12 @@ components:
1465114655
type: integer
1465214656
type: object
1465314657
oneOf:
14654-
- required:
14655-
- statement_id
14656-
- error
14657-
- required:
14658-
- statement_id
14659-
- series
14658+
- required:
14659+
- statement_id
14660+
- error
14661+
- required:
14662+
- statement_id
14663+
- series
1466014664
type: array
1466114665
type: object
1466214666
IntegerLiteral:

‎api-docs/influxdb/v2/content/info.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ version: 2.x
1010
license:
1111
name: MIT
1212
url: 'https://opensource.org/licenses/MIT'
13+
contact:
14+
name: InfluxData
15+
url: https://www.influxdata.com
16+
email: [email protected]

‎api-docs/influxdb/v2/v1-compatibility/content/info.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
title: InfluxDB v1 HTTP API for InfluxDB v2 OSS
22
x-influxdata-short-title: v1 Compatibility API
3-
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints.
43
description: |
4+
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
55
The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
66
77
This documentation is generated from the
88
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
9-
109
license:
1110
name: MIT
1211
url: 'https://opensource.org/licenses/MIT'
12+
contact:
13+
name: InfluxData
14+
url: https://www.influxdata.com
15+
email: [email protected]

‎api-docs/influxdb/v2/v1-compatibility/swaggerV1Compat.yml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@ info:
33
title: InfluxDB v1 HTTP API for InfluxDB v2 OSS
44
version: ''
55
description: |
6-
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
6+
The v1-compatibility HTTP API provides compatibility for writing and querying data in an InfluxDB v2 bucket using InfluxDB v1 endpoints.
7+
The InfluxDB 1.x compatibility `/write` and `/query` endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
78
89
This documentation is generated from the
910
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).
1011
license:
1112
name: MIT
1213
url: https://opensource.org/licenses/MIT
13-
summary: The InfluxDB v1 compatibility API provides a programmatic interface for interactions with InfluxDB v2 using InfluxDB v1-compatible endpoints.
14+
contact:
15+
name: InfluxData
16+
url: https://www.influxdata.com
17+
email: [email protected]
1418
servers:
1519
- url: /
1620
security:
@@ -276,9 +280,9 @@ components:
276280
properties:
277281
results:
278282
description: |
279-
A resultset object that contains the `statement_id` and the `series` array.
283+
A resultset object that contains the `statement_id` and the `series` array.
280284
281-
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
285+
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
282286
items:
283287
properties:
284288
error:
@@ -327,12 +331,12 @@ components:
327331
type: integer
328332
type: object
329333
oneOf:
330-
- required:
331-
- statement_id
332-
- error
333-
- required:
334-
- statement_id
335-
- series
334+
- required:
335+
- statement_id
336+
- error
337+
- required:
338+
- statement_id
339+
- series
336340
type: array
337341
type: object
338342
InfluxQLCSVResponse:

‎api-docs/influxdb3/cloud-dedicated/management/content/info.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
title: InfluxDB 3 Cloud Dedicated Management API
22
x-influxdata-short-title: Management API
3-
summary: |
4-
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
53
description: |
6-
The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
4+
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
5+
The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
76
87
This documentation is generated from the
98
InfluxDB OpenAPI specification.
109
license:
1110
name: MIT
1211
url: 'https://opensource.org/licenses/MIT'
12+
contact:
13+
name: InfluxData
14+
url: https://www.influxdata.com
15+
email: [email protected]

‎api-docs/influxdb3/cloud-dedicated/management/openapi.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@ openapi: 3.1.0
22
info:
33
title: InfluxDB 3 Cloud Dedicated Management API
44
description: |
5-
The Management API lets you manage an InfluxDB 3 Cloud Dedicated instance and integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
5+
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
6+
The Management API lets you integrate functions such as creating and managing databases, permissions, and tokens into your workflow or application.
67
78
This documentation is generated from the
89
InfluxDB OpenAPI specification.
9-
summary: |
10-
The Management API for InfluxDB 3 Cloud Dedicated provides a programmatic interface for managing a Cloud Dedicated instance.
1110
license:
1211
name: MIT
1312
url: https://opensource.org/licenses/MIT
1413
version: ''
14+
contact:
15+
name: InfluxData
16+
url: https://www.influxdata.com
17+
email: [email protected]
1518
servers:
1619
- url: https://{baseurl}/api/v0
1720
description: InfluxDB 3 Cloud Dedicated Management API URL
@@ -37,8 +40,6 @@ tags:
3740
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
3841
3942
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
40-
41-
4243
- name: Database tokens
4344
description: Manage database read/write tokens for a cluster
4445
- name: Databases
@@ -1020,7 +1021,6 @@ paths:
10201021
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
10211022
10221023
If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
1023-
10241024
parameters:
10251025
- name: accountId
10261026
in: path

0 commit comments

Comments
 (0)