diff --git a/apps/emqx_management/src/emqx_mgmt_api_trace.erl b/apps/emqx_management/src/emqx_mgmt_api_trace.erl index 587257688..93d647753 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_trace.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_trace.erl @@ -72,7 +72,7 @@ schema("/trace") -> description => "List all trace", tags => ?TAGS, responses => #{ - 200 => hoconsc:ref(trace) + 200 => hoconsc:array(hoconsc:ref(trace)) } }, post => #{ @@ -140,7 +140,8 @@ schema("/trace/:name/download") -> 'application/octet-stream' => #{schema => #{type => "string", format => "binary"}} } - } + }, + 404 => emqx_dashboard_swagger:error_codes(['NOT_FOUND'], <<"Trace Name Not Found">>) } } }; @@ -172,9 +173,12 @@ schema("/trace/:name/log") -> responses => #{ 200 => [ - {items, hoconsc:mk(binary(), #{example => "TEXT-LOG-ITEMS"})} - | fields(bytes) ++ fields(position) - ] + {items, hoconsc:mk(binary(), #{example => "TEXT-LOG-ITEMS"})}, + {meta, fields(bytes) ++ fields(position)} + ], + 400 => emqx_dashboard_swagger:error_codes( + ['READ_FILE_ERROR', 'RPC_ERROR', 'NODE_ERROR'], <<"Trace Log Failed">> + ) } } }. diff --git a/changes/v5.0.12-en.md b/changes/v5.0.12-en.md index 076ec6e69..731719c7d 100644 --- a/changes/v5.0.12-en.md +++ b/changes/v5.0.12-en.md @@ -19,3 +19,5 @@ ## Bug fixes - Fix that the obsolete SSL files aren't deleted after the ExHook config update [#9432](https://github.com/emqx/emqx/pull/9432). + +- Fix doc and schema for `/trace` API [#9468](https://github.com/emqx/emqx/pull/9468). diff --git a/changes/v5.0.12-zh.md b/changes/v5.0.12-zh.md index 3f4c52b75..e7cbd124c 100644 --- a/changes/v5.0.12-zh.md +++ b/changes/v5.0.12-zh.md @@ -18,3 +18,5 @@ ## 修复 - 修复 ExHook 更新 SSL 相关配置后,过时的 SSL 文件没有被删除的问题 [#9432](https://github.com/emqx/emqx/pull/9432)。 + +- 修复 /trace API 的返回值格式和相关文档 [#9468](https://github.com/emqx/emqx/pull/9468)。