GitLab Draft notes API

openapi: 3.2.0
info:
  title: GitLab REST Draft notes 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: Draft notes
  description: 'Use this API to manage draft notes. These notes are pending, unpublished comments on merge requests.

    Draft notes can start a discussion, or continue an existing discussion as a reply.


    Before publishing, draft notes are visible only to the author.'
  x-displayName: Draft notes
  externalDocs:
    url: https://docs.gitlab.com/api/draft_notes/
paths:
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes:
    get:
      operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotes
      summary: List all merge request draft notes
      description: Lists all merge request draft notes.
      tags:
      - Draft notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesDraftNote'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
    post:
      operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotes
      summary: Create a draft note
      description: Creates a draft note for a specified merge request.
      tags:
      - Draft notes
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesDraftNote'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesRequest'
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}:
    get:
      operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId
      summary: Retrieve a draft note
      description: Retrieves a draft note for a specified merge request.
      tags:
      - Draft notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesDraftNote'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      - name: draft_note_id
        required: true
        description: ID of the draft note.
        schema:
          type: integer
        in: path
    put:
      operationId: putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId
      summary: Update a draft note
      description: Updates a draft note for a specified merge request.
      tags:
      - Draft notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesDraftNote'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      - name: draft_note_id
        required: true
        description: ID of the draft note.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteIdRequest'
    delete:
      operationId: deleteApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteId
      summary: Delete a draft note
      description: Deletes a draft note for a specified merge request.
      tags:
      - Draft notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesDraftNote'
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      - name: draft_note_id
        required: true
        description: ID of the draft note.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/{draft_note_id}/publish:
    put:
      operationId: putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteIdPublish
      summary: Publish a draft note
      description: Publishes a draft note for a specified merge request.
      tags:
      - Draft notes
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      - name: draft_note_id
        required: true
        description: ID of the draft note.
        schema:
          type: integer
        in: path
  /api/v4/projects/{id}/merge_requests/{merge_request_iid}/draft_notes/bulk_publish:
    post:
      operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesBulkPublish
      summary: Publish all pending draft notes
      description: Publishes all pending draft notes for the current user on the specified merge request. Optionally sets the reviewer state and posts a summary note.
      tags:
      - Draft notes
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: merge_request_iid
        required: true
        description: Internal ID of the merge request.
        schema:
          type: integer
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesBulkPublishRequest'
components:
  schemas:
    APIEntitiesDraftNote:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 2
        author_id:
          type: integer
          format: int64
          example: 4
        merge_request_id:
          type: integer
          format: int64
          example: 52
        resolve_discussion:
          type: boolean
          example: true
        discussion_id:
          type: string
          example: 6a9c1750b37d513a43987b574953fceb50b03ce7
        note:
          type: string
          example: This is a note
        commit_id:
          type: string
          example: 6104942438c14ec7bd21c6cd5bd995272b3faff6
        line_code:
          type: string
          example: 1c497fbb3a46b78edf0_2_4
        position:
          type: object
          example:
            base_sha: aa149113
            start_sha: b3a0a8c4
            head_sha: be3020c7
            old_path: example.md
            new_path: example.md
            position_type: text
            old_line: 2
            new_line: 4
            line_range:
              start:
                line_code: 1c497fbb3a46b78edf04cc2a2fa33f67e3ffbe2a_2_4
                type: null
                old_line: 2
                new_line: 4
              end:
                line_code: 1c497fbb3a46b78edf04cc2a2fa33f67e3ffbe2a_2_4
                type: null
                old_line: 2
                new_line: 4
    postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesRequest:
      type: object
      properties:
        note:
          type:
          - string
          - 'null'
          description: Content of the note.
        in_reply_to_discussion_id:
          type:
          - string
          - 'null'
          description: ID of the discussion the draft note replies to.
        commit_id:
          type:
          - string
          - 'null'
          description: SHA of the commit to associate the draft note with.
        resolve_discussion:
          type:
          - boolean
          - 'null'
          description: If `true`, resolves the associated discussion.
        position:
          type:
          - object
          - 'null'
          description: Position when creating a diff note. If omitted, creates a regular discussion note.
          properties:
            base_sha:
              type:
              - string
              - 'null'
              description: Base commit SHA of the diff.
            start_sha:
              type:
              - string
              - 'null'
              description: SHA of the latest commit in the target branch.
            head_sha:
              type:
              - string
              - 'null'
              description: SHA of the latest commit in the source branch.
            position_type:
              type: string
              enum:
              - text
              - image
              - file
              description: Type of the position reference.
              minLength: 1
            new_path:
              type:
              - string
              - 'null'
              description: File path after the change.
            new_line:
              type:
              - integer
              - 'null'
              description: Line number after the change.
            old_path:
              type:
              - string
              - 'null'
              description: File path before the change.
            old_line:
              type:
              - integer
              - 'null'
              description: Line number before the change.
            width:
              type:
              - integer
              - 'null'
              description: Width of the image.
            height:
              type:
              - integer
              - 'null'
              description: Height of the image.
            x:
              type:
              - integer
              - 'null'
              description: X coordinate in the image.
            y:
              type:
              - integer
              - 'null'
              description: Y coordinate in the image.
            line_range:
              type:
              - object
              - 'null'
              description: Line range for a multi-line note.
              properties:
                start:
                  type:
                  - object
                  - 'null'
                  description: Start line for a multi-line note.
                  properties:
                    line_code:
                      type:
                      - string
                      - 'null'
                      description: Start line code for a multi-line note.
                    type:
                      type:
                      - string
                      - 'null'
                      description: Start line type for a multi-line note.
                    old_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number before the change at the start of the line range.
                    new_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number after the change at the start of the line range.
                end:
                  type:
                  - object
                  - 'null'
                  description: End line for a multi-line note.
                  properties:
                    line_code:
                      type:
                      - string
                      - 'null'
                      description: End line code for a multi-line note.
                    type:
                      type:
                      - string
                      - 'null'
                      description: End line type for a multi-line note.
                    old_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number before the change at the end of the line range.
                    new_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number after the change at the end of the line range.
          required:
          - base_sha
          - start_sha
          - head_sha
          - position_type
      required:
      - note
    postApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesBulkPublishRequest:
      type: object
      properties:
        reviewer_state:
          type:
          - string
          - 'null'
          enum:
          - requested_changes
          - reviewed
          - null
          description: Sets the review state after publishing. Does not record a formal approval.
        note:
          type:
          - string
          - 'null'
          description: Text of the summary note to add to the merge request.
        internal:
          type: boolean
          description: If `true`, the summary note is internal.
          default: false
    putApiV4ProjectsIdMergeRequestsMergeRequestIidDraftNotesDraftNoteIdRequest:
      type: object
      properties:
        note:
          type:
          - string
          - 'null'
          description: Content of the note.
        position:
          type:
          - object
          - 'null'
          description: Position when creating a diff note. If omitted, creates a regular discussion note.
          properties:
            base_sha:
              type:
              - string
              - 'null'
              description: Base commit SHA of the diff.
            start_sha:
              type:
              - string
              - 'null'
              description: SHA of the latest commit in the target branch.
            head_sha:
              type:
              - string
              - 'null'
              description: SHA of the latest commit in the source branch.
            position_type:
              type: string
              enum:
              - text
              - image
              - file
              description: Type of the position reference.
              minLength: 1
            new_path:
              type:
              - string
              - 'null'
              description: File path after the change.
            new_line:
              type:
              - integer
              - 'null'
              description: Line number after the change.
            old_path:
              type:
              - string
              - 'null'
              description: File path before the change.
            old_line:
              type:
              - integer
              - 'null'
              description: Line number before the change.
            width:
              type:
              - integer
              - 'null'
              description: Width of the image.
            height:
              type:
              - integer
              - 'null'
              description: Height of the image.
            x:
              type:
              - integer
              - 'null'
              description: X coordinate in the image.
            y:
              type:
              - integer
              - 'null'
              description: Y coordinate in the image.
            line_range:
              type:
              - object
              - 'null'
              description: Line range for a multi-line note.
              properties:
                start:
                  type:
                  - object
                  - 'null'
                  description: Start line for a multi-line note.
                  properties:
                    line_code:
                      type:
                      - string
                      - 'null'
                      description: Start line code for a multi-line note.
                    type:
                      type:
                      - string
                      - 'null'
                      description: Start line type for a multi-line note.
                    old_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number before the change at the start of the line range.
                    new_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number after the change at the start of the line range.
                end:
                  type:
                  - object
                  - 'null'
                  description: End line for a multi-line note.
                  properties:
                    line_code:
                      type:
                      - string
                      - 'null'
                      description: End line code for a multi-line note.
                    type:
                      type:
                      - string
                      - 'null'
                      description: End line type for a multi-line note.
                    old_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number before the change at the end of the line range.
                    new_line:
                      type:
                      - integer
                      - 'null'
                      description: Line number after the change at the end of the line range.
          required:
          - base_sha
          - start_sha
          - head_sha
          - position_type
  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