-
Notifications
You must be signed in to change notification settings - Fork 39
Enhance 'path' property description and requirements #2394
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
Conversation
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
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 updates the documentation for the path property in routes[] configuration for data source plugins to clarify that it cannot be an empty string and marks it as required.
Changes:
- Updated the
pathproperty description to include a warning that it cannot be an empty string - Marked the
pathproperty as required in the routes configuration table
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hugohaggmark
left a comment
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.
Hi @s4kh , this file is autogenerated from https://github.com/grafana/grafana/blob/main/docs/sources/developers/plugins/plugin.schema.json so you need to add the comment there first and then run npm -w website run prebuild in the root of this branch and it should update this file automatically
|
Opened this PR so this shouldn't happen again: #2396 |
|
@hugohaggmark ran |
|
No changes you can close this PR @s4kh 🙌 |
What this PR does / why we need it:
plugin.json
routes[].pathshould be defined, otherwise it won't be proxied. Updated the description for the 'path' property to include a warning about empty strings and marked it as required.Which issue(s) this PR fixes:
Fixes https://github.com/grafana/grafana-community-team/issues/715
Special notes for your reviewer: