openapi: 3.0.1
info:
  x-logo:
    url: https://www.gridgain.com/assets/web/images/gridgain-logo-2021.svg
    backgroundColor: '#FFFFFF'
    altText: Example logo
  title: GridGain REST module authentication upgrade API
  contact:
    email: user@ignite.apache.org
  license:
    name: Apache 2.0
    url: https://ignite.apache.org
  version: 9.1.22
servers:
- url: http://localhost:10300
  description: Default GridGain 9 management API
- url: http://localhost:8080/ignite
  description: GridGain 8 / Ignite REST API
security:
- bearerToken: []
- basicAuth: []
tags:
- name: upgrade
paths:
  /management/v1/upgrade/cancel:
    post:
      tags:
      - upgrade
      summary: Cancel upgrade
      description: Cancel the rolling upgrade
      operationId: cancelUpgrade
      responses:
        '200':
          description: Upgrade successfully canceled.
          content:
            application/json:
              schema:
                type: boolean
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Missing license error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /management/v1/upgrade/commit:
    post:
      tags:
      - upgrade
      summary: Commit upgrade
      description: Commit the rolling upgrade
      operationId: commitUpgrade
      responses:
        '200':
          description: Upgrade successfully commited.
          content:
            application/json:
              schema:
                type: boolean
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Missing license error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /management/v1/upgrade/start:
    post:
      tags:
      - upgrade
      summary: Start upgrade
      description: Starts the rolling upgrade
      operationId: startUpgrade
      requestBody:
        content:
          application/json:
            schema:
              required:
              - version
              type: object
              properties:
                version:
                  type: string
                  description: The version to upgrade.
        required: true
      responses:
        '200':
          description: Upgrade successfully started.
          content:
            application/json:
              schema:
                type: boolean
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Missing license error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /management/v1/upgrade/state:
    get:
      tags:
      - upgrade
      summary: Upgrade state
      description: Current state of the rolling upgrade
      operationId: upgradeState
      responses:
        '200':
          description: Successfully retrieved state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeStateResponse'
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Missing license error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Problem:
      type: object
      properties:
        title:
          type: string
          description: Short summary of the issue.
        status:
          type: integer
          description: Returned HTTP status code.
          format: int32
        code:
          type: string
          description: Ignite 3 error code.
        type:
          type: string
          description: URI to documentation regarding the issue.
        detail:
          type: string
          description: Extended explanation of the issue.
        node:
          type: string
          description: Name of the node the issue happened on.
        traceId:
          type: string
          description: Unique issue identifier. This identifier can be used to find logs related to the issue.
          format: uuid
        invalidParams:
          type: array
          description: A list of parameters that did not pass validation and the reason for it.
          items:
            $ref: '#/components/schemas/InvalidParam'
      description: Extended description of the problem with the request.
    InvalidParam:
      type: object
      properties:
        name:
          type: string
          description: Parameter name.
        reason:
          type: string
          description: The issue with the parameter.
      description: Information about invalid request parameter.
    UpgradeStateResponse:
      required:
      - currentVersion
      - currentVersionNodes
      - nextVersion
      - nextVersionNodes
      type: object
      properties:
        currentVersion:
          type: string
          description: Current cluster version.
        nextVersion:
          type: string
          description: Next cluster version.
        currentVersionNodes:
          type: array
          description: Current cluster version nodes.
          items:
            type: string
        nextVersionNodes:
          type: array
          description: Next cluster version nodes.
          items:
            type: string
      description: Cluster Upgrade State.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerToken:
      type: http
      scheme: bearer