-
Notifications
You must be signed in to change notification settings - Fork 311
docs(api): adding api examples to DVC and LVC #6277
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
base: master
Are you sure you want to change the base?
docs(api): adding api examples to DVC and LVC #6277
Conversation
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.
Pull Request Overview
This PR adds comprehensive HTTP API documentation for both Last Value Cache (LVC) and Distinct Value Cache (DVC) operations in InfluxDB 3. The changes provide API alternatives to CLI commands, enabling users to manage caches via REST endpoints.
Key changes:
- Added HTTP API examples for creating, deleting, and querying caches
- Documented API parameter differences from CLI (JSON arrays vs comma-delimited, seconds vs humantime)
- Included response codes and example requests/responses for better usability
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
content/shared/influxdb3-admin/last-value-cache/create.md |
Added POST API endpoint documentation with JSON payload examples |
content/shared/influxdb3-admin/last-value-cache/delete.md |
Added DELETE API endpoint with query parameters and response codes |
content/shared/influxdb3-admin/last-value-cache/show.md |
Added SQL query API examples for viewing cache information |
content/shared/influxdb3-admin/distinct-value-cache/create.md |
Added POST API endpoint for DVC creation with parameter format notes |
content/shared/influxdb3-admin/distinct-value-cache/show.md |
Added SQL query API examples (incorrectly references last_caches table) |
content/shared/influxdb3-admin/distinct-value-cache/query.md |
Added API examples for querying cached data using last_cache function |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
Overall, this is really good. I added in the endpoint shortcodes, which include reference links.
We need to add paragraphs to introduce the CLI and API, and then update the frontmatter descriptions with them as well.
Thanks for picking this up!
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
@jstirnaman do you think we should "add paragraphs to introduce the CLI and API, and then update the frontmatter descriptions with them as well." under this PR or create a new issue for it? |
Closes #5974