Commit b985d287 authored by Evan Read's avatar Evan Read

Add prerequisite knowledge blurb and minor style fixes.

parent ac2adcf7
...@@ -3,6 +3,8 @@ ...@@ -3,6 +3,8 @@
Automate GitLab via a simple and powerful API. All definitions can be found Automate GitLab via a simple and powerful API. All definitions can be found
under [`/lib/api`](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api). under [`/lib/api`](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api).
The main GitLab API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API. Therefore, documentation in this section assumes knowledge of REST concepts.
## Resources ## Resources
Documentation for various API resources can be found separately in the Documentation for various API resources can be found separately in the
...@@ -77,8 +79,8 @@ Going forward, we will start on moving to ...@@ -77,8 +79,8 @@ Going forward, we will start on moving to
controller-specific endpoints. GraphQL has a number of benefits: controller-specific endpoints. GraphQL has a number of benefits:
1. We avoid having to maintain two different APIs. 1. We avoid having to maintain two different APIs.
2. Callers of the API can request only what they need. 1. Callers of the API can request only what they need.
3. It is versioned by default. 1. It is versioned by default.
It will co-exist with the current v4 REST API. If we have a v5 API, this should It will co-exist with the current v4 REST API. If we have a v5 API, this should
be a compatibility layer on top of GraphQL. be a compatibility layer on top of GraphQL.
...@@ -139,8 +141,9 @@ There are three ways to authenticate with the GitLab API: ...@@ -139,8 +141,9 @@ There are three ways to authenticate with the GitLab API:
1. [Session cookie](#session-cookie) 1. [Session cookie](#session-cookie)
For admins who want to authenticate with the API as a specific user, or who want to build applications or scripts that do so, two options are available: For admins who want to authenticate with the API as a specific user, or who want to build applications or scripts that do so, two options are available:
1. [Impersonation tokens](#impersonation-tokens) 1. [Impersonation tokens](#impersonation-tokens)
2. [Sudo](#sudo) 1. [Sudo](#sudo)
If authentication information is invalid or omitted, an error message will be If authentication information is invalid or omitted, an error message will be
returned with status code `401`: returned with status code `401`:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment