openapi: 3.2.0
info:
  title: Folio Module Discovery API
  version: v1
  description: 'Operations tagged module-discovery across 2 of this provider''s published API definitions: folio-mgr-applications-am-openapi.json, folio-mgr-applications-am-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:8081
  description: Locally deployed server
tags:
- name: module-discovery
paths:
  /modules/discovery:
    get:
      operationId: searchModuleDiscovery
      description: Retrieving module discovery information by CQL query and pagination parameters.
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/cql-query'
      - $ref: '#/components/parameters/query-offset'
      - $ref: '#/components/parameters/query-limit'
      responses:
        '200':
          description: Module discovery search result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/moduleDiscoveries'
        '400':
          $ref: '#/components/responses/bad-request'
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Search module discovery
      x-summary-source: derived
    post:
      operationId: createModuleDiscoveries
      description: Creates module discovery information in a batch
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/x-okapi-token'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/moduleDiscoveries'
      responses:
        '201':
          description: An application discovery as response body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/moduleDiscoveries'
        '400':
          $ref: '#/components/responses/bad-request'
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Create module discoveries
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
  /modules/{id}/discovery:
    get:
      operationId: getModuleDiscovery
      description: Retrieving discovery for the module referenced by id.
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/path-entity-id'
      responses:
        '200':
          description: A module discovery info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/moduleDiscovery'
        '404':
          $ref: '#/components/responses/entity-not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Get module discovery
      x-summary-source: derived
    post:
      operationId: createModuleDiscovery
      description: Creates a discovery for the module referenced by id.
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/path-entity-id'
      - $ref: '#/components/parameters/x-okapi-token'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/moduleDiscovery'
      responses:
        '201':
          description: A module discovery info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/moduleDiscovery'
        '400':
          $ref: '#/components/responses/bad-request'
        '404':
          $ref: '#/components/responses/entity-not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Create module discovery
      x-summary-source: derived
    put:
      operationId: updateModuleDiscovery
      description: Update discovery for the module referenced by id.
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/path-entity-id'
      - $ref: '#/components/parameters/x-okapi-token'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/moduleDiscovery'
      responses:
        '204':
          description: No content
        '400':
          $ref: '#/components/responses/bad-request'
        '404':
          $ref: '#/components/responses/entity-not-found'
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Update module discovery
      x-summary-source: derived
    delete:
      operationId: deleteModuleDiscovery
      description: Delete discovery of the module referenced by id.
      tags:
      - module-discovery
      parameters:
      - $ref: '#/components/parameters/path-entity-id'
      - $ref: '#/components/parameters/x-okapi-token'
      responses:
        '204':
          description: No content
        '500':
          $ref: '#/components/responses/internal-server-error'
      summary: Delete module discovery
      x-summary-source: derived
    servers:
    - url: http://localhost:8081
      description: Locally deployed server
components:
  responses:
    bad-request:
      description: Error response if request body contains validation error (in json format)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    entity-not-found:
      description: Error response if entity is not found by id (in json format)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
    internal-server-error:
      description: Error response for unhandled or critical server exceptions, e.g. NullPointerException.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errors'
  schemas:
    parameter:
      description: List of key/value parameters of an error
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
    moduleDiscovery:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Module discovery information
      x-implements:
      - org.folio.common.domain.model.Artifact
      allOf:
      - $ref: '#/components/schemas/artifact'
      properties:
        location:
          description: A url address of module where its been deployed
          type: string
      required:
      - location
    parameters:
      description: List of key/value parameters of an error
      $schema: http://json-schema.org/draft-04/schema#
      type: array
      items:
        $ref: '#/components/schemas/parameter'
    errors:
      description: A set of errors
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        errors:
          id: errors
          description: List of errors
          type: array
          items:
            $ref: '#/components/schemas/error'
        total_records:
          description: Total number of errors
          type: integer
    version:
      $schema: http://json-schema.org/draft-04/schema#
      description: A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
      type: string
      pattern: ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*))?(?:\+[\dA-Za-z-]+)?$
    errorCode:
      $schema: http://json-schema.org/draft-04/schema#
      type: string
      description: Error message code
      enum:
      - unknown_error
      - service_error
      - validation_error
      - not_found_error
      - found_error
    artifact:
      $schema: http://json-schema.org/draft-04/schema#
      title: Application Artifact Schema
      description: Artifact Descriptor for Application Manager Installer
      type: object
      properties:
        id:
          description: A Name-Version id for identifying this artifact
          type: string
        name:
          description: Artifact name
          type: string
        version:
          description: The version of an artifact (semantic version approach)
          $ref: '#/components/schemas/version'
      additionalProperties: false
      required:
      - name
      - version
    error:
      description: An error
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          description: Error message code
          $ref: '#/components/schemas/errorCode'
        parameters:
          description: Error message parameters
          $ref: '#/components/schemas/parameters'
    moduleDiscoveries:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Collection of discovery information for modules that comprise an application
      properties:
        discovery:
          description: Discovery information for the modules that comprise this application
          type: array
          id: moduleDiscovery
          items:
            $ref: '#/components/schemas/moduleDiscovery'
        totalRecords:
          readOnly: true
          description: The total number of records matching the provided criteria
          type: integer
          format: int64
      required:
      - discovery
  parameters:
    x-okapi-token:
      name: x-okapi-token
      in: header
      required: false
      description: An OKAPI authentication token
      schema:
        type: string
    query-offset:
      in: query
      required: false
      name: offset
      description: Skip over a number of elements by specifying an offset value for the query.
      schema:
        type: integer
        minimum: 0
        default: 0
    path-entity-id:
      in: path
      required: true
      name: id
      description: Entity/document id
      schema:
        type: string
    query-limit:
      in: query
      required: false
      name: limit
      description: Limit the number of elements returned in the response.
      schema:
        type: integer
        minimum: 0
        maximum: 500
        default: 10
    cql-query:
      name: query
      in: query
      description: A CQL query string with search conditions.
      schema:
        type: string
x-refined-from:
- folio-mgr-applications-am-openapi.json
- folio-mgr-applications-am-openapi.yml