diff options
| author | Marcia Ramos <marcia@gitlab.com> | 2019-07-25 13:38:53 +0000 |
|---|---|---|
| committer | Marcia Ramos <marcia@gitlab.com> | 2019-07-25 13:38:53 +0000 |
| commit | e01e78c50476b2789f0424ce722665944dee55e2 (patch) | |
| tree | 661089d18eb39603695b791fcba9f2f8249a513d | |
| parent | 29f2903d161c2b93468a997f704a81adebcc9f58 (diff) | |
| parent | f3b00b60b4f3b1edac1d6734d0d377ce7f182d27 (diff) | |
| download | gitlab-ce-e01e78c50476b2789f0424ce722665944dee55e2.tar.gz | |
Merge branch 'docs-nfriend-project-name-vs-project-path' into 'master'
Clarify difference between project name and project path for API usage
See merge request gitlab-org/gitlab-ce!31019
| -rw-r--r-- | doc/api/README.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 91bc8ca8aab..70540420544 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 |