GitLab Submodules API

openapi: 3.2.0
info:
  title: GitLab REST Submodules 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: Submodules
  description: Use this API to update Git submodules.
  x-displayName: Submodules
  externalDocs:
    url: https://docs.gitlab.com/api/repository_submodules/
paths:
  /api/v4/projects/{id}/repository/submodules/{submodule}:
    put:
      operationId: putApiV4ProjectsIdRepositorySubmodulesSubmodule
      summary: Update a submodule reference
      description: Updates a reference for a specified submodule.
      tags:
      - Submodules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesCommitDetail'
        '404':
          description: 404 Project Not Found
        '401':
          description: 401 Unauthorized
        '400':
          description: The repository is empty
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab
      - name: submodule
        required: true
        description: URL-encoded full path to the submodule, for example `lib%2Fclass%2Erb`.
        schema:
          type: string
        in: path
        example: gitlab-org/gitlab-shell
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdRepositorySubmodulesSubmoduleRequest'
components:
  schemas:
    APIEntitiesCommitDetail:
      type: object
      properties:
        id:
          type: string
          example: 2695effb5807a22ff3d138d593fd856244e155e7
        short_id:
          type: string
          example: 2695effb
        created_at:
          type: string
          format: date-time
          example: '2017-07-26T11:08:53.000+02:00'
        parent_ids:
          type: array
          example:
          - 2a4b78934375d7f53875269ffd4f45fd83a84ebe
          items:
            type: string
        title:
          type: string
          example: Initial commit
        message:
          type: string
          example: Initial commit
        author_name:
          type: string
          example: John Smith
        author_email:
          type: string
          example: john@example.com
        authored_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        committer_name:
          type: string
          example: Jack Smith
        committer_email:
          type: string
          example: jack@example.com
        committed_date:
          type: string
          format: date-time
          example: '2012-05-28T04:42:42-07:00'
        trailers:
          type: object
          example:
            Merged-By: Jane Doe janedoe@gitlab.com
        extended_trailers:
          type: object
          example:
            Signed-off-by:
            - John Doe <johndoe@gitlab.com>
            - Jane Doe <janedoe@gitlab.com>
        web_url:
          type: string
          example: https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746
        stats:
          $ref: '#/components/schemas/APIEntitiesCommitStats'
        status:
          type: string
          example: success
        project_id:
          type: integer
          format: int64
          example: 1
        last_pipeline:
          type: object
    putApiV4ProjectsIdRepositorySubmodulesSubmoduleRequest:
      type: object
      properties:
        commit_sha:
          type:
          - string
          - 'null'
          description: Full commit SHA to update the submodule to.
          example: ed899a2f4b50b4370feeea94676502b42383c746
        branch:
          type:
          - string
          - 'null'
          description: Name of the branch to commit into.
          example: main
        commit_message:
          type:
          - string
          - 'null'
          description: Commit message. If omitted, a default message is used.
          example: Commit message
      required:
      - commit_sha
      - branch
    APIEntitiesCommitStats:
      type: object
      properties:
        additions:
          type: integer
          example: 1
        deletions:
          type: integer
          example: 0
        total:
          type: integer
          example: 1
  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