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(api-docs): add file-transfer config to hot-config scope #11731

Merged
merged 3 commits into from Oct 17, 2023

Conversation

zmstone
Copy link
Member

@zmstone zmstone commented Oct 9, 2023

Fixes EMQX-11108

Summary

馃 Generated by Copilot at c89c079

Added support for file transfer configuration in the enterprise edition and updated the emqx_management version number.

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
  • Added property-based tests for code which performs user input validation
  • 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
  • Created PR to emqx-docs if documentation update is required, or link to a follow-up jira ticket
  • 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

@zmstone zmstone requested review from lafirest, sstrigler and a team as code owners October 9, 2023 07:59
@zmstone zmstone requested a review from a team October 9, 2023 08:24
@@ -38,12 +38,21 @@
-define(OPTS, #{rawconf_with_defaults => true, override_to => cluster}).
-define(TAGS, ["Configs"]).

-if(?EMQX_RELEASE_EDITION == ee).
-define(ROOT_KEYS_EE, [
<<"file_transfer">>
Copy link
Contributor

Choose a reason for hiding this comment

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

File Transfer has its own configuration update mechanism nowadays, will this change provide essentially the same thing? Or is this exactly the goal here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you for the tip. Will check with frontend team to see if it's good to take swagger spec for reference.

Copy link
Member Author

Choose a reason for hiding this comment

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

The hotconf schema json is used by the dashboard to render UI.

@zmstone zmstone force-pushed the 1008-expose-file-transfer-host-conf branch 3 times, most recently from 11e5980 to 395f697 Compare October 9, 2023 12:14
@zmstone zmstone force-pushed the 1008-expose-file-transfer-host-conf branch from 395f697 to 2626d79 Compare October 10, 2023 08:24
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 6466657156

  • 4 of 5 (80.0%) changed or added relevant lines in 1 file are covered.
  • 27 unchanged lines in 8 files lost coverage.
  • Overall coverage decreased (-0.02%) to 82.767%

Changes Missing Coverage Covered Lines Changed/Added Lines %
apps/emqx_conf/src/emqx_conf.erl 4 5 80.0%
Files with Coverage Reduction New Missed Lines %
apps/emqx_bridge_gcp_pubsub/src/emqx_bridge_gcp_pubsub_impl_consumer.erl 1 90.24%
apps/emqx_bridge_http/src/emqx_bridge_http_connector.erl 1 71.67%
apps/emqx/src/emqx_broker.erl 1 88.52%
apps/emqx_gateway/src/emqx_gateway_insta_sup.erl 2 67.32%
apps/emqx_gateway_mqttsn/src/emqx_mqttsn_frame.erl 3 64.04%
apps/emqx_gateway_exproto/src/emqx_gateway_exproto.erl 4 80.85%
apps/emqx_resource/src/emqx_resource_buffer_worker.erl 4 93.54%
apps/emqx/src/emqx_reason_codes.erl 11 90.44%
Totals Coverage Status
Change from base Build 6460072548: -0.02%
Covered Lines: 33966
Relevant Lines: 41038

馃挍 - Coveralls

@zmstone zmstone merged commit 55618dd into emqx:master Oct 17, 2023
140 checks passed
@zmstone zmstone deleted the 1008-expose-file-transfer-host-conf branch October 17, 2023 09:23
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

4 participants