GitLab Suggestions API

openapi: 3.2.0
info:
  title: GitLab REST Suggestions API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Suggestions
  description: 'Use this API to manage code suggestions.


    Suggestions provide a way to propose specific changes that can be directly applied to the code.

    You can programmatically create and apply code suggestions in merge request discussions with

    this API. Every API call to suggestions must be authenticated.'
  x-displayName: Suggestions
  externalDocs:
    url: https://docs.gitlab.com/api/suggestions/
paths:
  /api/v4/suggestions/{id}/apply:
    put:
      operationId: putApiV4SuggestionsIdApply
      summary: Apply a suggestion to a merge request
      description: Applies a suggested patch in a merge request. You must have the Developer, Maintainer, or Owner role.
      tags:
      - Suggestions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSuggestion'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the suggestion.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4SuggestionsIdApplyRequest'
  /api/v4/suggestions/batch_apply:
    put:
      operationId: putApiV4SuggestionsBatchApply
      summary: Apply multiple suggestions to a merge request
      description: Applies multiple suggested patches in a merge request. You must have the Developer, Maintainer, or Owner role.
      tags:
      - Suggestions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesSuggestion'
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4SuggestionsBatchApplyRequest'
components:
  schemas:
    APIEntitiesSuggestion:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        from_line:
          type: integer
          example: 1
        to_line:
          type: integer
          example: 1
        appliable:
          type: boolean
          example: true
        applied:
          type: boolean
          example: false
        from_content:
          type: string
          example: 'Original content

            '
        to_content:
          type: string
          example: 'New content

            '
    putApiV4SuggestionsBatchApplyRequest:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: integer
          description: IDs of suggestions to apply.
        commit_message:
          type:
          - string
          - 'null'
          description: Custom commit message to use instead of the default generated message or the project's default message.
      required:
      - ids
    putApiV4SuggestionsIdApplyRequest:
      type: object
      properties:
        commit_message:
          type:
          - string
          - 'null'
          description: Custom commit message to use instead of the default generated message or the project's default message.
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header