diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-02 21:08:11 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-02 21:08:11 +0300 |
| commit | 8a7efa45c38ed3200d173d2c3207a8154e583c16 (patch) | |
| tree | 1bb4d579b95c79aae4946a06fefa089e5549b722 /doc/api | |
| parent | 53b1f4eaa2a451aaba908a5fee7ce97a930021ac (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 319a697b082..24b81852dc5 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -436,6 +436,24 @@ Keyset-based pagination is only supported for selected resources and ordering op | ------------------------- | -------------------------- | | [Projects](projects.md) | `order_by=id` only | +## Path parameters + +If an endpoint has path parameters, the documentation shows them with a preceding colon. + +For example: + +```plaintext +DELETE /projects/:id/share/:group_id +``` + +The `:id` path parameter needs to be replaced with the project id, and the `:group_id` needs to be replaced with the id of the group. The colons `:` should not be included. + +The resulting cURL call for a project with id `5` and a group id of `17` is then: + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17 +``` + ## Namespaced path encoding If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_PATH` is |