mod-fqm-manager.yaml

openapi: 3.0.0
info:
  title: mod-fqm-manager API
  version: v1
  description: mod-fqm-manager API

servers:
  - url: https://folio-etesting-snapshot-kong.ci.folio.org/

paths:
  /entity-types:
    get:
      operationId: getEntityTypeSummary
      tags:
        - entityTypes
      description: Get names for a list of entity type ids.
      parameters:
        - $ref: '#/components/parameters/entity-type-ids'
        - $ref: '#/components/parameters/include-inaccessible'
        - $ref: '#/components/parameters/include-all'
      responses:
        '200':
          description: 'Entity type summaries'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entityTypeSummaries'
        '4XX':
          $ref: '#/components/responses/badRequestResponse'

  /query/purge:
    post:
      operationId: deleteOldQueries
      tags:
        - purgeQuery
      description: Deletes all queries that are older than the configured duration.
      responses:
        '200':
          description: 'IDs of deleted queries.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/purgedQueries'
        '4XX':
          $ref: '#/components/responses/badRequestResponse'

  /entity-types/materialized-views/refresh:
    post:
      operationId: refreshData
      tags:
        - materializedViews
      description: Refresh all materialized views and similar data for a tenant.
      responses:
        '200':
          description: 'Data refreshed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataRefreshResponse'
        '4XX':
          $ref: '#/components/responses/badRequestResponse'

  /entity-types/install:
    post:
      operationId: installEntityTypes
      tags:
        - entityTypes
      description: Create database views and install entity types for a tenant.
      parameters:
        - $ref: '#/components/parameters/force-recreate-views'
      responses:
        '204':
          description: 'Entity types installed'

  /fqm/version:
    get:
      operationId: getFqmVersion
      tags:
        - fqmVersion
      description: Get version of the fqm.
      responses:
        '200':
          description: 'Version of the fqm'
          content:
            text/plain:
              schema:
                type: string
        '4XX':
          $ref: '#/components/responses/badRequestResponse'

  /fqm/migrate:
    post:
      summary: fqm migrate request
      operationId: fqmMigrate
      tags:
        - fqmVersion
      requestBody:
        description: 'Request for FQM version submitted successfully'
        required: true
        content:
          application/json:
            schema:
              description: Mapped to schema in folio-query-tool-metadata
              type: object
              format: FqmMigrateRequest
      responses:
        '200':
          description: 'FQM version updated successfully'
          content:
            application/json:
              schema:
                description: Mapped to schemas in folio-query-tool-metadata
                type: object
                format: FqmMigrateResponse
        '4XX':
          $ref: '#/components/responses/badRequestResponse'

  /fqm/status:
    get:
      operationId: getQueryStatusSummaries
      tags:
        - fqlQuery
      description: Get the status and statistics for all running queries
      responses:
        '200':
          description: 'Status and statistics for all running queries'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/queryStatusSummaries'

components:
  parameters:
    entity-type-id:
      name: entity-type-id
      in: path
      required: true
      description: Name of the derived table
      schema:
        type: string
        format: UUID
    entity-type-ids:
      name: ids
      in: query
      required: false
      description: List of entity type ids
      schema:
        type: array
        items:
          type: string
          format: UUID
    include-inaccessible:
      name: includeInaccessible
      in: query
      required: false
      description: Include inaccessible entity types in the result
      schema:
        type: boolean
    include-all:
      name: includeAll
      in: query
      required: false
      description: Include all the entity types regardless of being private
      schema:
        type: boolean
    force-recreate-views:
      name: forceRecreateViews
      in: query
      required: false
      description: Force recreation of views even if they already exist
      schema:
        type: boolean
  schemas:
    errorResponse:
      $ref: schemas/error.json
    contents:
      type: array
      items:
        $ref: '#/components/schemas/contentItem'
    contentItem:
      type: object
      additionalProperties:
        type: object
    entityTypeSummaries:
      $ref: schemas/EntityTypeSummaries.json
    purgedQueries:
      $ref: schemas/PurgedQueries.json
    dataRefreshResponse:
      type: object
      properties:
        successfulRefresh:
          type: array
          items:
            type: string
        failedRefresh:
          type: array
          items:
            type: string
    queryStatusSummaries:
      type: array
      items:
        $ref: '#/components/schemas/queryStatusSummary'
    queryStatusSummary:
      $ref: schemas/QueryStatusSummary.json

  responses:
    badRequestResponse:
      description: Invalid request
      content:
        application/json:
          example:
            message: Entity type ID 6c611396-b6bc-56a7-aada-3a90683d559c was not found
            code: entity.type.not.found
          schema:
            $ref: '#/components/schemas/errorResponse'