diff options
| author | AJ Jordan <alex@strugee.net> | 2017-07-28 14:30:42 -0700 |
|---|---|---|
| committer | AJ Jordan <alex@strugee.net> | 2017-07-28 14:30:42 -0700 |
| commit | 97f58c78311c453a40498e74114817ffc6f79476 (patch) | |
| tree | 87c9c153fefec9608d64f1e89c6b6173acbf6d43 | |
| parent | a2ac5720ef982b9ed1012e9b64ab36679a303c52 (diff) | |
| download | gitlab-ce-97f58c78311c453a40498e74114817ffc6f79476.tar.gz | |
Explicitly spell out where the API root is
I found this basic information extrememly hard to find when I looked
at this page.
| -rw-r--r-- | doc/api/README.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index b16f31306a8..cb4ec88e868 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -78,7 +78,8 @@ be a compatibility layer on top of GraphQL. ## Basic usage API requests should be prefixed with `api` and the API version. The API version -is defined in [`lib/api.rb`][lib-api-url]. +is defined in [`lib/api.rb`][lib-api-url]. For example, the root of the v4 API +is at `/api/v4`. For endpoints that require [authentication](#authentication), you need to pass a `private_token` parameter via query string or header. If passed as a header, |