openapi: 3.2.0
info:
  title: Folio Tenant API
  version: '1.0'
  description: 'Operations tagged tenant across 3 of this provider''s published API definitions: folio-mod-workflow-openapi-openapi.json, folio-folio-spring-support-tenant-openapi.yml, folio-mod-workflow-openapi-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:9000
  description: Generated server url
tags:
- name: Tenant
  description: the tenant API
paths:
  /_/tenant:
    post:
      tags:
      - Tenant
      description: Create tenant job (create, upgrade, delete)
      operationId: postTenant
      parameters:
      - name: tenant
        in: query
        required: true
        schema:
          type: string
      - name: accept
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenantAttributes'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                type: string
        '204':
          description: Job completed
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
            text/plain:
              schema:
                $ref: '#/components/schemas/errors'
        '500':
          description: Internal server error
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
            application/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
      summary: Post tenant
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
  /_/tenant/{operationId}:
    get:
      tags:
      - Tenant
      description: Does tenant id already exist
      operationId: getTenant
      parameters:
      - name: operationId
        in: path
        description: Operation ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: true or false indicator
          content:
            text/plain:
              schema:
                type: string
        '204':
          description: No Content
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '400':
          description: Bad Request
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
      summary: Get tenant
      x-summary-source: derived
    delete:
      tags:
      - Tenant
      description: drop tenant id
      operationId: deleteTenant
      parameters:
      - name: operationId
        in: path
        description: Operation ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: Delete succeeded
        '400':
          description: Bad request
        '404':
          description: Not Found
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
        '500':
          description: Internal server error
          content:
            text/plain:
              schema:
                type: string
      summary: Delete tenant
      x-summary-source: derived
    parameters:
    - name: operationId
      in: path
      required: true
      schema:
        type: string
      description: Operation ID
    servers:
    - url: http://localhost:9000
      description: Generated server url
components:
  schemas:
    parameter:
      type: object
      description: Key/value parameter
      properties:
        key:
          type: string
          description: The key for this parameter
        value:
          type: string
          description: The value of this parameter
      required:
      - key
    tenantAttributes:
      type: object
      description: Configuration how to install, upgrade or delete a module for a tenant
      properties:
        module_from:
          type: string
          description: Existing module ID. If omitted, the module is not enabled already
        module_to:
          type: string
          description: Target module ID. If omitted, the existing module is disabled
        purge:
          type: boolean
          description: On disable should data also be purged
        parameters:
          type: array
          description: List of key/value parameters
          items:
            $ref: '#/components/schemas/parameter'
    Error:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
        code:
          type: string
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
      required:
      - message
    ResponseErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        total_records:
          type: integer
          format: int32
    Parameter:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    error:
      type: object
      description: An error message
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          type: array
          description: List of key/value parameters
          items:
            $ref: '#/components/schemas/parameter'
      required:
      - message
    errors:
      type: object
      description: A set of error messages
      properties:
        errors:
          type: array
          description: List of error messages
          items:
            $ref: '#/components/schemas/error'
        total_records:
          type: integer
          format: int32
          description: Total number of errors
    tenantAttributes_2:
      type: object
      title: Tenant job attributes
      description: Configuration how to install, upgrade or delete a module for a tenant
      properties:
        module_from:
          type: string
          description: Existing module ID. If omitted, the module is not enabled already
        module_to:
          type: string
          description: Target module ID. If omitted, the existing module is disabled
        purge:
          type: boolean
          description: On disable should data also be purged
          default: true
        parameters:
          $ref: '#/components/schemas/parameters'
          description: Parameters that controls what tenant init (eg reference data)
    error_2:
      type: object
      description: An error message
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
        parameters:
          $ref: '#/components/schemas/parameters'
          description: Error message parameters
      required:
      - message
    parameters:
      type: object
      description: List of key/value parameters
      items:
        $ref: '#/components/schemas/parameter'
    errors_2:
      type: object
      description: A set of error messages
      properties:
        errors:
          type: array
          description: List of error messages
          items:
            $ref: '#/components/schemas/error_2'
        total_records:
          type: integer
          description: Total number of errors
  examples:
    tenantAttributesForEnable:
      summary: Enabling module for tenant
      value:
        module_to: mod-sample-1.3.1
        parameters:
        - key: loadReference
          value: true
    tenantAttributesForDisable:
      summary: Disabling module for tenant
      value:
        module_from: mod-sample-1.0.2
        purge: false
    tenantAttributesForUpgrade:
      summary: Upgrading module for tenant
      value:
        module_to: mod-sample-1.3.1
        module_from: mod-sample-1.0.2
        parameters:
        - key: loadReference
          value: true
        - key: loadSample
          value: true
  responses:
    trait_validate_422:
      description: Validation errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors_2'
          examples:
            response:
              value:
                errors:
                - message: may not be null
                  type: 1
                  code: -1
                  parameters:
                  - key: moduleTo
                    value: null
x-refined-from:
- folio-mod-workflow-openapi-openapi.json
- folio-folio-spring-support-tenant-openapi.yml
- folio-mod-workflow-openapi-openapi.yml