From 7e494afd9814cf05f9bf85ea3a5a440f35c443be Mon Sep 17 00:00:00 2001 From: zhongwencool Date: Fri, 24 Sep 2021 15:55:49 +0800 Subject: [PATCH] fix(swagger): desc must be binary --- apps/emqx_dashboard/src/emqx_swagger.erl | 15 +++++++++++++++ .../test/emqx_swagger_requestBody_SUITE.erl | 4 ++-- .../test/emqx_swagger_response_SUITE.erl | 2 +- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/apps/emqx_dashboard/src/emqx_swagger.erl b/apps/emqx_dashboard/src/emqx_swagger.erl index ad223c7d4..6ff430410 100644 --- a/apps/emqx_dashboard/src/emqx_swagger.erl +++ b/apps/emqx_dashboard/src/emqx_swagger.erl @@ -1,3 +1,18 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2020-2021 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. +%%-------------------------------------------------------------------- -module(emqx_swagger). -include_lib("typerefl/include/types.hrl"). diff --git a/apps/emqx_dashboard/test/emqx_swagger_requestBody_SUITE.erl b/apps/emqx_dashboard/test/emqx_swagger_requestBody_SUITE.erl index 49dca926f..84cbfe5fb 100644 --- a/apps/emqx_dashboard/test/emqx_swagger_requestBody_SUITE.erl +++ b/apps/emqx_dashboard/test/emqx_swagger_requestBody_SUITE.erl @@ -101,7 +101,7 @@ t_remote_ref(_Config) -> {<<"another_ref">>, #{<<"$ref">> => <<"#/components/schemas/emqx_swagger_remote_schema.ref3">>}}], <<"type">> => object}}, #{<<"emqx_swagger_remote_schema.ref3">> => #{<<"properties">> => [ {<<"ip">>, #{description => <<"IP:Port">>, example => <<"127.0.0.1:80">>,type => string}}, - {<<"version">>, #{description => "a good version", example => <<"1.0.0">>,type => string}}], + {<<"version">>, #{description => <<"a good version">>, example => <<"1.0.0">>,type => string}}], <<"type">> => object}}], ?assertEqual(ExpectComponents, Components), ok. @@ -116,7 +116,7 @@ t_nest_ref(_Config) -> ExpectComponents = lists:sort([ #{<<"emqx_swagger_requestBody_SUITE.nest_ref">> => #{<<"properties">> => [ {<<"env">>, #{enum => [test,dev,prod],type => string}}, - {<<"another_ref">>, #{description => "nest ref", <<"$ref">> => <<"#/components/schemas/emqx_swagger_requestBody_SUITE.good_ref">>}}], + {<<"another_ref">>, #{description => <<"nest ref">>, <<"$ref">> => <<"#/components/schemas/emqx_swagger_requestBody_SUITE.good_ref">>}}], <<"type">> => object}}, #{<<"emqx_swagger_requestBody_SUITE.good_ref">> => #{<<"properties">> => [ {<<"webhook-host">>, #{default => <<"127.0.0.1:80">>, example => <<"127.0.0.1:80">>,type => string}}, diff --git a/apps/emqx_dashboard/test/emqx_swagger_response_SUITE.erl b/apps/emqx_dashboard/test/emqx_swagger_response_SUITE.erl index c2140d2c0..569d717ee 100644 --- a/apps/emqx_dashboard/test/emqx_swagger_response_SUITE.erl +++ b/apps/emqx_dashboard/test/emqx_swagger_response_SUITE.erl @@ -175,7 +175,7 @@ t_hocon_schema_function(_Config) -> #{<<"emqx_swagger_remote_schema.ref3">> => #{<<"type">> => object, <<"properties">> => [ {<<"ip">>, #{description => <<"IP:Port">>, example => <<"127.0.0.1:80">>,type => string}}, - {<<"version">>, #{description => "a good version", example => <<"1.0.0">>, type => string}}] + {<<"version">>, #{description => <<"a good version">>, example => <<"1.0.0">>, type => string}}] }}, #{<<"emqx_swagger_remote_schema.root">> => #{required => [<<"default_password">>, <<"default_username">>], <<"properties">> => [{<<"listeners">>, #{items =>