summaryrefslogtreecommitdiff
path: root/doc/api/openapi/openapi.yaml
blob: 8c46804d86fdf55c4f8df76e30f028d9187a2a93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
openapi: "3.0.0"
info:
  description: |
    An OpenAPI definition for the GitLab REST API.
    Only one API resource/endpoint is currently included.
    The intent is to expand this to match the entire Markdown documentation of the API:
    <https://docs.gitlab.com/ee/api/>. Contributions are welcome.

    When viewing this on gitlab.com, you can test API calls directly from the browser
    against the `gitlab.com` instance, if you are logged in.
    The feature uses the current [GitLab session cookie](https://docs.gitlab.com/ee/api/README.html#session-cookie),
    so each request is made using your account.

    Read more at <https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html>.
  version: "v4"
  title: "GitLab API"
  termsOfService: "https://about.gitlab.com/terms/"
  license:
    name: "CC BY-SA 4.0"
    url: "https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE"
servers:
  - url: "https://gitlab.com/api/"

paths:
  /v4/version:
    $ref: "v4/version.yaml"