summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSean McGivern <sean@mcgivern.me.uk>2017-07-27 14:33:06 +0000
committerSean McGivern <sean@mcgivern.me.uk>2017-07-27 14:33:06 +0000
commitcaad9334a7b9c0c7a6356418f0d7018919e7d09a (patch)
tree3b81224fd33afe0ae252f3d8f6dcc9f92b4e612b /doc
parent0ed42f4b3534e652c91e6628c43e09be67423301 (diff)
parent4e3e0dc8d4d742e388372e969324483ab51a3363 (diff)
downloadgitlab-ce-caad9334a7b9c0c7a6356418f0d7018919e7d09a.tar.gz
Merge branch 'rc/fix-branches-api-endpoint' into 'master'
Fix the `/projects/:id/repository/branches endpoint` to handle dots in the branch name when the project full patch contains a `/` See merge request !13115
Diffstat (limited to 'doc')
-rw-r--r--doc/api/README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index a888c0ebb4e..fe29563eaca 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -340,7 +340,18 @@ URL-encoded.
For example, `/` is represented by `%2F`:
```
-/api/v4/projects/diaspora%2Fdiaspora
+GET /api/v4/projects/diaspora%2Fdiaspora
+```
+
+## Branches & tags name encoding
+
+If your branch or tag contains a `/`, make sure the branch/tag name is
+URL-encoded.
+
+For example, `/` is represented by `%2F`:
+
+```
+GET /api/v4/projects/1/branches/my%2Fbranch/commits
```
## `id` vs `iid`