openapi: 3.2.0
info:
  title: Folio Consortia Configuration API
  version: 0.0.1
  description: 'Operations tagged Consortia Configuration across 3 of this provider''s published API definitions: folio-mod-consortia-keycloak-consortia-configuration-openapi.json, folio-mod-consortia-consortia-configuration-openapi.yml, folio-mod-consortia-keycloak-consortia-configuration-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Consortia Configuration
paths:
  /consortia-configuration:
    get:
      summary: Get consortium configuration
      operationId: getConfiguration
      responses:
        '200':
          $ref: '#/components/responses/ConsortiaConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Consortia Configuration
    post:
      summary: Save consortia configuration
      operationId: saveConfiguration
      responses:
        '201':
          $ref: '#/components/responses/ConsortiaConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      requestBody:
        $ref: '#/components/requestBodies/ConfigurationBody'
      tags:
      - Consortia Configuration
    delete:
      summary: Delete consortia configuration
      operationId: deleteConfiguration
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Consortia Configuration
components:
  responses:
    ConsortiaConfiguration:
      description: Consortia configuration object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConsortiaConfiguration'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NoContent:
      description: No content
    Conflict:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  schemas:
    Error:
      description: An error
      type: object
      properties:
        message:
          type: string
          minLength: 1
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/Parameters'
      additionalProperties: false
      required:
      - message
    ConsortiaConfiguration:
      type: object
      description: Consortia Configuration
      properties:
        id:
          type: string
          format: uuid
        centralTenantId:
          type: string
      additionalProperties: false
      required:
      - centralTenantId
    Parameter:
      description: List of key/value parameters of an error
      type: object
      properties:
        key:
          type: string
          minLength: 1
        value:
          type: string
      additionalProperties: false
      required:
      - key
    Parameters:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
    Errors:
      description: A set of errors
      type: object
      properties:
        errors:
          description: List of errors
          type: array
          items:
            type: object
            $ref: '#/components/schemas/Error'
        total_records:
          description: Total number of errors
          type: integer
      additionalProperties: false
  requestBodies:
    ConfigurationBody:
      description: Consortia configuration object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConsortiaConfiguration'
x-refined-from:
- folio-mod-consortia-keycloak-consortia-configuration-openapi.json
- folio-mod-consortia-consortia-configuration-openapi.yml
- folio-mod-consortia-keycloak-consortia-configuration-openapi.yml