navendu-pottekkat commented on a change in pull request #6565:
URL: https://github.com/apache/apisix/pull/6565#discussion_r823665059
##########
File path: docs/en/latest/admin-api.md
##########
@@ -427,37 +422,37 @@ After successful execution, upstream nodes will not
retain the original data, an
### Response Parameters
-Return response from etcd currently.
+Currently, the response is returned from etcd.
[Back to TOC](#table-of-contents)
## Consumer
-*API*：/apisix/admin/consumers/{username}
+**API**: /apisix/admin/consumers/{username}
-*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.
+Consumers are users of services and can only be used in conjunction with a
user authentication system. A Consumer is identified by a `username` property.
So, for creating a new Consumer, only the HTTP `PUT` method is supported.
### Request Methods
-| Method | Request URI | Request Body | Description
|
-| ------ | ---------------------------------- | ------------ |
--------------------------- |
-| GET | /apisix/admin/consumers | NULL | Fetch resource
list |
-| GET | /apisix/admin/consumers/{username} | NULL | Fetch resource
|
-| PUT | /apisix/admin/consumers | {...} | Create resource
by username |
-| DELETE | /apisix/admin/consumers/{username} | NULL | Remove resource
|
+| Method | Request URI | Request Body | Description
|
+| ------ | ---------------------------------- | ------------ |
------------------------------------------------- |
+| GET | /apisix/admin/consumers | NULL | Fetches a list
of all Consumers. |
+| GET | /apisix/admin/consumers/{username} | NULL | Fetches
specified Consumer by username. |
+| PUT | /apisix/admin/consumers | {...} | Create new
Consumer. |
+| DELETE | /apisix/admin/consumers/{username} | NULL | Removes the
Consumer with the specified username. |
### Request Body Parameters
-| Parameter | Required | Type | Description
| Example
|
-| ----------- | -------- | ----------- |
------------------------------------------------------------------- |
------------------------------------------------ |
-| username | True | Name | Consumer name
|
|
-| plugins | False | Plugin | See
[Plugin](architecture-design/plugin.md) for more |
|
-| desc | False | Auxiliary | Identifies route names, usage
scenarios, and more. | customer xxxx
|
-| labels | False | Match Rules | Key/value pairs to specify attributes
|
{"version":"v2","build":"16","env":"production"} |
-| create_time | False | Auxiliary | epoch timestamp in second, will be
created automatically if missing | 1602883670
|
-| update_time | False | Auxiliary | epoch timestamp in second, will be
created automatically if missing | 1602883670
|
+| Parameter | Required | Type | Description
|
Example |
+| ----------- | -------- | ----------- |
------------------------------------------------------------------------------------------------------------------
| ------------------------------------------------ |
+| username | True | Name | Name of the Consumer.
|
|
+| plugins | False | Plugin | Plugins that are executed during the
request/response cycle. See [Plugin](architecture-design/plugin.md) for more. |
|
+| desc | False | Auxiliary | Description of usage scenarios.
|
customer xxxx |
+| labels | False | Match Rules | Attributes of the Consumer specified
as key-value pairs. |
{"version":"v2","build":"16","env":"production"} |
+| create_time | False | Auxiliary | Epoch timestamp in second of the
created time. If missing, this field will be populated automatically.
| 1602883670 |
Review comment:
Yes. I missed this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
