summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Friend <nathan@gitlab.com>2019-07-22 16:05:37 +0000
committerNathan Friend <nathan@gitlab.com>2019-07-22 16:05:37 +0000
commitf3b00b60b4f3b1edac1d6734d0d377ce7f182d27 (patch)
tree9af1267607dbe3c9a3592169f9383505af8a5a4e
parent8073b0554fc8f7dddc250025aaf5cedd09f423cb (diff)
downloadgitlab-ce-docs-nfriend-project-name-vs-project-path.tar.gz
Clarify project name vs pathdocs-nfriend-project-name-vs-project-path
-rw-r--r--doc/api/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index f9cc1a09870..a564abaa305 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -515,7 +515,7 @@ more than 10,000, the `X-Total` and `X-Total-Pages` headers as well as the
## Namespaced path encoding
-If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
+If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_PATH` is
URL-encoded.
For example, `/` is represented by `%2F`:
@@ -524,6 +524,11 @@ For example, `/` is represented by `%2F`:
GET /api/v4/projects/diaspora%2Fdiaspora
```
+NOTE: **Note:**
+A project's **path** is not necessarily the same as its **name**. A
+project's path can found in the project's URL or in the project's settings
+under **General > Advanced > Change path**.
+
## Branches and tags name encoding
If your branch or tag contains a `/`, make sure the branch/tag name is