Commit 8bf75757 authored by Dan Jensen's avatar Dan Jensen

Clarify API documentation

Some of the API documentation is REST-specific, but written to look
generic (probably because it was written when the REST API was the
only API). This changes some of that generic text to clarify it is
REST-specific.
parent 9b7384f7
...@@ -6,22 +6,24 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,22 +6,24 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# API Docs **(FREE)** # API Docs **(FREE)**
Use the GitLab [REST](http://spec.openapis.org/oas/v3.0.3) API to automate GitLab. Use the GitLab APIs to automate GitLab.
You can also use a partial [OpenAPI definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml), You can also use a partial [OpenAPI definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml),
to test the API directly from the GitLab user interface. to test the API directly from the GitLab user interface.
Contributions are welcome. Contributions are welcome.
## Available API resources ## REST API
A REST API is available in GitLab.
Usage instructions are below.
For a list of the available resources and their endpoints, see For a list of the available resources and their endpoints, see
[API resources](api_resources.md). [REST API resources](api_resources.md).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an introduction and basic steps, see For an introduction and basic steps, see
[How to make GitLab API calls](https://www.youtube.com/watch?v=0LsMC3ZiXkA). [How to make GitLab API calls](https://www.youtube.com/watch?v=0LsMC3ZiXkA).
## SCIM **(PREMIUM SAAS)** ## SCIM API **(PREMIUM SAAS)**
GitLab provides an [SCIM API](scim.md) that both implements GitLab provides an [SCIM API](scim.md) that both implements
[the RFC7644 protocol](https://tools.ietf.org/html/rfc7644) and provides the [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644) and provides the
...@@ -29,7 +31,7 @@ GitLab provides an [SCIM API](scim.md) that both implements ...@@ -29,7 +31,7 @@ GitLab provides an [SCIM API](scim.md) that both implements
## GraphQL API ## GraphQL API
A [GraphQL](graphql/index.md) API is available in GitLab. A [GraphQL API](graphql/index.md) is available in GitLab.
With GraphQL, you can make an API request for only what you need, With GraphQL, you can make an API request for only what you need,
and it's versioned by default. and it's versioned by default.
......
...@@ -4,9 +4,9 @@ group: Ecosystem ...@@ -4,9 +4,9 @@ group: Ecosystem
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
--- ---
# API resources **(FREE)** # REST API resources **(FREE)**
Available resources for the [GitLab API](README.md) can be grouped in the following contexts: Available resources for the [GitLab REST API](README.md) can be grouped in the following contexts:
- [Projects](#project-resources). - [Projects](#project-resources).
- [Groups](#group-resources). - [Groups](#group-resources).
......
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