From c180b6a417ce8397c154dfcd181ce8d01a6cf02a Mon Sep 17 00:00:00 2001 From: JimMoen Date: Wed, 24 Apr 2024 17:48:26 +0800 Subject: [PATCH] fix(api): plugin api docs --- apps/emqx_management/src/emqx_mgmt_api_plugins.erl | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/apps/emqx_management/src/emqx_mgmt_api_plugins.erl b/apps/emqx_management/src/emqx_mgmt_api_plugins.erl index ac79c6d84..e065e0301 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_plugins.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_plugins.erl @@ -170,10 +170,9 @@ schema("/plugins/:name/config") -> #{ 'operationId' => plugin_config, get => #{ - summary => - <<"Get plugin config">>, + summary => <<"Get plugin config">>, description => - "Get plugin config by avro encoded binary config. Schema defined by user's schema.avsc file.
", + "Get plugin config. Config schema is defined by user's schema.avsc file.
", tags => ?TAGS, parameters => [hoconsc:ref(name)], responses => #{ @@ -186,7 +185,7 @@ schema("/plugins/:name/config") -> summary => <<"Update plugin config">>, description => - "Update plugin config by avro encoded binary config. Schema defined by user's schema.avsc file.
", + "Update plugin config. Config schema defined by user's schema.avsc file.
", tags => ?TAGS, parameters => [hoconsc:ref(name)], 'requestBody' => #{ @@ -215,9 +214,8 @@ schema("/plugins/:name/schema") -> #{ 'operationId' => plugin_schema, get => #{ - summary => <<"Get installed plugin's avro schema">>, - description => - "Get plugin's config avro schema.", + summary => <<"Get installed plugin's AVRO schema">>, + description => "Get plugin's config AVRO schema.", tags => ?TAGS, parameters => [hoconsc:ref(name)], responses => #{