diff options
| author | Dawid Goslawski <alkuzad@gmail.com> | 2016-12-25 14:42:41 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-04-08 12:38:59 +0200 |
| commit | 82fad17a7d40b7d19e0ee56abbe484c187d3360d (patch) | |
| tree | 7387c96cf510714bcc38864ca17fb426ebea5a37 /doc/api/README.md | |
| parent | 3d1cade13f61115b63bf6dbda5a1f194ba54b24b (diff) | |
| download | gitlab-ce-82fad17a7d40b7d19e0ee56abbe484c187d3360d.tar.gz | |
Add information about namespace encoding to API docs
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index e627b6f2ee8..5a63f68ce77 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -303,6 +303,17 @@ Additional pagination headers are also sent back. | `X-Next-Page` | The index of the next page | | `X-Prev-Page` | The index of the previous page | +## Namespaced path encoding + +If using namespaced api calls make sure that the `NAMESPACE/PROJECT_NAME` is +URL-encoded. + +For example, `/` is represented by `%2F`: + +``` +/api/v4/projects/diaspora%2Fdiaspora +``` + ## `id` vs `iid` When you work with the API, you may notice two similar fields in API entities: @@ -398,7 +409,6 @@ Content-Type: application/json } ``` - ## Clients There are many unofficial GitLab API Clients for most of the popular |