You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2020/12/31 01:11:18 UTC
[apisix] branch master updated: docs: Add plugin list and detail
acquisition interface (#3156)
This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 0365fb8 docs: Add plugin list and detail acquisition interface (#3156)
0365fb8 is described below
commit 0365fb880c766b4469138a48b31b2abd19ea8c55
Author: qwxingzhe <12...@qq.com>
AuthorDate: Thu Dec 31 09:11:10 2020 +0800
docs: Add plugin list and detail acquisition interface (#3156)
---
doc/admin-api.md | 28 ++++++++++++++++++++++++++++
doc/zh-cn/admin-api.md | 29 +++++++++++++++++++++++++++++
2 files changed, 57 insertions(+)
diff --git a/doc/admin-api.md b/doc/admin-api.md
index ffa8df4..5444ac3 100644
--- a/doc/admin-api.md
+++ b/doc/admin-api.md
@@ -25,6 +25,7 @@
* [Upstream](#upstream)
* [SSL](#ssl)
* [Plugin Metadata](#plugin-metadata)
+* [Plugin](#plugin)
## Route
@@ -717,6 +718,33 @@ Content-Type: text/plain
[Back to TOC](#Table-of-Contents)
+## Plugin
+
+*API*：/apisix/admin/plugins/{plugin_name}
+
+*Description*: plugin
+
+> Request Methods:
+
+|Method |Request URI|Request Body|Description |
+|---------|-------------------------|--|------|
+|GET |/apisix/admin/plugins/list|NULL|Fetch resource list|
+|GET |/apisix/admin/plugins/{plugin_name}|NULL|Fetch resource|
+
+> Request Body Parameters:
+
+Get the plugin ({plugin_name}) of the data structure.
+
+Example：
+
+```shell
+$ curl "http://127.0.0.1:9080/apisix/admin/plugins/list" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
+["zipkin","request-id",...]
+
+$ curl "http://127.0.0.1:9080/apisix/admin/plugins/key-auth" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
+{"properties":{"disable":{"type":"boolean"}},"additionalProperties":false,"type":"object"}
+```
+
*API*：/apisix/admin/plugins/?all=true
*Description*: all the attributes of all plugins, each plugin includes `name`, `priority`, `type`, `schema`, `consumer_schema` and `version`.
diff --git a/doc/zh-cn/admin-api.md b/doc/zh-cn/admin-api.md
index c6a83ae..c50dd12 100644
--- a/doc/zh-cn/admin-api.md
+++ b/doc/zh-cn/admin-api.md
@@ -25,6 +25,7 @@
* [Upstream](#upstream)
* [SSL](#ssl)
* [Plugin Metadata](#plugin-metadata)
+* [Plugin](#plugin)
## Route
@@ -725,6 +726,34 @@ Content-Type: text/plain
[Back to TOC](#目录)
+## Plugin
+
+
+*地址*：/apisix/admin/plugins/{plugin_name}
+
+*说明*: 插件
+
+> 请求方法:
+
+|名字 |请求 uri|请求 body|说明 |
+|---------|-------------------------|--|------|
+|GET |/apisix/admin/plugins/list|无|获取资源列表|
+|GET |/apisix/admin/plugins/{plugin_name}|无|获取资源|
+
+> body 请求参数：
+
+获取插件 ({plugin_name}) 数据结构的 json object 。
+
+例子:
+
+```shell
+$ curl "http://127.0.0.1:9080/apisix/admin/plugins/list" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
+["zipkin","request-id",...]
+
+$ curl "http://127.0.0.1:9080/apisix/admin/plugins/key-auth" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
+{"properties":{"disable":{"type":"boolean"}},"additionalProperties":false,"type":"object"}
+```
+
*地址*：/apisix/admin/plugins/?all=true
*说明*: 所有插件的所有属性，每个插件包括 `name`, `priority`, `type`, `schema`, `consumer_schema` and `version`。