Skip to content

Commit

Permalink
InfluxDB 2.1 (influxdata#3367)
Browse files Browse the repository at this point in the history
* base changes for influxdb 2.1

* remove duplicates in draft

* draft categories

* add categories

* Document wildcards in SHOW MEASUREMENTS ON queries (influxdata#3273)

* InfluxQL: document wildcards in SHOW MEASUREMENTS ON queries

This applies to InfluxDB 2.1.

See influxdata#3201

* latest notes

* Update `influxd --store` values (influxdata#3272)

* Use Unix ~ alias
* Add sqlite path to file layout doc
* add sqlite to filesystem diagrams

* draft 2.1 release notes +questions

* revert to check RNs changes in separately

* latest release notes

* Restructure installation docs for separate CLI package (influxdata#3280)

* influxdb and cli install revamp

* reorganized CLI install instructions

* remove unnecessary short-code parameters

* updated docs to address PR feedback

* Apply suggestions from code review

Co-authored-by: pierwill <[email protected]>
Co-authored-by: kelseiv <[email protected]>

* Apply suggestions from code review

* update linux install instructions

Co-authored-by: pierwill <[email protected]>
Co-authored-by: kelseiv <[email protected]>

* release note updates

* updates

* add support for annotations in OSS 2.1 (influxdata#3286)

* Document support for bearer auth sytax (influxdata#3297)

* 2.1 oss notebooks (influxdata#3281)

* Move notebooks to OSS (addresses influxdata#2951 )

* Update content/influxdb/v2.1/notebooks/clean-data.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/manage-notebooks.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/_index.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/troubleshoot-notebooks.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/clean-data.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/clean-data.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/clean-data.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/overview.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Update content/influxdb/v2.1/notebooks/create-notebook.md

Co-authored-by: kelseiv <[email protected]>

* Add PR feedback

Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: kelseiv <[email protected]>

* Fix link in bearer auth sytax doc (influxdata#3298)

* Updated CLI docs content and added version metadata (influxdata#3285)

* added metadata styles and data to cli docs

* added missing ui-disabled influxd config flag

* added updated versions to influx cli metadata

* added metadata to all cloud influx cli docs

* updated influx ping in cloud to have oss only tag

* Update influxd documentation for 2.1 (influxdata#3302)

* update and dynamically generate links to influxd flags (influxdata#3288)

* remove 2.1 config options from 2.0

* New influxd commands (influxdata#3291)

* added basic influxd recovery commands

* added influxd recover commands, WIP for other influxd inspect commands

* updated all influxd inspect commands

* Apply suggestions from code review

Co-authored-by: kelseiv <[email protected]>

* updated influxd docs to address PR feedback

Co-authored-by: kelseiv <[email protected]>

Co-authored-by: kelseiv <[email protected]>

* Add static legend to band and graph visualizations (influxdata#3315)

* update band vis to include static legend

* upd graph and graph-single-stat w static legend

* update 2.1 links

* update to latest Flux links

* fix Flux links

* Influxdb 2.1 release notes (influxdata#3279)

* draft release notes

* latest RN changes

* test

* revert

* for review purposes

* incorporate changes from new changelog

* add note about new metadata included in CLI docs

* edit

* more edits

* add overview features list

* tweak verbiage about Telegraf support

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Scott Anderson <[email protected]>

* add link

* add edits from Scott, Dan, and Will

* edits from dan

* highlight and distinguish CLI separation changes

* add links to new API endpoints

* formatting upd

* edits for secrets

* mv Flux location support after rsv merge conflicts

* edits from Tim

* update influxql link

* rmv SLQ metastore link

* minor updates to 2.1 release notes

* prep

* Update content/influxdb/v2.1/reference/release-notes/influxdb.md

Co-authored-by: Greg <[email protected]>

Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Greg <[email protected]>

* add new Telegraf plugins to release notes

* edit from Will

* 2.1 upgrade and downgrade instructions (influxdata#3332)

* influxd downgrade command, add upgrade instructions, closes influxdata#3331

* Apply suggestions from code review

Co-authored-by: kelseiv <[email protected]>

* Apply suggestions from code review

Co-authored-by: Daniel Moran <[email protected]>

* udpated downgrade docs to address PR feedback

* remove references to localhost:1313

Co-authored-by: kelseiv <[email protected]>
Co-authored-by: Daniel Moran <[email protected]>

* updated flux version in release notes, added other new items, closes influxdata#3338 (influxdata#3344)

* Chore/update oss api (influxdata#3341)

* Standardize the term "key-value" (influxdata#3283)

* s|key/value|key-value
* Use en dash in prefix to open compound "time series"

* CLI 2.2 (influxdata#3269)

* add -b shorthand to influx delete

* add cli 2.2 release notes

* add example for all-access token

* edits

* updates to influx auth create

* edits for operator token

* remove inaccurate env var

* Update influx-cli.md

* Update influx-cli.md

* make capitalization consistent with other docs

* make headers parallel

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* edits from Scott and Dan

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Daniel Moran <[email protected]>

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Daniel Moran <[email protected]>

* edits to CLI

* add oss-only shortcode and fix formatting

* format updates

* fix links

* add oss-only inline

* fix list

* Update content/influxdb/v2.0/security/tokens/create-token.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.0/security/tokens/create-token.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.0/security/tokens/create-token.md

Co-authored-by: Scott Anderson <[email protected]>

* edits from Dan

* emphasize recommendation

* edit from Dan re limits and page size

* edit f Sam

* update release date

* remove vague description

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/v2.0/reference/cli/influx/auth/create.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* Update content/influxdb/cloud/reference/release-notes/influx-cli.md

Co-authored-by: Scott Anderson <[email protected]>

* edits from Scott

Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Daniel Moran <[email protected]>

* add cloud updates in Sept (influxdata#3210)

* Fix numbering in AWS install doc (influxdata#3293)

Closes influxdata#3292

* Document new API Invocable Scripts feature (was named-functions) (influxdata#3282)

* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (#influxdata#2547, influxdata#2233).

* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.

* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.

* feat: rename example function for simplicity since there's no GET for now.

* feat: add find_and_update example (influxdata#2547).

* feat: add update example. Clarify, expand invoke example. Add links. (influxdata#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: Scott Anderson <[email protected]>

* fix: remove accidental commit of generated redoc-static.html

* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.

* fix: replace /functions with /scripts

* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml

* feat: invocable scripts (influxdata#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: pierwill <[email protected]>

* feat: new section for params (influxdata#2547).

* fix: swagger server url (influxdata#2547)

* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md

Co-authored-by: Scott Anderson <[email protected]>

* feat: remove jq and function where there's no clear need.

Co-authored-by: pierwill <[email protected]>

* fix: add Invocable Scripts tag description. (influxdata#3296)

* Fix api invocable (influxdata#3299)

* fix: scripts api path.

* fix: bad comma

* Fix api invocable (influxdata#3306)

* fix: scripts api path.

* fix: bad comma

* feat: add invocable scripts example for sending multiple parameter values.

* fix: endpoint text. (influxdata#3308)

* Fix api invocable (influxdata#3310)

* fix: measurement -> point

* fix: cloud API ref. Remove private paths. Patch description and orgID params into ScriptCreateRequest.

* updated token naming and other typos, closes influxdata/DAR#244 (influxdata#3309)

* Flux 0.136 (influxdata#3311)

* Flux 0.136.0 release notes

* Update pagerduty package for flux 0.136.0 (influxdata#3303)

* Add Flux ServiceNow package (influxdata#3304)

* added Flux servicenow package

* Apply suggestions from code review

* Enterprise dar updates (influxdata#3313)

* removed references to web server in enteprise cluster docs, closes influxdata/DAR#245

* updated enterprise upgrade instructions, closes influxdata/DAR#243

* Apply suggestions from code review

Co-authored-by: pierwill <[email protected]>

Co-authored-by: pierwill <[email protected]>

* fix: mjs example path (influxdata#3305) (influxdata#3316)

* 3240 fix nodejs alias (influxdata#3317)

* fix: mjs example path (influxdata#3305)

* fix: add alias to node.js client library (influxdata#3240)

* Edit description for amd_rocm_smi Telegraf plugin (influxdata#3186)

* Edit description for amd_rocm_smi Telegraf plugin

Edit name and description for amd_rocm_smi Telegraf plugin. 

Not sure if this is the only location that it needs to be udpated.

* cpl minor updates

Co-authored-by: Kelly <[email protected]>

* remove influxql support from v2 api, closes influxdata/DAR#246 (influxdata#3326)

* Telegraf 1.20.3 (influxdata#3328)

* Telegraf 1.20.3

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <[email protected]>

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <[email protected]>

* Update content/telegraf/v1.20/about_the_project/release-notes-changelog.md

Co-authored-by: kelseiv <[email protected]>

* Address PR feedback

Co-authored-by: kelseiv <[email protected]>

* docs: update telegraf configuration.md (influxdata#3300)

* docs: update telegraf configuration.md

* add note about rate limits

* fix: correct debian/ubuntu install instructions (influxdata#3312)

* fix: correct debian/ubuntu install instructions

This consolidates the Debian and Ubutnu install instructions into one
section. The install instructions can be the same for both as they use
the same package manager (i.e. apt).

This removes the use of the now deprecated pipe to apt-key.

This removes references to starting the service, as the service starts
on install and does not require an extra step. Also all supported
operating systems are using systemd at this point so no need to call
that out seperatly.

Removes an extra 'sudo' in deb instructions.

* missing word

* added flux 0.137.0 release notes, added vertica sql support docs (influxdata#3318)

* Update _index.md (influxdata#3195)

broken link for external plugin repo

* Addresses influxdata#3284 (influxdata#3334)

* Updates to Flux `to()` (influxdata#3260)

Closes influxdata/DAR#236.
Closes influxdata#3258.

Co-authored-by: Scott Anderson <[email protected]>

* Fix shim and other link (influxdata#3336)

* Update Kapacitor security docs (influxdata#3325)

Co-authored-by: kelseiv <[email protected]>

* Include TLS setup in Enterprise post-install steps  (influxdata#3271)

- Rename TLS guide file.
- Use term "TLS" in title and introduction of TLS guide.

Closes influxdata#3270.

Co-authored-by: kelseiv <[email protected]>

* Flux 0.138.0 and 0.139.0 (influxdata#3335)

* added release notes for flux 0.138 and 0.139 and related updates

* updated spec with related implementation issue

* Apply suggestions from code review

Co-authored-by: kelseiv <[email protected]>

* updated to address PR feedback, added related links to int, uint, and bitwise docs

Co-authored-by: kelseiv <[email protected]>

* hotfix load data link

* add aliases and fix load data link in oss

* API Ref docs processing (influxdata#3337)

* chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml.
Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future.
Add an OpenAPI CLI docs-plugin with content and decorators.

* chore: update api-docs/README.md

* fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup.

* chore: update cloud contract.

* chore: update oss API contract.

* Apply suggestions from code review

Co-authored-by: kelseiv <[email protected]>

* Apply suggestions from code review

Co-authored-by: pierwill <[email protected]>
Co-authored-by: kelseiv <[email protected]>
Co-authored-by: Scott Anderson <[email protected]>
Co-authored-by: Daniel Moran <[email protected]>
Co-authored-by: Samantha Wang <[email protected]>
Co-authored-by: Kelly <[email protected]>
Co-authored-by: noramullen1 <[email protected]>
Co-authored-by: Joshua Powers <[email protected]>
Co-authored-by: bgilmore-iot <[email protected]>

* edit from Tim: update v2.0 to v2.1 in API section

* fix 2.1 links

* Fix/api ref 2.1 (influxdata#3363)

* fix: cloud-specific v1compat auth examples.

* fix: openapi. Disabled securityScheme replacement. Cleaned up placeholders. Added links.

* fix: update API auth descriptions. add API ref v2.1. Update links in openapi content.

* fix: updates URLs to v2.1 in API ref docs

* add verify-tsm to 2.1 release notes

* Clockface updates for 2.1 and Cloud (influxdata#3364)

* versioned old icomoon font

* updated all existing icons with versioned style

* Revert "updated all existing icons with versioned style"

This reverts commit 79b6cdf.

* versioned icon shortcode

* update icons and new styles for clockface v3

* updated nav-icon shortcode and styles

* updated account nav icon styles

* misc updates

* general style updates

* updated oss versions on the homepage

* fixed tick card colors on homepage

Co-authored-by: Kelly <[email protected]>
Co-authored-by: pierwill <[email protected]>
Co-authored-by: kelseiv <[email protected]>
Co-authored-by: noramullen1 <[email protected]>
Co-authored-by: Greg <[email protected]>
Co-authored-by: Daniel Moran <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Samantha Wang <[email protected]>
Co-authored-by: Joshua Powers <[email protected]>
Co-authored-by: bgilmore-iot <[email protected]>
  • Loading branch information
11 people authored Nov 8, 2021
1 parent c846398 commit 04b47d1
Show file tree
Hide file tree
Showing 630 changed files with 63,299 additions and 10,625 deletions.
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ prepend: # Prepend markdown content to an article (especially powerful with casc
append: # Append markdown content to an article (especially powerful with cascade)
block: # (Optional) Wrap content in a block style (note, warn, cloud)
content: # Content to append to article
metadata: [] # List of metadata messages to include under the page h1
updated_in: # Product and version the referenced feature was updated in (displayed as a unique metadata)
```
### Title usage
Expand Down Expand Up @@ -818,9 +820,11 @@ The following table shows which children types use which frontmatter properties:
### Inline icons
The `icon` shortcode allows you to inject icons in paragraph text.
It's meant to clarify references to specific elements in the InfluxDB user interface.
This shortcode supports clockface (the UI) v2 and v3.
Specify the version to use as the 2nd argument. The default version is `v3`.

```
{{< icon "icon-name" >}}
{{< icon "icon-name" "v2" >}}
```

Below is a list of available icons (some are aliases):
Expand Down Expand Up @@ -890,9 +894,11 @@ Below is a list of available icons (some are aliases):
### InfluxDB UI left navigation icons
In many cases, documentation references an item in the left nav of the InfluxDB UI.
Provide a visual example of the navigation item using the `nav-icon` shortcode.
This shortcode supports clockface (the UI) v2 and v3.
Specify the version to use as the 2nd argument. The default version is `v3`.

```
{{< nav-icon "tasks" >}}
{{< nav-icon "tasks" "v2" >}}
```

The following case insensitive values are supported:
Expand Down Expand Up @@ -1048,6 +1054,14 @@ This is necessary to get the first sentence/paragraph to render correctly.
{{% /cloud-only %}}
```

#### All-Caps
Clockface v3 introduces many buttons with text formatted as all-caps.
Use the `{{< caps >}}` shortcode to format text to match those buttons.

```md
Click {{< caps >}}Add Data{{< /caps >}}
```

### Reference content
The InfluxDB documentation is "task-based," meaning content primarily focuses on
what a user is **doing**, not what they are **using**.
Expand Down
132 changes: 68 additions & 64 deletions api-docs/cloud/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5886,31 +5886,37 @@ components:
type: object
securitySchemes:
BasicAuthentication:
type: http
scheme: basic
description: >
### Basic authentication scheme
Use HTTP Basic Auth with clients that support the InfluxDB 1.x
convention of username and password (that don't support the
Use the HTTP Basic authentication scheme with clients that support the
InfluxDB 1.x convention of username and password (that don't support the
`Authorization: Token` scheme):
- **username**: InfluxDB Cloud username
- **password**: InfluxDB Cloud API token
### Example
#### Example
`curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"`
--user "[email protected]":"INFLUX_API_TOKEN"`
Replace the following:
- *`[email protected]`*: the email address that you signed up
with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)
For more information and examples, see how to [authenticate with a
username and password
scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/).
username and
password](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/).
scheme: basic
type: http
QuerystringAuthentication:
type: apiKey
in: query
name: u=&p=
description: >
### Querystring authentication scheme
Expand All @@ -5926,20 +5932,30 @@ components:
- **password**: InfluxDB Cloud API token
### Example
#### Example
`curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--data-urlencode "u=YOUR_USERNAME"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"`
--data-urlencode "[email protected]"
--data-urlencode "p=INFLUX_API_TOKEN"`
Replace the following:
- *`[email protected]`*: the email address that you signed up
with
- *`INFLUX_API_TOKEN`*: your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token)
For more information and examples, see how to [authenticate with a
username and password
scheme](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/).
in: query
name: u=&p=
type: apiKey
TokenAuthentication:
type: http
scheme: token
bearerFormat: InfluxDB Token String
bearerFormat: InfluxDB token string
description: >
### Token authentication scheme
Expand All @@ -5949,20 +5965,27 @@ components:
within the organization.
Include your API token in an `Authorization: Token YOUR_API_TOKEN` HTTP
Include your API token in an `Authorization: Token INFLUX_TOKEN` HTTP
header with each request.
### Example
#### Example
`curl https://us-east-1-1.aws.cloud2.influxdata.com/
--header "Authorization: Token YOUR_API_TOKEN"`
--header "Authorization: Token INFLUX_API_TOKEN"`
Replace *`INFLUX_API_TOKEN`* with your [InfluxDB API
token](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#token).
For more information and examples, see the following:
- [`/authorizations`](#tag/Authorizations) endpoint.
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [`/authorizations`](#tag/Authorizations) endpoint.
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
scheme: token
type: http
info:
title: Influx Cloud API Service
description: >
Expand Down Expand Up @@ -12326,8 +12349,7 @@ security:
servers:
- url: /
tags:
- name: Authentication
description: >
- description: >
Use one of the following schemes to authenticate to the InfluxDB API:
- [Token authentication](#section/Authentication/TokenAuthentication)
Expand All @@ -12338,12 +12360,20 @@ tags:
authentication](#section/Authentication/QuerystringAuthentication)
<!-- ReDoc-Inject: <security-definitions> -->
name: Authentication
x-traitTag: true
- name: Authorizations
description: >
- description: >
Create and manage API tokens. An **authorization** associates a list of
permissions to an **organization** and provides a token for API access. To
assign a token to a specific user, scope the authorization to the user ID.
permissions to an **organization** and provides a token for API access.
Optionally, you can restrict an authorization and its token to a specific
user.
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/cloud/security/tokens).
- [Assign a token to a specific user](https://docs.influxdata.com/influxdb/cloud/security/tokens/create-token).
name: Authorizations
- Bucket Schemas
- Buckets
- Cells
Expand All @@ -12352,45 +12382,17 @@ tags:
- DBRPs
- Delete
- DemoDataBuckets
- name: Invocable Scripts
description: >
Manage and execute scripts as API endpoints in InfluxDB.
An API Invocable Script assigns your custom Flux script to a new InfluxDB
API endpoint for your organization.
Invocable scripts let you execute your script as an HTTP request to the
endpoint.
Invocable scripts accept parameters. Add parameter references in your
script as `params.myparameter`.
When you `invoke` your script, you send parameters as key-value pairs in
the `params` object.
InfluxDB executes your script with the key-value pairs as arguments and
returns the result.
For more information and examples, see [Invoke custom
scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts).
- Invocable Scripts
- Labels
- Limits
- NotificationEndpoints
- NotificationRules
- Organizations
- Ping
- name: Query
description: |
- description: |
Retrieve data, analyze queries, and get query suggestions.
- name: Quick start
description: Some quickness
x-traitTag: true
- name: Quick start
x-traitTag: true
description: >
name: Query
- description: >
See the [**API Quick
Start**](https://docs.influxdata.com/influxdb/cloud/api-guide/api_intro/)
to get up and running authenticating with tokens, writing to buckets, and
Expand All @@ -12401,10 +12403,10 @@ tags:
libraries**](https://docs.influxdata.com/influxdb/cloud/api-guide/client-libraries/)
are available for popular languages and ready to import into your
application.
- Resources
- name: Response codes
name: Quick start
x-traitTag: true
description: >
- Resources
- description: >
The InfluxDB API uses standard HTTP status codes for success and failure
responses.
Expand Down Expand Up @@ -12457,6 +12459,8 @@ tags:
| `503` | Service unavailable | Server is temporarily
unavailable to process the request. The `Retry-After` header describes
when to try the request again. |
name: Response codes
x-traitTag: true
- Routes
- Rules
- Secrets
Expand All @@ -12471,9 +12475,9 @@ tags:
- Users
- Variables
- Views
- name: Write
description: |
- description: |
Write time series data to buckets.
name: Write
x-tagGroups:
- name: Overview
tags:
Expand Down
5 changes: 1 addition & 4 deletions api-docs/openapi/content/cloud/tags.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
- name: Quick start
description: Some quickness
x-traitTag: true
- name: Authentication
description: |
Use one of the following schemes to authenticate to the InfluxDB API:
Expand All @@ -18,7 +15,7 @@
Invocable scripts accept parameters. Add parameter references in your script as `params.myparameter`.
When you `invoke` your script, you send parameters as key-value pairs in the `params` object.
InfluxDB executes your script with the key-value pairs as arguments and returns the result.
Then, InfluxDB executes your script with the key-value pairs as arguments, and returns the result.
For more information and examples, see [Invoke custom scripts](https://docs.influxdata.com/influxdb/cloud/api-guide/api-invocable-scripts).
- name: Quick start
Expand Down
3 changes: 3 additions & 0 deletions api-docs/openapi/content/v2.1/info.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: Influx OSS API Service
description: |
The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.
58 changes: 58 additions & 0 deletions api-docs/openapi/content/v2.1/security-schemes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
TokenAuthentication:
type: http
scheme: token
bearerFormat: InfluxDB Token String
description: |
### Token authentication scheme
InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.
Include your API token in an `Authentication: Token YOUR_API_TOKEN` HTTP header with each request.
### Example
`curl http://localhost:8086/ping
--header "Authentication: Token YOUR_API_TOKEN"`
For more information and examples, see the following:
- [Use tokens in API requests](https://docs.influxdata.com/influxdb/v2.1/api-guide/api_intro/#authentication).
- [Manage API tokens](https://docs.influxdata.com/influxdb/v2.1/security/tokens).
- [`/authorizations`](#tag/Authorizations) endpoint.
BasicAuthentication:
type: http
scheme: basic
description: |
### Basic authentication scheme
Use HTTP Basic Auth with clients that support the InfluxDB 1.x convention of username and password (that don't support the `Authorization: Token` scheme).
Username and password schemes require the following credentials:
- **username**: 1.x username (this is separate from the UI login username)
- **password**: 1.x password or InfluxDB API token
### Example
`curl --get "http://localhost:8086/query"
--user "YOUR_1.x_USERNAME":"YOUR_TOKEN_OR_PASSWORD"`
For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.1/reference/api/influxdb-1x/)
QuerystringAuthentication:
type: apiKey
in: query
name: u=&p=
description: |
### Querystring authentication scheme
Use InfluxDB 1.x API parameters to provide credentials through the query string.
Username and password schemes require the following credentials:
- **username**: 1.x username (this is separate from the UI login username)
- **password**: 1.x password or InfluxDB API token
### Example
`curl --get "http://localhost:8086/query"
--data-urlencode "u=YOUR_1.x_USERNAME"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"`
For more information and examples, see how to [authenticate with a username and password scheme](https://docs.influxdata.com/influxdb/v2.1/reference/api/influxdb-1x/)
28 changes: 28 additions & 0 deletions api-docs/openapi/content/v2.1/tag-groups.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
- name: Overview
tags:
- Quick start
- Authentication
- Response codes
- name: Data I/O endpoints
tags:
- Write
- Query
- name: Resource endpoints
tags:
- Buckets
- Dashboards
- Tasks
- Resources
- name: Security and access endpoints
tags:
- Authorizations
- Organizations
- Users
- name: System information endpoints
tags:
- Health
- Ping
- Ready
- Routes
- name: All endpoints
tags: []
Loading

0 comments on commit 04b47d1

Please sign in to comment.