You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/10 09:12:19 UTC
[GitHub] [apisix] yzeng25 commented on a change in pull request #6565: docs: update the API docs
yzeng25 commented on a change in pull request #6565:
URL: https://github.com/apache/apisix/pull/6565#discussion_r823497363
##########
File path: docs/en/latest/admin-api.md
##########
@@ -276,44 +269,46 @@ After successful execution, status nodes will be updated to:
### Response Parameters
-Return response from etcd currently.
+Currently, the response is returned from etcd.
[Back to TOC](#table-of-contents)
## Service
-*API*：/apisix/admin/services/{id}
+**API**: /apisix/admin/services/{id}
+
+A Service is an abstraction of an API (which can also be understood as a set of Route abstractions). It usually corresponds to an upstream service abstraction.
-*Description*：A `Service` is an abstraction of an API (which can also be understood as a set of Route abstractions). It usually corresponds to the upstream service abstraction. Between `Route` and `Service`, usually the relationship of N:1.
+The relationship between Routes and a Service is usually N:1.
### Request Methods
-| Method | Request URI | Request Body | Description |
-| ------ | ---------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| GET | /apisix/admin/services | NULL | Fetch resource list |
-| GET | /apisix/admin/services/{id} | NULL | Fetch resource |
-| PUT | /apisix/admin/services/{id} | {...} | Create resource by ID |
-| POST | /apisix/admin/services | {...} | Create resource, and ID is generated by server |
-| DELETE | /apisix/admin/services/{id} | NULL | Remove resource |
-| PATCH | /apisix/admin/services/{id} | {...} | Standard PATCH. Update some attributes of the existing Service, and other attributes not involved will remain as they are; if you want to delete an attribute, set the value of the attribute Set to null to delete; especially, when the value of the attribute is an array, the attribute will be updated in full |
-| PATCH | /apisix/admin/services/{id}/{path} | {...} | SubPath PATCH, specify the attribute of Service to be updated through {path}, update the value of this attribute in full, and other attributes that are not involved will remain as they are. The difference between the two PATCH can refer to the following examples |
+| Method | Request URI | Request Body | Description |
+| ------ | ---------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------- |
+| GET | /apisix/admin/services | NULL | Fetches a list of available Services. |
+| GET | /apisix/admin/services/{id} | NULL | Fetches specified Service by id. |
+| PUT | /apisix/admin/services/{id} | {...} | Creates a Service with specified id. |
Review comment:
```suggestion
| PUT | /apisix/admin/services/{id} | {...} | Creates a Service with a specified id. |
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org