GitLab Packages: RubyGem API

openapi: 3.2.0
info:
  title: 'GitLab REST Packages: RubyGem 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: 'Packages: RubyGem'
  description: 'Use this API to interact with the Ruby gems and Bundler package manager clients.


    > [!warning]

    > This API is used by the Ruby gems and Bundler package manager clients and is generally not meant

    > for manual consumption. This API is under development and is not ready for production use due to

    > limited functionality.


    These endpoints do not adhere to the standard API authentication methods.

    See the Ruby gems registry documentation

    for details on which headers and token types are supported. Undocumented authentication methods might be removed in the future.'
  x-displayName: 'Packages: RubyGem'
  externalDocs:
    url: https://docs.gitlab.com/api/packages/rubygems/
paths:
  /api/v4/projects/{id}/packages/rubygems/{file_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesRubygemsFileName
      summary: Download the spec index file
      description: Downloads a RubyGems spec index file (specs.4.8.gz, latest_specs.4.8.gz, or prerelease_specs.4.8.gz) for a project.
      tags:
      - 'Packages: RubyGem'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: file_name
        required: true
        description: Name of the spec file.
        schema:
          type: string
          enum:
          - specs.4.8.gz
          - latest_specs.4.8.gz
          - prerelease_specs.4.8.gz
          minLength: 1
        in: path
  /api/v4/projects/{id}/packages/rubygems/quick/Marshal.4.8/{file_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesRubygemsQuickMarshal48FileName
      summary: Download a gemspec file
      description: Downloads a gemspec file in Marshal format for a specified gem version.
      tags:
      - 'Packages: RubyGem'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: file_name
        required: true
        description: Name of the gemspec file, in the format `<gem_name>-<version>.gemspec.rz`.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/rubygems/gems/{file_name}:
    get:
      operationId: getApiV4ProjectsIdPackagesRubygemsGemsFileName
      summary: Download a gem file
      description: Downloads a specified gem file for a project.
      tags:
      - 'Packages: RubyGem'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: file_name
        required: true
        description: Name of the `.gem` file.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/rubygems/api/v1/gems/authorize:
    post:
      operationId: postApiV4ProjectsIdPackagesRubygemsApiV1GemsAuthorize
      summary: Authorize a gem upload from workhorse
      description: This feature was introduced in GitLab 13.9
      tags:
      - 'Packages: RubyGem'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
  /api/v4/projects/{id}/packages/rubygems/api/v1/gems:
    post:
      operationId: postApiV4ProjectsIdPackagesRubygemsApiV1Gems
      summary: Upload a gem
      description: Uploads a gem for a specified project.
      tags:
      - 'Packages: RubyGem'
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdPackagesRubygemsApiV1GemsRequest'
  /api/v4/projects/{id}/packages/rubygems/api/v1/dependencies:
    get:
      operationId: getApiV4ProjectsIdPackagesRubygemsApiV1Dependencies
      summary: Retrieve dependencies
      description: Retrieves a list of dependencies for specified gems. The response is a marshalled array of hashes for all versions of the requested gems. Because the response is marshalled, you can store it in a file.
      tags:
      - 'Packages: RubyGem'
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: integer
          - type: string
        in: path
      - name: gems
        required: false
        description: Comma-separated list of gems to fetch dependencies for.
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        in: query
        style: form
        explode: false
components:
  schemas:
    postApiV4ProjectsIdPackagesRubygemsApiV1GemsRequest:
      type: object
      properties:
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The package file to be published (generated by Multipart middleware)
      required:
      - file
  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