openapi: 3.2.0
info:
  title: Folio Consortia API
  version: 0.0.1
  description: 'Operations tagged Consortia across 3 of this provider''s published API definitions: folio-mod-consortia-keycloak-consortia-openapi.json, folio-mod-consortia-keycloak-consortia-openapi.yml, folio-mod-consortia-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Consortia
paths:
  /consortia:
    get:
      summary: Get consortium collection
      operationId: getConsortiumCollection
      responses:
        '200':
          $ref: '#/components/responses/ConsortiumCollection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Consortia
    post:
      summary: Save consortium
      operationId: saveConsortium
      responses:
        '201':
          $ref: '#/components/responses/Consortium'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      requestBody:
        $ref: '#/components/requestBodies/ConsortiumBody'
      tags:
      - Consortia
  /consortia/{consortiumId}:
    get:
      summary: Get consortium record based on consortiumId
      operationId: getConsortium
      parameters:
      - $ref: '#/components/parameters/consortiumId'
      responses:
        '200':
          $ref: '#/components/responses/Consortium'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Consortia
    put:
      summary: Update consortium name
      operationId: updateConsortium
      parameters:
      - $ref: '#/components/parameters/consortiumId'
      responses:
        '200':
          $ref: '#/components/responses/Consortium'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      requestBody:
        $ref: '#/components/requestBodies/ConsortiumBody'
      tags:
      - Consortia
components:
  responses:
    ConsortiumCollection:
      description: Collection of Consortium Object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConsortiumCollection'
    Consortium:
      description: Consortium Object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Consortium'
    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'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
  parameters:
    consortiumId:
      in: path
      name: consortiumId
      schema:
        $ref: '#/components/schemas/uuid'
      required: true
      description: The ID of consortium
  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
    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
    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
    ConsortiumCollection:
      type: object
      description: A JSON schema for the Consortium Collection
      properties:
        consortia:
          type: array
          description: The list of consortia
          items:
            type: object
            $ref: '#/components/schemas/Consortium'
        totalRecords:
          type: integer
      additionalProperties: false
      required:
      - consortia
      - totalRecords
    Parameters:
      description: List of key/value parameters of an error
      type: array
      items:
        $ref: '#/components/schemas/Parameter'
      additionalProperties: false
    uuid:
      type: string
      format: uuid
    Consortium:
      type: object
      description: Consortium
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      additionalProperties: false
      required:
      - id
      - name
  requestBodies:
    ConsortiumBody:
      description: Consortium object
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Consortium'
x-refined-from:
- folio-mod-consortia-keycloak-consortia-openapi.json
- folio-mod-consortia-keycloak-consortia-openapi.yml
- folio-mod-consortia-openapi.yml