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

fix(api): plugin api docs

This commit is contained in:
JimMoen 2024-04-24 17:48:26 +08:00
parent 1f00ce789f
commit c180b6a417
No known key found for this signature in database
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
apps/emqx_management/src/emqx_mgmt_api_plugins.erl
View File

@ -170,10 +170,9 @@ schema("/plugins/:name/config") ->
#{ #{
'operationId' => plugin_config, 'operationId' => plugin_config,
get => #{ get => #{
summary => summary => <<"Get plugin config">>,
<<"Get plugin config">>,
description => description =>
"Get plugin config by avro encoded binary config. Schema defined by user's schema.avsc file.<br/>", "Get plugin config. Config schema is defined by user's schema.avsc file.<br/>",
tags => ?TAGS, tags => ?TAGS,
parameters => [hoconsc:ref(name)], parameters => [hoconsc:ref(name)],
responses => #{ responses => #{
@ -186,7 +185,7 @@ schema("/plugins/:name/config") ->
summary => summary =>
<<"Update plugin config">>, <<"Update plugin config">>,
description => description =>
"Update plugin config by avro encoded binary config. Schema defined by user's schema.avsc file.<br/>", "Update plugin config. Config schema defined by user's schema.avsc file.<br/>",
tags => ?TAGS, tags => ?TAGS,
parameters => [hoconsc:ref(name)], parameters => [hoconsc:ref(name)],
'requestBody' => #{ 'requestBody' => #{
@ -215,9 +214,8 @@ schema("/plugins/:name/schema") ->
#{ #{
'operationId' => plugin_schema, 'operationId' => plugin_schema,
get => #{ get => #{
summary => <<"Get installed plugin's avro schema">>, summary => <<"Get installed plugin's AVRO schema">>,
description => description => "Get plugin's config AVRO schema.",
"Get plugin's config avro schema.",
tags => ?TAGS, tags => ?TAGS,
parameters => [hoconsc:ref(name)], parameters => [hoconsc:ref(name)],
responses => #{ responses => #{