diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-06 17:56:13 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2017-09-06 17:56:13 +0300 |
commit | 5e6b5832ea9e0e78314b69aee764410edaa0fafd (patch) | |
tree | 42b0fa6d7ed1de149ce231585369cb80bbb8de86 /doc/api/README.md | |
parent | 794e37661d8cf847cda750a8e62a809889534125 (diff) | |
parent | cdd8f2f345aeb3fb05bbe8f567e72b717f388636 (diff) |
Merge branch 'master' into 'docs/migrating-from-tfs'
# Conflicts:
# doc/user/project/import/index.md
Diffstat (limited to 'doc/api/README.md')
-rw-r--r-- | doc/api/README.md | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index c2a08dcff07..db61497db53 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -61,16 +61,7 @@ following locations: ## Road to GraphQL -Going forward, we will start on moving to -[GraphQL](http://graphql.org/learn/best-practices/) and deprecate the use of -controller-specific endpoints. GraphQL has a number of benefits: - -1. We avoid having to maintain two different APIs. -2. Callers of the API can request only what they need. -3. It is versioned by default. - -It will co-exist with the current v4 REST API. If we have a v5 API, this should -be a compatibility layer on top of GraphQL. +We have changed our plans to move to GraphQL. After reviewing the GraphQL license, anything related to the Facebook BSD plus patent license will not be allowed at GitLab. ## Basic usage @@ -246,8 +237,8 @@ The following table gives an overview of how the API functions generally behave. | ------------ | ----------- | | `GET` | Access one or more resources and return the result as JSON. | | `POST` | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. | -| `GET` / `PUT` / `DELETE` | Return `200 OK` if the resource is accessed, modified or deleted successfully. The (modified) result is returned as JSON. | -| `DELETE` | Designed to be idempotent, meaning a request to a resource still returns `200 OK` even it was deleted before or is not available. The reasoning behind this, is that the user is not really interested if the resource existed before or not. | +| `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. | +| `DELETE` | Returns `204 No Content` if the resuource was deleted successfully. | The following table shows the possible return codes for API requests. |