-
Notifications
You must be signed in to change notification settings - Fork 320
Update API reference documentation #5819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
176da8e
Update API reference documentation
peterbarnett03 1c36b19
Merge branch 'master' into pbarnett/api-ref-update
jstirnaman e15120c
feat(v3): WIP: Revise API specs for Core and Enterprise
jstirnaman 8a88b57
Update api-docs/influxdb3/core/v3/ref.yml
jstirnaman 3edfe2b
Update api-docs/influxdb3/core/v3/ref.yml
jstirnaman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| title: InfluxDB 3 Core API Service | ||
| x-influxdata-short-title: InfluxDB 3 API | ||
| summary: The InfluxDB HTTP API for InfluxDB 3 Core provides a programmatic interface for writing data stored in an InfluxDB 3 Core database. | ||
| description: | | ||
| Write and query data, and perform administrative tasks, such as managing databases and processing engine plugins. | ||
|
|
||
| The InfluxDB HTTP API for InfluxDB 3 Core includes endpoints for compatibility with InfluxDB 2.x and InfluxDB 1.x APIs. | ||
|
|
||
| <!-- TODO: verify where to host the spec that users can download. | ||
| This documentation is generated from the | ||
| [InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/ref/cloud.yml). | ||
| --> | ||
| license: | ||
| name: MIT | ||
| url: 'https://opensource.org/licenses/MIT' | ||
| contact: | ||
| name: InfluxData | ||
| url: https://www.influxdata.com | ||
| email: [email protected] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| - url: https://{baseurl} | ||
| description: InfluxDB 3 Core API URL | ||
| variables: | ||
| baseurl: | ||
| enum: | ||
| - 'localhost:8080' | ||
| default: 'localhost:8080' | ||
| description: InfluxDB 3 Core URL |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| - name: Using the InfluxDB HTTP API | ||
| tags: | ||
| - Quick start | ||
| - Authentication | ||
| - Headers | ||
| - Pagination | ||
| - Response codes | ||
| - System information endpoints | ||
| - name: All endpoints | ||
| tags: | ||
| - Ping | ||
| - Query | ||
| - Write | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops.
@jstirnaman TODO: update or remove these.