Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make sure there is a summary for all API endpoints #10724

Conversation

kjellwinblad
Copy link
Contributor

@kjellwinblad kjellwinblad commented May 16, 2023

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 and rel/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:

  • [] Added tests for the changes
  • [] Changed lines covered in coverage report
  • Change log has been added to changes/{ce,ee}/(feat|perf|fix)-<PR-id>.en.md files
  • For internal contributor: there is a jira ticket to track this change
  • [] If there should be document changes, a PR to emqx-docs.git is sent, or a jira ticket is created to follow up
  • Schema changes are backward compatible

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.

Fixes:
https://emqx.atlassian.net/browse/EMQX-9767
@kjellwinblad kjellwinblad force-pushed the kjell/docs/missing_http_api_endpoint_descriptions/EMQX-9767 branch from f075e5b to ab8b8cc Compare May 17, 2023 07:59
Copy link
Member

@zhongwencool zhongwencool left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kjellwinblad kjellwinblad merged commit 28dda39 into emqx:release-50 May 19, 2023
138 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants