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

fix: redact the password to ****** in API examples #10323

Merged
merged 3 commits into from Apr 4, 2023

Conversation

lafirest
Copy link
Member

@lafirest lafirest commented Apr 4, 2023

fix #10222

Fixes

Summary

馃 Generated by Copilot at 11b3264

Mask password values in example request bodies for various bridge and authentication APIs. This improves the security and documentation quality of the code. The changes affect files in apps/emqx_authn, apps/emqx_bridge, and lib-ee/emqx_ee_bridge.

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

Checklist for CI (.github/workflows) changes

  • If changed package build workflow, pass this action (manual trigger)
  • Change log has been added to changes/ dir for user-facing artifacts update

@lafirest lafirest marked this pull request as ready for review April 4, 2023 08:52
@lafirest lafirest requested review from a team, JimMoen and savonarola as code owners April 4, 2023 08:52
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 4605671728

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 30 unchanged lines in 9 files lost coverage.
  • Overall coverage increased (+0.02%) to 81.072%

Files with Coverage Reduction New Missed Lines %
apps/emqx_bridge/src/emqx_bridge.erl 1 91.2%
apps/emqx_dashboard/src/emqx_dashboard_monitor.erl 1 65.28%
apps/emqx_gateway/src/mqttsn/emqx_sn_channel.erl 1 73.13%
apps/emqx_machine/src/emqx_machine.erl 1 77.42%
apps/emqx_resource/src/emqx_resource_buffer_worker_sup.erl 2 86.96%
apps/emqx/src/emqx_logger_textfmt.erl 2 56.82%
apps/emqx/src/emqx_metrics_worker.erl 2 91.01%
apps/emqx_resource/src/emqx_resource_manager.erl 5 88.94%
apps/emqx/src/emqx_reason_codes.erl 15 86.76%
Totals Coverage Status
Change from base Build 4603373034: 0.02%
Covered Lines: 25061
Relevant Lines: 30912

馃挍 - Coveralls

@zmstone zmstone merged commit bffe2c5 into emqx:master Apr 4, 2023
101 checks passed
@lafirest lafirest deleted the fix/redact_pass_in_example branch April 6, 2023 02:48
@thalesmg thalesmg mentioned this pull request Apr 26, 2023
6 tasks
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.

api-doc examples should provide password as ******
4 participants