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 06f0fbc72 docs: correct Admin API PATCH method descriptions (#12942)
06f0fbc72 is described below
commit 06f0fbc72c96dc1586d864963d40e73a814b8737
Author: Traky Deng <[email protected]>
AuthorDate: Thu Jan 29 16:59:18 2026 +0800
docs: correct Admin API PATCH method descriptions (#12942)
---
docs/en/latest/admin-api.md | 28 ++++++++++++++--------------
docs/zh/latest/admin-api.md | 4 ++--
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
index 4caeb081c..21f416b71 100644
--- a/docs/en/latest/admin-api.md
+++ b/docs/en/latest/admin-api.md
@@ -335,8 +335,8 @@ ID's as a text string must be of a length between 1 and 64
characters and they s
| PUT | /apisix/admin/routes/{id} | {...} | Creates a Route
with the specified id.
|
| POST | /apisix/admin/routes | {...} | Creates a Route
and assigns a random id.
|
| DELETE | /apisix/admin/routes/{id} | NULL | Removes the Route
with the specified id.
|
-| PATCH | /apisix/admin/routes/{id} | {...} | Updates the
selected attributes of the specified, existing Route. To delete an attribute,
set value of attribute set to null. |
-| PATCH | /apisix/admin/routes/{id}/{path} | {...} | Updates the
attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/routes/{id} | {...} | Standard PATCH, which
modifies the specified attributes of the Route, while all other attributes
remain unchanged. To delete an attribute, set its value to `null`. Note that if
an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/routes/{id}/{path} | {...} | Subpath PATCH, which
specifies the Route attribute to update via `{path}` and completely replaces
that attribute’s data, while all other attributes remain unchanged. |
### URI Request Parameters
@@ -658,8 +658,8 @@ Service resource request address:
/apisix/admin/services/{id}
| PUT | /apisix/admin/services/{id} | {...} | Creates a
Service with the specified id.
|
| POST | /apisix/admin/services | {...} | Creates a
Service and assigns a random id.
|
| DELETE | /apisix/admin/services/{id} | NULL | Removes the
Service with the specified id.
|
-| PATCH | /apisix/admin/services/{id} | {...} | Updates the
selected attributes of the specified, existing Service. To delete an attribute,
set value of attribute set to null. |
-| PATCH | /apisix/admin/services/{id}/{path} | {...} | Updates the
attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/services/{id} | {...} | Standard PATCH, which
modifies the specified attributes of the Service, while all other attributes
remain unchanged. To delete an attribute, set its value to `null`. Note that if
an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/services/{id}/{path} | {...} | Subpath PATCH, which
specifies the Service attribute to update via `{path}` and completely replaces
that attribute’s data, while all other attributes remain unchanged. |
### Request Body Parameters
@@ -991,8 +991,8 @@ For notes on ID syntax please refer to: [ID
Syntax](#quick-note-on-id-syntax)
| PUT | /apisix/admin/upstreams/{id} | {...} | Creates an
Upstream with the specified id.
|
| POST | /apisix/admin/upstreams | {...} | Creates an
Upstream and assigns a random id.
|
| DELETE | /apisix/admin/upstreams/{id} | NULL | Removes the
Upstream with the specified id.
|
-| PATCH | /apisix/admin/upstreams/{id} | {...} | Updates the
selected attributes of the specified, existing Upstream. To delete an
attribute, set value of attribute set to null. |
-| PATCH | /apisix/admin/upstreams/{id}/{path} | {...} | Updates the
attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/upstreams/{id} | {...} | Standard PATCH, which
modifies the specified attributes of the existing Upstream, while all other
attributes remain unchanged. To delete an attribute, set its value to `null`.
Note that if an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/upstreams/{id}/{path} | {...} | Subpath PATCH, which
specifies the Upstream attribute to update via `{path}` and completely replaces
that attribute’s data, while all other attributes remain unchanged. |
### Request Body Parameters
@@ -1348,8 +1348,8 @@ Global Rule resource request address:
/apisix/admin/global_rules/{id}
| GET | /apisix/admin/global_rules/{id} | NULL | Fetches
specified Global Rule by id.
|
| PUT | /apisix/admin/global_rules/{id} | {...} | Creates a
Global Rule with the specified id.
|
| DELETE | /apisix/admin/global_rules/{id} | NULL | Removes the
Global Rule with the specified id.
|
-| PATCH | /apisix/admin/global_rules/{id} | {...} | Updates the
selected attributes of the specified, existing Global Rule. To delete an
attribute, set value of attribute set to null. |
-| PATCH | /apisix/admin/global_rules/{id}/{path} | {...} | Updates the
attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/global_rules/{id} | {...} | Standard PATCH,
which modifies the specified attributes of the existing Global Rule, while all
other attributes remain unchanged. To delete an attribute, set its value to
`null`. Note that if an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/global_rules/{id}/{path} | {...} | Subpath PATCH,
which specifies the Global Rule attribute to update via `{path}` and completely
replaces that attribute’s data, while all other attributes remain unchanged. |
### Request Body Parameters
@@ -1373,8 +1373,8 @@ Consumer group resource request address:
/apisix/admin/consumer_groups/{id}
| GET | /apisix/admin/consumer_groups/{id} | NULL | Fetches
specified Consumer group by id.
|
| PUT | /apisix/admin/consumer_groups/{id} | {...} | Creates
a new Consumer group with the specified id.
|
| DELETE | /apisix/admin/consumer_groups/{id} | NULL | Removes
the Consumer group with the specified id.
|
-| PATCH | /apisix/admin/consumer_groups/{id} | {...} | Updates
the selected attributes of the specified, existing Consumer group. To delete an
attribute, set value of attribute set to null. |
-| PATCH | /apisix/admin/consumer_groups/{id}/{path} | {...} | Updates
the attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/consumer_groups/{id} | {...} | Standard PATCH,
which modifies the specified attributes of the existing Consumer Group, while
all other attributes remain unchanged. To delete an attribute, set its value to
`null`. Note that if an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/consumer_groups/{id}/{path} | {...} | Subpath PATCH,
which specifies the Consumer Group attribute to update via `{path}` and
completely replaces that attribute’s data, while all other attributes remain
unchanged. |
### Request Body Parameters
@@ -1401,8 +1401,8 @@ Plugin Config resource request address:
/apisix/admin/plugin_configs/{id}
| GET | /apisix/admin/plugin_configs/{id} | NULL | Fetches
specified Plugin config by id.
|
| PUT | /apisix/admin/plugin_configs/{id} | {...} | Creates a
new Plugin config with the specified id.
|
| DELETE | /apisix/admin/plugin_configs/{id} | NULL | Removes
the Plugin config with the specified id.
|
-| PATCH | /apisix/admin/plugin_configs/{id} | {...} | Updates
the selected attributes of the specified, existing Plugin config. To delete an
attribute, set value of attribute set to null. |
-| PATCH | /apisix/admin/plugin_configs/{id}/{path} | {...} | Updates
the attribute specified in the path. The values of other attributes remain
unchanged. |
+| PATCH | /apisix/admin/plugin_configs/{id} | {...} | Standard PATCH,
which modifies the specified attributes of the existing Plugin Config, while
all other attributes remain unchanged. To delete an attribute, set its value to
`null`. Note that if an attribute is an array, it will be completely replaced. |
+| PATCH | /apisix/admin/plugin_configs/{id}/{path} | {...} | Subpath PATCH,
which specifies the Plugin Config attribute to update via `{path}` and
completely replaces that attribute’s data, while all other attributes remain
unchanged. |
### Request Body Parameters
@@ -1563,8 +1563,8 @@ Secret resource request address:
/apisix/admin/secrets/{secretmanager}/{id}
| GET | /apisix/admin/secrets/{manager}/{id} | NULL | Fetches
specified secrets by id. |
| PUT | /apisix/admin/secrets/{manager} | {...} | Create
new secrets configuration. |
| DELETE | /apisix/admin/secrets/{manager}/{id} | NULL | Removes the
secrets with the specified id. |
-| PATCH | /apisix/admin/secrets/{manager}/{id} | {...} |
Updates the selected attributes of the specified, existing secrets. To delete
an attribute, set value of attribute set to null. |
-| PATCH | /apisix/admin/secrets/{manager}/{id}/{path} | {...} |
Updates the attribute specified in the path. The values of other attributes
remain unchanged. |
+| PATCH | /apisix/admin/secrets/{manager}/{id} | {...} | Standard
PATCH, which modifies the specified attributes of the existing secret, while
all other attributes remain unchanged. To delete an attribute, set its value to
`null`. |
+| PATCH | /apisix/admin/secrets/{manager}/{id}/{path} | {...} | Subpath PATCH,
which specifies the secret attribute to update via `{path}` and completely
replaces that attribute’s data, while all other attributes remain unchanged. |
### Request Body Parameters
diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md
index da0f2bf74..62ea51a1f 100644
--- a/docs/zh/latest/admin-api.md
+++ b/docs/zh/latest/admin-api.md
@@ -1572,8 +1572,8 @@ Secret 资源请求地址：/apisix/admin/secrets/{secretmanager}/{id}
| GET | /apisix/admin/secrets/{manager}/{id} | NULL | 根据 id 获取指定的 secret。
|
| PUT | /apisix/admin/secrets/{manager} | {...} | 创建新的 secret 配置。
|
| DELETE | /apisix/admin/secrets/{manager}/{id} | NULL | 删除具有指定 id 的 secret。
|
-| PATCH | /apisix/admin/secrets/{manager}/{id} | {...} | 更新指定 secret
的选定属性。如果要删除一个属性，可以将该属性的值设置为 null。|
-| PATCH | /apisix/admin/secrets/{manager}/{id}/{path} | {...} |
更新路径中指定的属性。其他属性的值保持不变。
+| PATCH | /apisix/admin/secrets/{manager}/{id} | {...} | 标准
PATCH，修改指定 secret 的部分属性，其他不涉及的属性会原样保留；如果你需要删除某个属性，可以将该属性的值设置为
`null`；当需要修改属性的值为数组时，该属性将全量更新。 |
+| PATCH | /apisix/admin/secrets/{manager}/{id}/{path} | {...} | SubPath
PATCH，通过 `{path}` 指定 secret 要更新的属性，全量更新该属性的数据，其他不涉及的属性会原样保留。
|
### body 请求参数 {#secret-config-body-requset-parameters}
