changes.openapi.yaml

openapi: 3.0.3
info:
  title: 'backstage-plugin-changes-backend'
  version: '1'
  description: The Backstage backend plugin that provides the Changes API
  contact: {}
servers:
  - url: /
  - url: changes
components:
  examples: {}
  headers: {}
  parameters:
    limit:
      name: limit
      in: query
      description: Number of records to return in the response.
      required: false
      allowReserved: true
      schema:
        type: integer
        minimum: 0
    cursor:
      name: cursor
      in: query
      description: Cursor to a set page of results.
      required: false
      allowReserved: true
      schema:
        type: string
        minLength: 1
    after:
      name: after
      in: query
      description: Pointer to the previous page of results.
      required: false
      allowReserved: true
      schema:
        type: string
        minLength: 1
  requestBodies: {}
  responses:
    ErrorResponse:
      description: An error response from the backend.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            name:
              type: string
            message:
              type: string
            stack:
              type: string
            code:
              type: string
          required:
            - name
            - message
        request:
          type: object
          properties:
            method:
              type: string
            url:
              type: string
          required:
            - method
            - url
        response:
          type: object
          properties:
            statusCode:
              type: number
          required:
            - statusCode
      required:
        - error
        - response
      additionalProperties: {}
    Change:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        title:
          type: string
        status:
          type: string
          enum: ['Open', 'Merged', 'Pre-release', 'Released']
      required:
        - id
        - url
        - title
        - status
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT

paths:
  /changes:
    get:
      operationId: GetChanges
      description: Get all changes.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Change'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - {}
        - JWT: []
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/after'
        - $ref: '#/components/parameters/cursor'
        - name: order
          in: query
          allowReserved: true
          required: false
          schema:
            type: array
            items:
              type: string