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

docs(fix): remove dynamic example paths from api docs

This commit is contained in:
Thales Macedo Garitezi 2022-10-31 14:02:33 -03:00
parent 12addc2118
commit 935513d38c
4 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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)
} }