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

Merge pull request #11493 from kjellwinblad/kjell/fix/11488 

fix: HTTP API /api/v5/publish schema
This commit is contained in:
Kjell Winblad 2023-08-24 17:46:29 +02:00 committed by GitHub
parent 467f60805f 19acd82436
commit aad9b1c27d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
apps/emqx_management/src/emqx_mgmt_api_publish.erl
View File

@ -57,7 +57,7 @@ schema("/publish") ->
responses => #{ responses => #{
?ALL_IS_WELL => hoconsc:mk(hoconsc:ref(?MODULE, publish_ok)), ?ALL_IS_WELL => hoconsc:mk(hoconsc:ref(?MODULE, publish_ok)),
?PARTIALLY_OK => hoconsc:mk(hoconsc:ref(?MODULE, publish_error)), ?PARTIALLY_OK => hoconsc:mk(hoconsc:ref(?MODULE, publish_error)),
?BAD_REQUEST => bad_request_schema(), ?BAD_REQUEST => hoconsc:mk(hoconsc:ref(?MODULE, bad_request)),
?DISPATCH_ERROR => hoconsc:mk(hoconsc:ref(?MODULE, publish_error)) ?DISPATCH_ERROR => hoconsc:mk(hoconsc:ref(?MODULE, publish_error))
} }
} }
@ -196,11 +196,13 @@ fields(bad_request) ->
[ [
{code, {code,
hoconsc:mk(string(), #{ hoconsc:mk(string(), #{
desc => <<"BAD_REQUEST">> desc => <<"BAD_REQUEST">>,
example => ?RC_TOPIC_NAME_INVALID
})}, })},
{message, {message,
hoconsc:mk(binary(), #{ hoconsc:mk(binary(), #{
desc => ?DESC(error_message) desc => ?DESC(error_message),
example => to_binary(emqx_reason_codes:name(?RC_TOPIC_NAME_INVALID))
})} })}
]. ].

1
changes/ce/fix-11493.en.md Normal file
View File

@ -0,0 +1 @@
Examples and documentation for /api/v5/publish bad request response have been fixed. Previously the documentation example said that the bad request response could return a list in the body which was not actually the case.