Commit 39a42292 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch 'eread/link-to-rendered-openapi-file' into 'master'

Link to rendered OpenAPI file

See merge request gitlab-org/gitlab!59207
parents 371ed5e8 20ab5b99
...@@ -10,19 +10,27 @@ Introduces the interactive documentation tool for the GitLab API. ...@@ -10,19 +10,27 @@ Introduces the interactive documentation tool for the GitLab API.
## About the OpenAPI specification ## About the OpenAPI specification
The [OpenAPI specification](https://swagger.io/specification/) (formerly called Swagger) defines a standard, language-agnostic interface to RESTful APIs. OpenAPI definition files are written in the YAML format, which is automatically rendered by the GitLab browser into a more human-readable interface. For general information about the GitLab APIs, see [API Docs](../README.md). The [OpenAPI specification](https://swagger.io/specification/) (formerly called Swagger) defines a
standard, language-agnostic interface to RESTful APIs. OpenAPI definition files are written in the
YAML format, which is automatically rendered by the GitLab browser into a more human-readable interface.
For general information about the GitLab APIs, see [API Docs](../README.md).
## Overview ## Overview
The [interactive API documentation tool](openapi.yaml) allows API testing directly on the GitLab.com <!--
website. Only a few of the available endpoints are documented with the OpenAPI spec, but the current The following link is absolute rather than relative because it needs to be viewed through the GitLab
list demonstrates the functionality of the tool. Open API file viewer: https://docs.gitlab.com/ee/user/project/repository/index.html#openapi-viewer.
-->
The [interactive API documentation tool](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml)
allows API testing directly on the GitLab.com website. Only a few of the available endpoints are
documented with the OpenAPI spec, but the current list demonstrates the functionality of the tool.
![API viewer screenshot](img/apiviewer01-fs8.png) ![API viewer screenshot](img/apiviewer01-fs8.png)
## Endpoint parameters ## Endpoint parameters
When you expand an endpoint listing, you'll see a description, input parameters (if required), When you expand an endpoint listing, you see a description, input parameters (if required),
and example server responses. Some parameters include a default or a list of allowed values. and example server responses. Some parameters include a default or a list of allowed values.
![API viewer screenshot](img/apiviewer04-fs8.png) ![API viewer screenshot](img/apiviewer04-fs8.png)
......
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