openapi: 3.2.0
info:
  title: Folio Import API
  version: v1
  description: 'Operations tagged import across 2 of this provider''s published API definitions: folio-mod-linked-data-openapi.json, folio-mod-linked-data-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Import
paths:
  /linked-data/import/file:
    post:
      operationId: import-file
      tags:
      - Import
      description: Imports an uploaded JSON file containing at least one resource
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                  format: binary
      responses:
        '200':
          description: Returns a list of resource IDs and an import activity log
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/importResponseDto'
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      summary: Import file
      x-summary-source: derived
  /linked-data/import/url:
    post:
      operationId: import-url
      tags:
      - Import
      description: Imports from a URL containing at least one resource
      parameters:
      - $ref: '#/components/parameters/importUrl'
      - $ref: '#/components/parameters/defaultWorkType'
      responses:
        '200':
          description: Returns a list of resource IDs and an import activity log
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/importResponseDto'
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      summary: Import url
      x-summary-source: derived
components:
  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
    errors:
      description: A set of errors
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        errors:
          description: List of errors
          id: errors
          type: array
          items:
            type: object
            $ref: '#/components/schemas/error'
        total_records:
          description: Total number of errors
          type: integer
    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:
          type: string
          description: Error message code
        parameters:
          type: object
          description: Error message parameters
          $ref: '#/components/schemas/parameters'
    parameters:
      description: List of key/value parameters of an error
      $schema: http://json-schema.org/draft-04/schema#
      type: array
      items:
        type: object
        $ref: '#/components/schemas/parameter'
    importResponseDto:
      $schema: http://json-schema.org/draft-04/schema#
      description: Responds to an import with a list of imported resources and an activity log
      type: object
      properties:
        resources:
          type: array
          description: A list of resource identifiers successfully imported
          items:
            type: string
        log:
          type: string
          description: An activity log generated during import
      required:
      - resources
      - log
  parameters:
    defaultWorkType:
      name: defaultWorkType
      in: query
      required: true
      description: URI for the default Work type to use when no further Work typing is available
      schema:
        type: string
    importUrl:
      name: url
      in: query
      required: true
      description: URL of a remote Instance resource
      schema:
        type: string
  responses:
    internalServerErrorResponse:
      description: When unhandled exception occurred during code execution, e.g. NullPointerException
      content:
        application/json:
          example: example/unknownError.sample
          schema:
            $ref: '#/components/schemas/errors'
    badRequestResponse:
      description: Validation errors
      content:
        application/json:
          example: examples/validationErrorResponse.sample
          schema:
            $ref: '#/components/schemas/errors'
x-refined-from:
- folio-mod-linked-data-openapi.json
- folio-mod-linked-data-openapi.yml