summaryrefslogtreecommitdiff
path: root/doc/api/README.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-05-05 18:09:43 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-05-05 18:09:43 +0000
commit38ceebb9b3a541f8530b379d5b5ab5e13ffc58ed (patch)
tree7a0494f677459f96e6deda30da4069b7c038eca4 /doc/api/README.md
parent0d09054d162458364ce3fc431506c182e2a5fa4f (diff)
downloadgitlab-ce-38ceebb9b3a541f8530b379d5b5ab5e13ffc58ed.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/README.md')
-rw-r--r--doc/api/README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index e08006a7f7f..76bb3506f38 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -454,6 +454,12 @@ The resulting cURL call for a project with id `5` and a group id of `17` is then
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17
```
+NOTE: **Note:**
+Path parameters that are required to be URL-encoded must be followed. If not,
+it will not match an API endpoint and respond with a 404. If there's something
+in front of the API (for example, Apache), ensure that it won't decode the URL-encoded
+path parameters.
+
## Namespaced path encoding
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_PATH` is
@@ -470,15 +476,16 @@ A project's **path** is not necessarily the same as its **name**. A
project's path can be found in the project's URL or in the project's settings
under **General > Advanced > Change path**.
-## Branches and tags name encoding
+## File path, branches, and tags name encoding
-If your branch or tag contains a `/`, make sure the branch/tag name is
-URL-encoded.
+If a file path, branch or tag contains a `/`, make sure it is URL-encoded.
For example, `/` is represented by `%2F`:
```plaintext
+GET /api/v4/projects/1/repository/files/src%2FREADME.md?ref=master
GET /api/v4/projects/1/branches/my%2Fbranch/commits
+GET /api/v4/projects/1/repository/tags/my%2Ftag
```
## Encoding API parameters of `array` and `hash` types