From 08de17e63105949d9881dde726c51b4f48640101 Mon Sep 17 00:00:00 2001 From: DDDHuang <44492639+DDDHuang@users.noreply.github.com> Date: Thu, 24 Mar 2022 17:58:41 +0800 Subject: [PATCH] fix: api examples spec error --- apps/emqx_dashboard/src/emqx_dashboard_swagger.erl | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl b/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl index a4bbe74fa..f8fe6450c 100644 --- a/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl +++ b/apps/emqx_dashboard/src/emqx_dashboard_swagger.erl @@ -109,7 +109,10 @@ schema_with_example(Type, Example) -> -spec(schema_with_examples(hocon_schema:type(), map()) -> hocon_schema:field_schema_map()). schema_with_examples(Type, Examples) -> - hoconsc:mk(Type, #{examples => #{<<"examples">> => Examples}}). + %% Swagger can dynamically distinguish if there are multiple examples. + %% But explicitly declaring examples as plural + %% may cause some example structures to be incorrectly identified. + schema_with_example(Type, Examples). -spec(error_codes(list(atom())) -> hocon_schema:fields()). error_codes(Codes) ->