This is an automated email from the ASF dual-hosted git repository.
traky 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 d7874f7fc docs: add missing Admin API Plugin endpoints (#9050)
d7874f7fc is described below
commit d7874f7fc11221918717e49cf8c89a2f374a9558
Author: Abhishek Choudhary <[email protected]>
AuthorDate: Thu Aug 31 15:36:51 2023 +0545
docs: add missing Admin API Plugin endpoints (#9050)
* docs: add missing API endpoints
* apply suggestions
* Update docs/zh/latest/admin-api.md
Co-authored-by: Traky Deng <[email protected]>
* add more info
* apply suggestions
* Update docs/en/latest/admin-api.md
Co-authored-by: Traky Deng <[email protected]>
* Update docs/zh/latest/admin-api.md
Co-authored-by: Traky Deng <[email protected]>
* Update docs/en/latest/admin-api.md
Co-authored-by: Traky Deng <[email protected]>
* Apply suggestions from code review
---------
Co-authored-by: Traky Deng <[email protected]>
Co-authored-by: Ashish Tiwari <[email protected]>
---
docs/en/latest/admin-api.md | 12 ++++++++++++
docs/zh/latest/admin-api.md | 10 ++++++++++
2 files changed, 22 insertions(+)
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
index e0f58fd5f..414c18154 100644
--- a/docs/en/latest/admin-api.md
+++ b/docs/en/latest/admin-api.md
@@ -1362,6 +1362,18 @@ Plugin resource request address:
/apisix/admin/plugins/{plugin_name}
| ------ | ----------------------------------- | ------------ |
---------------------------------------------- |
| GET | /apisix/admin/plugins/list | NULL | Fetches a list
of all Plugins. |
| GET | /apisix/admin/plugins/{plugin_name} | NULL | Fetches the
specified Plugin by `plugin_name`. |
+| GET | /apisix/admin/plugins?all=true | NULL | Get all
properties of all plugins. |
+| GET | /apisix/admin/plugins?all=true&subsystem=stream| NULL | Gets
properties of all Stream plugins.|
+| GET | /apisix/admin/plugins?all=true&subsystem=http | NULL | Gets
properties of all HTTP plugins. |
+| PUT | /apisix/admin/plugins/reload | NULL | Reloads the
plugin according to the changes made in code |
+| GET | apisix/admin/plugins/{plugin_name}?subsystem=stream | NULL | Gets
properties of a specified plugin if it is supported in Stream/L4 subsystem. |
+| GET | apisix/admin/plugins/{plugin_name}?subsystem=http | NULL | Gets
properties of a specified plugin if it is supported in HTTP/L7 subsystem. |
+
+:::caution
+
+The interface of getting properties of all plugins via
`/apisix/admin/plugins?all=true` will be deprecated soon.
+
+:::
### Request Body Parameters
diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md
index e1fd063e8..5dd379678 100644
--- a/docs/zh/latest/admin-api.md
+++ b/docs/zh/latest/admin-api.md
@@ -1376,6 +1376,16 @@ Plugin 资源请求地址：/apisix/admin/plugins/{plugin_name}
| GET | /apisix/admin/plugins/{plugin_name} | 无 | 获取资源。 |
| GET | /apisix/admin/plugins?all=true | 无 | 获取所有插件的所有属性。
|
| GET | /apisix/admin/plugins?all=true&subsystem=stream| 无 | 获取所有
Stream 插件的属性。|
+| GET | /apisix/admin/plugins?all=true&subsystem=http| 无 | 获取所有 HTTP
插件的属性。|
+| PUT | /apisix/admin/plugins/reload | 无 |
根据代码中所做的更改重新加载插件。 |
+| GET | apisix/admin/plugins/{plugin_name}?subsystem=stream |
无 | 获取指定 Stream 插件的属性。 |
+| GET | apisix/admin/plugins/{plugin_name}?subsystem=http | 无
| 获取指定 HTTP 插件的属性。 |
+
+:::caution
+
+获取所有插件属性的接口 `/apisix/admin/plugins?all=true` 将很快被弃用。
+
+:::
### 使用示例 {#plugin-example}
