This is an automated email from the ASF dual-hosted git repository.
membphis 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 5be8d85 doc: correct the guide of creating consumer guide in AdminAPI
(#2513)
5be8d85 is described below
commit 5be8d850c0651302bf8e647df59c7dd41ddb2e78
Author: Joey <[email protected]>
AuthorDate: Mon Oct 26 22:07:37 2020 +0800
doc: correct the guide of creating consumer guide in AdminAPI (#2513)
Fix #2512
---
doc/admin-api.md | 3 +--
doc/zh-cn/admin-api.md | 3 +--
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/doc/admin-api.md b/doc/admin-api.md
index 2e95ff7..eb6e0e3 100644
--- a/doc/admin-api.md
+++ b/doc/admin-api.md
@@ -410,7 +410,7 @@ Return response from etcd currently.
*API*:/apisix/admin/consumers/{id}
-*Description*:Consumers are consumers of certain types of services and can
only be used in conjunction with a user authentication system.
+*Description*:Consumers are consumers of certain types of services and can
only be used in conjunction with a user authentication system. Consumer regards
the `username` property as the identity, so only the HTTP `PUT` method is
supported for creating a new consumer.
> Request Methods:
@@ -418,7 +418,6 @@ Return response from etcd currently.
|---------|-------------------------|--|------|
|GET |/apisix/admin/consumers/{id}|NULL|Fetch resource|
|PUT |/apisix/admin/consumers/{id}|{...}|Create resource by ID|
-|POST |/apisix/admin/consumers |{...}|Create resource, and ID is
generated by server|
|DELETE |/apisix/admin/consumers/{id}|NULL|Remove resource|
> Request Body Parameters:
diff --git a/doc/zh-cn/admin-api.md b/doc/zh-cn/admin-api.md
index 8e958e7..f971446 100644
--- a/doc/zh-cn/admin-api.md
+++ b/doc/zh-cn/admin-api.md
@@ -423,7 +423,7 @@ HTTP/1.1 200 OK
*地址*:/apisix/admin/consumers/{id}
-*说明*:Consumer 是某类服务的消费者,需与用户认证体系配合才能使用。
+*说明*:Consumer 是某类服务的消费者,需与用户认证体系配合才能使用。Consumer 使用 `username` 作为唯一标识,只支持使用
HTTP `PUT` 方法创建 Consumer。
> 请求方法:
@@ -431,7 +431,6 @@ HTTP/1.1 200 OK
|---------|-------------------------|--|------|
|GET |/apisix/admin/consumers/{id}|无|获取资源|
|PUT |/apisix/admin/consumers/{id}|{...}|根据 id 创建资源|
-|POST |/apisix/admin/consumers |{...}|创建资源,id 由后台服务自动生成|
|DELETE |/apisix/admin/consumers/{id}|无|删除资源|
> body 请求参数: