Commit 6336aa42 authored by Rene Verschoor's avatar Rene Verschoor Committed by Achilleas Pipinellis

Docs: Explain path parameter usage in API documentation

parent 819f0b3e
...@@ -436,6 +436,24 @@ Keyset-based pagination is only supported for selected resources and ordering op ...@@ -436,6 +436,24 @@ Keyset-based pagination is only supported for selected resources and ordering op
| ------------------------- | -------------------------- | | ------------------------- | -------------------------- |
| [Projects](projects.md) | `order_by=id` only | | [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 ## Namespaced path encoding
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_PATH` is If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_PATH` is
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment