feat: generate hotconf and bridge schema on the fly

apps/emqx/include/http_api.hrl

@@ -57,7 +57,7 @@
 -define(ERROR_CODES, [
     {?BAD_USERNAME_OR_PWD, <<"Bad username or password">>},
     {?BAD_API_KEY_OR_SECRET, <<"Bad API key or secret">>},
-    {'BAD_REQUEST', <<"Request parameters are not legal">>},
+    {'BAD_REQUEST', <<"Request parameters are not valid">>},
     {'NOT_MATCH', <<"Conditions are not matched">>},
     {'ALREADY_EXISTS', <<"Resource already existed">>},
     {'BAD_CONFIG_SCHEMA', <<"Configuration data is not legal">>},

apps/emqx_dashboard/src/emqx_dashboard_api.erl

@@ -18,7 +18,6 @@
 
 -behaviour(minirest_api).
 
--include("emqx_dashboard.hrl").
 -include_lib("hocon/include/hoconsc.hrl").
 -include_lib("emqx/include/logger.hrl").
 -include_lib("typerefl/include/types.hrl").

apps/emqx_dashboard/src/emqx_dashboard_schema_api.erl

@@ -0,0 +1,84 @@
+%%--------------------------------------------------------------------
+%% Copyright (c) 2023 EMQ Technologies Co., Ltd. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%--------------------------------------------------------------------
+
+%% This module is for dashboard to retrieve the schema hot config and bridges.
+-module(emqx_dashboard_schema_api).
+
+-behaviour(minirest_api).
+
+-include_lib("hocon/include/hoconsc.hrl").
+
+%% minirest API
+-export([api_spec/0, paths/0, schema/1]).
+
+-export([get_schema/2]).
+
+-define(TAGS, [<<"dashboard">>]).
+-define(BAD_REQUEST, 'BAD_REQUEST').
+
+%%--------------------------------------------------------------------
+%% minirest API and schema
+%%--------------------------------------------------------------------
+
+api_spec() ->
+    emqx_dashboard_swagger:spec(?MODULE, #{check_schema => true}).
+
+paths() ->
+    ["/schemas/:name"].
+
+%% This is a rather hidden API, so we don't need to add translations for the description.
+schema("/schemas/:name") ->
+    #{
+        'operationId' => get_schema,
+        get => #{
+            parameters => [
+                {name, hoconsc:mk(hoconsc:enum([hotconf, bridges]), #{in => path})},
+                {lang,
+                    hoconsc:mk(typerefl:string(), #{
+                        in => query,
+                        default => <<"en">>,
+                        desc => <<"The language of the schema.">>
+                    })}
+            ],
+            desc => <<
+                "Get the schema JSON of the specified name. "
+                "NOTE: you should never need to make use of this API "
+                "unless you are building a multi-lang dashboaard."
+            >>,
+            tags => ?TAGS,
+            security => [],
+            responses => #{
+                200 => hoconsc:mk(binary(), #{desc => <<"The JSON schema of the specified name.">>})
+            }
+        }
+    }.
+
+%%--------------------------------------------------------------------
+%% API Handler funcs
+%%--------------------------------------------------------------------
+
+get_schema(get, #{
+    bindings := #{name := Name},
+    query_string := #{<<"lang">> := Lang}
+}) ->
+    {200, gen_schema(Name, iolist_to_binary(Lang))};
+get_schema(get, _) ->
+    {400, ?BAD_REQUEST, <<"unknown">>}.
+
+gen_schema(hotconf, Lang) ->
+    emqx_conf:hotconf_schema_json(Lang);
+gen_schema(bridges, Lang) ->
+    emqx_conf:bridge_schema_json(Lang).

apps/emqx_dashboard/src/emqx_dashboard_swagger.erl

@@ -85,7 +85,7 @@
     check_schema => boolean() | filter(),
     translate_body => boolean(),
     schema_converter => fun((hocon_schema:schema(), Module :: atom()) -> map()),
-    i18n_lang => atom()
+    i18n_lang => atom() | string() | binary()
 }.
 
 -type route_path() :: string() | binary().
@@ -238,8 +238,12 @@ parse_spec_ref(Module, Path, Options) ->
             erlang:apply(Module, schema, [Path])
             %% better error message
         catch
-            error:Reason ->
+            error:Reason:Stacktrace ->
-                throw({error, #{mfa => {Module, schema, [Path]}, reason => Reason}})
+                erlang:raise(
+                    error,
+                    #{mfa => {Module, schema, [Path]}, reason => Reason},
+                    Stacktrace
+                )
         end,
     {Specs, Refs} = maps:fold(
         fun(Method, Meta, {Acc, RefsAcc}) ->