Dashboard new endpoints documentation#1
Draft
raznar wants to merge 1 commit intobest_practices_demofrom
Draft
Conversation
Add comprehensive documentation for the following dashboard API endpoints: - Dashboard Permissions (GET/POST /api/dashboards/uid/:uid/permissions) - Dashboard Versions (GET versions list and specific version) - Restore Dashboard Version (POST /api/dashboards/uid/:uid/restore) - Import Dashboard (POST /api/dashboards/import) - Public Dashboards (GET/POST/PATCH/DELETE) - Dashboard Snapshots (create, get, delete, search, sharing options) Documentation includes: - Request/response examples - Authentication requirements - Required permissions with scopes - Error codes and status messages - JSON body schema descriptions Co-authored-by: ryan <ryan@aznar.io>
|
Cursor Agent can help with this pull request. Just |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What is this feature?
This PR adds comprehensive documentation for several existing but previously undocumented Dashboard HTTP API endpoints in
dashboard.md.Why do we need this feature?
To provide complete and accurate API documentation for developers and users who interact with Grafana's dashboard features programmatically, improving usability and reducing the learning curve.
Who is this feature for?
Developers, integrators, and advanced users who manage dashboards, permissions, versions, public sharing, and snapshots via the Grafana HTTP API.
Which issue(s) does this PR fix?:
Fixes #
Special notes for your reviewer:
Please check that:
This PR documents the following API endpoint categories:
Each endpoint includes request/response examples, authentication requirements, and error codes, following existing documentation patterns.