openapi: 3.2.0
info:
  title: Folio Inventory API
  version: v1
  description: 'Operations tagged Inventory across 2 of this provider''s published API definitions: folio-edge-inventory-openapi.json, folio-edge-inventory-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /inventory
tags:
- name: Inventory
paths:
  /inventory/instances:
    get:
      operationId: getInstancesByQuery
      summary: Retrieve inventory instances associated with the keyword query from folio…
      description: Retrieve inventory instances associated with the keyword query
      parameters:
      - $ref: '#/components/parameters/x-okapi-tenant-header'
      - $ref: '#/components/parameters/x-okapi-token-header'
      - $ref: '#/components/parameters/request-query-parameters'
      responses:
        '200':
          description: 'Calls the mod-inventory GET /inventory/instances API and returns the result as-is. \

            The example of response: https://github.com/folio-org/mod-inventory/blob/master/ramls/examples/instances_get.json

            '
          content:
            application/json:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      tags:
      - Inventory
    servers:
    - url: /inventory
  /inventory/authorities:
    get:
      operationId: getAuthoritiesByQuery
      summary: Retrieve authorities associated with the keyword query from folio…
      description: Retrieve authorities associated with the keyword query
      parameters:
      - $ref: '#/components/parameters/x-okapi-tenant-header'
      - $ref: '#/components/parameters/x-okapi-token-header'
      - $ref: '#/components/parameters/request-query-parameters'
      responses:
        '200':
          description: 'Calls the mod-entities-links GET /authority-storage/authorities API and returns the result as-is. \

            The example of response: https://github.com/folio-org/mod-inventory/blob/master/ramls/examples/instances_get.json

            '
          content:
            application/json:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/badRequestResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      tags:
      - Inventory
    servers:
    - url: /inventory
  /inventory/download-authority/{authorityId}:
    get:
      description: Download single authority record by id in specified format
      operationId: downloadAuthorityById
      parameters:
      - $ref: '#/components/parameters/authority-id'
      - $ref: '#/components/parameters/suppress999ff'
      - $ref: '#/components/parameters/x-okapi-tenant-header'
      - $ref: '#/components/parameters/x-okapi-token-header'
      - name: utf
        in: query
        description: Specify whether to encode the file in UTF-8.
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: A file download in binary format
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      tags:
      - Inventory
      summary: Download authority by id
      x-summary-source: derived
    servers:
    - url: /inventory
  /inventory/download-instance/{instanceId}:
    get:
      description: Download single instance record by id in specified format
      operationId: downloadInstanceById
      parameters:
      - $ref: '#/components/parameters/instance-id'
      - $ref: '#/components/parameters/x-okapi-tenant-header'
      - $ref: '#/components/parameters/x-okapi-token-header'
      - name: utf
        in: query
        description: Specify whether to encode the file in UTF-8.
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: A file download in binary format
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          $ref: '#/components/responses/notFoundResponse'
        '500':
          $ref: '#/components/responses/internalServerErrorResponse'
      tags:
      - Inventory
      summary: Download instance by id
      x-summary-source: derived
    servers:
    - url: /inventory
components:
  schemas:
    RequestQueryParameters:
      type: object
      properties:
        query:
          type: string
          description: A CQL query string with search conditions.
          minLength: 1
        limit:
          type: integer
          description: Limit the number of elements returned in the response
          maximum: 2147483647
          minimum: 0
          default: 10
        offset:
          type: integer
          description: Skip over a number of elements by specifying an offset value for the query
          maximum: 2147483647
          minimum: 0
          default: 0
        lang:
          type: string
          description: Requested language
          default: en
          pattern: '[a-zA-Z]{2}'
        expand:
          type: string
          description: Whether or not to expand the id fields
    Error:
      type: object
      properties:
        code:
          description: Error status code
          type: integer
        errorMessage:
          description: Error message text
          type: string
  parameters:
    suppress999ff:
      name: suppress999ff
      in: query
      description: Specify whether to suppress 999ff field.
      required: false
      schema:
        type: boolean
        default: false
    x-okapi-token-header:
      name: x-okapi-token
      in: header
      description: x-okapi-token header value
      required: false
      schema:
        type: string
    authority-id:
      name: authorityId
      in: path
      description: Authority's UUID
      required: true
      schema:
        type: string
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
    instance-id:
      name: instanceId
      in: path
      description: Inventory Instance's UUID
      required: true
      schema:
        type: string
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
    request-query-parameters:
      name: requestQueryParameters
      in: query
      description: Request query parameters(query, limit, offset and etc.) as object.
      schema:
        $ref: '#/components/schemas/RequestQueryParameters'
    x-okapi-tenant-header:
      name: x-okapi-tenant
      in: header
      description: x-okapi-tenant header value
      required: false
      schema:
        type: string
  responses:
    internalServerErrorResponse:
      description: When unhandled exception occurred during code execution, e.g. NullPointerException
      content:
        application/json:
          example:
            code: 500
            errorMessage: internal error
          schema:
            $ref: '#/components/schemas/Error'
    notFoundResponse:
      description: Item with a given ID not found
      content:
        application/json:
          example:
            code: 404
            errorMessage: Record by given id not found
          schema:
            $ref: '#/components/schemas/Error'
    badRequestResponse:
      description: Validation errors
      content:
        application/json:
          example:
            code: 400
            errorMessage: Validation error
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- folio-edge-inventory-openapi.json
- folio-edge-inventory-openapi.yml