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

Merge pull request #11210 from sstrigler/EMQX-9569-provide-the-ce-ee-version-info-and-the-current-version-number-in-the-info-field 

feat(emqx_dashboard): include edition and version in swagger.json info
This commit is contained in:
Stefan Strigler 2023-07-07 11:55:44 +02:00 committed by GitHub
parent 88fd8d0582 8faaa86c07
commit 055a1e8d75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
apps/emqx_dashboard/src/emqx_dashboard.erl
View File

@ -49,7 +49,7 @@ start_listeners(Listeners) ->
Authorization = {?MODULE, authorize}, Authorization = {?MODULE, authorize},
GlobalSpec = #{ GlobalSpec = #{
openapi => "3.0.0", openapi => "3.0.0",
info => #{title => "EMQX API", version => ?EMQX_API_VERSION}, info => #{title => emqx_api_name(), version => emqx_release_version()},
servers => [#{url => emqx_dashboard_swagger:base_path()}], servers => [#{url => emqx_dashboard_swagger:base_path()}],
components => #{ components => #{
schemas => #{}, schemas => #{},
@ -271,3 +271,9 @@ dynamic_dispatch() ->
{emqx_mgmt_api_status:path(), emqx_mgmt_api_status, []}, {emqx_mgmt_api_status:path(), emqx_mgmt_api_status, []},
{'_', emqx_dashboard_not_found, []} {'_', emqx_dashboard_not_found, []}
]. ].
emqx_api_name() ->
emqx_release:description() ++ " API".
emqx_release_version() ->
emqx_release:version().

9
apps/emqx_dashboard/test/emqx_dashboard_SUITE.erl
View File

@ -149,6 +149,15 @@ t_swagger_json(_Config) ->
{ok, {{"HTTP/1.1", 200, "OK"}, _Headers, Body2}} = {ok, {{"HTTP/1.1", 200, "OK"}, _Headers, Body2}} =
httpc:request(get, {Url, []}, [], [{body_format, binary}]), httpc:request(get, {Url, []}, [], [{body_format, binary}]),
?assertEqual(Body1, Body2), ?assertEqual(Body1, Body2),
?assertMatch(
#{
<<"info">> := #{
<<"title">> := _,
<<"version">> := _
}
},
emqx_utils_json:decode(Body1)
),
ok. ok.
t_cli(_Config) -> t_cli(_Config) ->