docs: make sure there is a summary for all API endpoints #10724
Merged
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.
Many HTTP API endpoints did not have a summary when looking at the API docs at "http://emqx_host_name:18083/api-docs". This has been fixed by making sure there is a summary corresponding to all endpoints.
Many of the labels might not be perfect yet but I think this can be improved gradually once we have the infrastructure provided by this PR.
Fixes:
https://emqx.atlassian.net/browse/EMQX-9767
Summary
馃 Generated by Copilot at 09ddec7
The pull request improves the API documentation, validation, and localization of several emqx apps by using hocon schemas and macros. It also updates the version numbers of the emqx_dashboard, emqx_management, and emqx_prometheus apps and adds labels for some API operations. The affected files are mostly in the
apps
andrel/i18n
directories.PR Checklist
Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked:
changes/{ce,ee}/(feat|perf|fix)-<PR-id>.en.md
files