From 97f58c78311c453a40498e74114817ffc6f79476 Mon Sep 17 00:00:00 2001 From: AJ Jordan Date: Fri, 28 Jul 2017 14:30:42 -0700 Subject: [PATCH] Explicitly spell out where the API root is I found this basic information extrememly hard to find when I looked at this page. --- doc/api/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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, -- GitLab