From 474aef632f7a8d89f1c7463737ca7633613b60db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9F=90=E6=96=87?= Date: Mon, 22 May 2023 21:58:35 +0800 Subject: [PATCH 1/2] feat: raise error for bad description --- src/minirest_trails.erl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/minirest_trails.erl b/src/minirest_trails.erl index ff9bc2d..7ad256f 100644 --- a/src/minirest_trails.erl +++ b/src/minirest_trails.erl @@ -143,6 +143,11 @@ generate_api_(Default, {Path, MetaData, Function, Options}) -> end, {Path, maps:fold(MergeDefFun, #{}, MetaData), Function, Options}. +%% description must be a string(list or binary) +%% otherwise, raise minirest_description_not_format error. +%% for example: can't find description in i18n file. +decs_str_to_binary(#{description := Desc}) when is_tuple(Desc) -> + erlang:error({minirest_description_not_format, Desc}); decs_str_to_binary(Data = #{description := Desc}) when is_list(Desc) -> decs_str_to_binary(Data#{description => list_to_binary(Desc)}); decs_str_to_binary(Data) when is_map(Data) -> From 1c085c06b9383c8fa9e689d0a5814fda7db16d62 Mon Sep 17 00:00:00 2001 From: zhongwencool Date: Tue, 23 May 2023 07:25:51 +0800 Subject: [PATCH 2/2] chore: update src/minirest_trails.erl Co-authored-by: Zaiming (Stone) Shi --- src/minirest_trails.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/minirest_trails.erl b/src/minirest_trails.erl index 7ad256f..5e54e1c 100644 --- a/src/minirest_trails.erl +++ b/src/minirest_trails.erl @@ -147,7 +147,7 @@ generate_api_(Default, {Path, MetaData, Function, Options}) -> %% otherwise, raise minirest_description_not_format error. %% for example: can't find description in i18n file. decs_str_to_binary(#{description := Desc}) when is_tuple(Desc) -> - erlang:error({minirest_description_not_format, Desc}); + erlang:error({minirest_description_not_formatted, Desc}); decs_str_to_binary(Data = #{description := Desc}) when is_list(Desc) -> decs_str_to_binary(Data#{description => list_to_binary(Desc)}); decs_str_to_binary(Data) when is_map(Data) ->