yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #9278 from thalesmg/fix-ex-doc-filepaths-50 

docs(fix): remove dynamic paths from example API values
This commit is contained in:
Thales Macedo Garitezi 2022-11-01 10:02:19 -03:00 committed by GitHub
parent 12addc2118 198ddda8bc
commit f802766e87
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 28 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_exhook/src/emqx_exhook.app.src
View File

@ -1,7 +1,7 @@
%% -*- mode: erlang -*- %% -*- mode: erlang -*-
{application, emqx_exhook, [ {application, emqx_exhook, [
{description, "EMQX Extension for Hook"}, {description, "EMQX Extension for Hook"},
{vsn, "5.0.5"}, {vsn, "5.0.6"},
{modules, []}, {modules, []},
{registered, []}, {registered, []},
{mod, {emqx_exhook_app, []}}, {mod, {emqx_exhook_app, []}},

6
apps/emqx_exhook/src/emqx_exhook_api.erl
View File

@ -219,9 +219,9 @@ params_server_name_in_path() ->
server_conf_schema() -> server_conf_schema() ->
SSL = #{ SSL = #{
enable => false, enable => false,
cacertfile => emqx:cert_file(<<"cacert.pem">>), cacertfile => <<"/etc/emqx/certs/cacert.pem">>,
certfile => emqx:cert_file(<<"cert.pem">>), certfile => <<"/etc/emqx/certs/cert.pem">>,
keyfile => emqx:cert_file(<<"key.pem">>) keyfile => <<"/etc/emqx/certs/key.pem">>
}, },
schema_with_example( schema_with_example(
ref(server_config), ref(server_config),

4
apps/emqx_gateway/src/emqx_gateway_api.erl
View File

@ -686,7 +686,7 @@ examples_gateway_confs() ->
enable_stats => true, enable_stats => true,
idle_timeout => <<"30s">>, idle_timeout => <<"30s">>,
mountpoint => <<"lwm2m/">>, mountpoint => <<"lwm2m/">>,
xml_dir => emqx:etc_file(<<"lwm2m_xml">>), xml_dir => <<"/etc/emqx/lwm2m_xml">>,
lifetime_min => <<"1s">>, lifetime_min => <<"1s">>,
lifetime_max => <<"86400s">>, lifetime_max => <<"86400s">>,
qmode_time_window => <<"22s">>, qmode_time_window => <<"22s">>,
@ -805,7 +805,7 @@ examples_update_gateway_confs() ->
enable_stats => true, enable_stats => true,
idle_timeout => <<"30s">>, idle_timeout => <<"30s">>,
mountpoint => <<"lwm2m2/">>, mountpoint => <<"lwm2m2/">>,
xml_dir => emqx:etc_file(<<"lwm2m_xml">>), xml_dir => <<"/etc/emqx/lwm2m_xml">>,
lifetime_min => <<"1s">>, lifetime_min => <<"1s">>,
lifetime_max => <<"86400s">>, lifetime_max => <<"86400s">>,
qmode_time_window => <<"22s">>, qmode_time_window => <<"22s">>,

18
apps/emqx_gateway/src/emqx_gateway_api_listeners.erl
View File

@ -756,9 +756,9 @@ examples_listener() ->
<<"tlsv1.1">>, <<"tlsv1.1">>,
<<"tlsv1">> <<"tlsv1">>
], ],
cacertfile => emqx:cert_file(<<"cacert.pem">>), cacertfile => <<"/etc/emqx/certs/cacert.pem">>,
certfile => emqx:cert_file(<<"cert.pem">>), certfile => <<"/etc/emqx/certs/cert.pem">>,
keyfile => emqx:cert_file(<<"key.pem">>), keyfile => <<"/etc/emqx/certs/key.pem">>,
verify => <<"verify_none">>, verify => <<"verify_none">>,
fail_if_no_peer_cert => false fail_if_no_peer_cert => false
}, },
@ -802,9 +802,9 @@ examples_listener() ->
dtls_options => dtls_options =>
#{ #{
versions => [<<"dtlsv1.2">>, <<"dtlsv1">>], versions => [<<"dtlsv1.2">>, <<"dtlsv1">>],
cacertfile => emqx:cert_file(<<"cacert.pem">>), cacertfile => <<"/etc/emqx/certs/cacert.pem">>,
certfile => emqx:cert_file(<<"cert.pem">>), certfile => <<"/etc/emqx/certs/cert.pem">>,
keyfile => emqx:cert_file(<<"key.pem">>), keyfile => <<"/etc/emqx/certs/key.pem">>,
verify => <<"verify_none">>, verify => <<"verify_none">>,
fail_if_no_peer_cert => false fail_if_no_peer_cert => false
}, },
@ -829,9 +829,9 @@ examples_listener() ->
dtls_options => dtls_options =>
#{ #{
versions => [<<"dtlsv1.2">>, <<"dtlsv1">>], versions => [<<"dtlsv1.2">>, <<"dtlsv1">>],
cacertfile => emqx:cert_file(<<"cacert.pem">>), cacertfile => <<"/etc/emqx/certs/cacert.pem">>,
certfile => emqx:cert_file(<<"cert.pem">>), certfile => <<"/etc/emqx/certs/cert.pem">>,
keyfile => emqx:cert_file(<<"key.pem">>), keyfile => <<"/etc/emqx/certs/key.pem">>,
verify => <<"verify_none">>, verify => <<"verify_none">>,
user_lookup_fun => <<"emqx_tls_psk:lookup">>, user_lookup_fun => <<"emqx_tls_psk:lookup">>,
ciphers => ciphers =>

7
apps/emqx_gateway/src/emqx_gateway_schema.erl
View File

@ -250,7 +250,12 @@ fields(lwm2m) ->
sc( sc(
binary(), binary(),
#{ #{
default => emqx:etc_file("lwm2m_xml"), %% since this is not packaged with emqx, nor
%% present in the packages, we must let the user
%% specify it rather than creating a dynamic
%% default (especially difficult to handle when
%% generating docs).
example => <<"/etc/emqx/lwm2m_xml">>,
required => true, required => true,
desc => ?DESC(lwm2m_xml_dir) desc => ?DESC(lwm2m_xml_dir)
} }

8
apps/emqx_management/i18n/emqx_mgmt_api_status_i18n.conf
View File

@ -8,13 +8,19 @@ emqx_mgmt_api_status {
"Returns status code 200 if the EMQX application is up and running, " "Returns status code 200 if the EMQX application is up and running, "
"503 otherwise." "503 otherwise."
"\n" "\n"
"This API was introduced in v5.0.10."
"\n"
"The GET `/status` endpoint (without the `/api/...` prefix) is also an alias" "The GET `/status` endpoint (without the `/api/...` prefix) is also an alias"
" to this endpoint and works in the same way." " to this endpoint and works in the same way. This alias has been available since"
" v5.0.0."
zh: "作为节点的健康检查。 返回一个纯文本的响应，描述节点的状态。\n" zh: "作为节点的健康检查。 返回一个纯文本的响应，描述节点的状态。\n"
"\n" "\n"
"如果 EMQX 应用程序已经启动并运行，返回状态代码 200，否则返回 503。\n" "如果 EMQX 应用程序已经启动并运行，返回状态代码 200，否则返回 503。\n"
"\n" "\n"
"这个API是在v5.0.10中引入的。"
"\n"
"GET `/status`端点（没有`/api/...`前缀）也是这个端点的一个别名，工作方式相同。" "GET `/status`端点（没有`/api/...`前缀）也是这个端点的一个别名，工作方式相同。"
" 这个别名从v5.0.0开始就有了。"
} }
} }