summaryrefslogtreecommitdiff
path: root/doc/api/openapi/openapi_interactive.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/openapi/openapi_interactive.md')
-rw-r--r--doc/api/openapi/openapi_interactive.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/api/openapi/openapi_interactive.md b/doc/api/openapi/openapi_interactive.md
index 95d7bba8081..e34b003e32c 100644
--- a/doc/api/openapi/openapi_interactive.md
+++ b/doc/api/openapi/openapi_interactive.md
@@ -10,19 +10,27 @@ Introduces the interactive documentation tool for the GitLab API.
## 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
-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
-list demonstrates the functionality of the tool.
+<!--
+The following link is absolute rather than relative because it needs to be viewed through the GitLab
+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)
## 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.
![API viewer screenshot](img/apiviewer04-fs8.png)