openapi: 3.2.0
info:
  title: Folio Tenant Controller API
  version: v0
  description: 'Operations tagged tenant-controller across 4 of this provider''s published API definitions: folio-mod-camunda-openapi-openapi.json, folio-mod-workflow-openapi-openapi.json, folio-mod-camunda-openapi-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-controller
paths:
  /_/tenant:
    post:
      tags:
      - tenant-controller
      operationId: create
      parameters:
      - name: accept
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tenant:
                  type: string
                attributes:
                  $ref: '#/components/schemas/TenantAttributes'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              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:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Create
      x-summary-source: derived
    delete:
      tags:
      - tenant-controller
      operationId: delete
      parameters:
      - name: accept
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: OK
        '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:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ResponseErrors'
      summary: Delete
      x-summary-source: derived
    servers:
    - url: http://localhost:9000
      description: Generated server url
components:
  schemas:
    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:
      required:
      - message
      type: object
      properties:
        message:
          type: string
        type:
          type: string
        code:
          type: string
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
    TenantAttributes:
      type: object
      properties:
        moduleTo:
          type: string
        moduleFrom:
          type: string
    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
      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
x-refined-from:
- folio-mod-camunda-openapi-openapi.json
- folio-mod-workflow-openapi-openapi.json
- folio-mod-camunda-openapi-openapi.yml
- folio-mod-workflow-openapi-openapi.yml