diff options
| author | DeAndre Harris <dharris@gitlab.com> | 2019-07-29 09:45:20 +0000 |
|---|---|---|
| committer | DeAndre Harris <dharris@gitlab.com> | 2019-07-29 09:45:20 +0000 |
| commit | 88b4b9bd2e8224e17ff089d2a8ea99f800686b70 (patch) | |
| tree | 67e6fadf31d75860f2158c05168f160d52ae46fe /doc/api/README.md | |
| parent | 750fd7374ae67bb6ed4d9d875052bbc6d86d9b31 (diff) | |
| parent | 77926ea02512d836c61a30e3986902e2d8e7f886 (diff) | |
| download | gitlab-ce-docs-troubleshoot-scim.tar.gz | |
Merge branch 'master' into 'docs-troubleshoot-scim'docs-troubleshoot-scim
# Conflicts:
# doc/user/group/saml_sso/scim_setup.md
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 8e60d1c61df..70540420544 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -29,7 +29,7 @@ The following API resources are available in the project context: | [Commits](commits.md) | `/projects/:id/repository/commits`, `/projects/:id/statuses` | | [Container Registry](container_registry.md) | `/projects/:id/registry/repositories` | | [Custom attributes](custom_attributes.md) | `/projects/:id/custom_attributes` (also available for groups and users) | -| [Dependencies](dependencies.md) **[ULTIMATE]** | `/projects/:id/dependencies` +| [Dependencies](dependencies.md) **(ULTIMATE)** | `/projects/:id/dependencies` | [Deploy keys](deploy_keys.md) | `/projects/:id/deploy_keys` (also available standalone) | | [Deployments](deployments.md) | `/projects/:id/deployments` | | [Discussions](discussions.md) (threaded comments) | `/projects/:id/issues/.../discussions`, `/projects/:id/snippets/.../discussions`, `/projects/:id/merge_requests/.../discussions`, `/projects/:id/commits/.../discussions` (also available for groups) | @@ -272,6 +272,12 @@ Example of using the personal access token in a header: curl --header "Private-Token: <your_access_token>" https://gitlab.example.com/api/v4/projects ``` +You can also use personal access tokens with OAuth-compliant headers: + +```shell +curl --header "Authorization: Bearer <your_access_token>" https://gitlab.example.com/api/v4/projects +``` + Read more about [personal access tokens][pat]. ### Session cookie @@ -509,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`: @@ -518,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 |