openapi: 3.2.0
info:
  title: Folio Related Users API
  version: v1
  description: 'Operations tagged Related Users across 2 of this provider''s published API definitions: folio-mod-data-export-openapi.json, folio-mod-data-export-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /data-export/
tags:
- name: Related Users
paths:
  /related-users:
    get:
      description: Get only users who have ever started export
      operationId: getRelatedUsers
      responses:
        '200':
          description: Related user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/relatedUserCollection'
              example:
                relatedUsers:
                - firstName: John
                  lastName: Doe
                  userId: 6b380aa8-4070-4497-a466-22345fde64c0
                totalRecords: 1
        '404':
          description: Not Found
          content:
            text/plain:
              example: Related users not found
        '500':
          description: Internal server errors, e.g. due to misconfiguration
          content:
            text/plain:
              example: Internal server error
      tags:
      - Related Users
      summary: Get related users
      x-summary-source: derived
    servers:
    - url: /data-export/
components:
  schemas:
    relatedUserCollection:
      $schema: http://json-schema.org/draft-04/schema#
      description: Collection of related users
      type: object
      additionalProperties: false
      properties:
        relatedUsers:
          description: List of related users
          type: array
          id: relatedUsersList
          items:
            type: object
            $ref: '#/components/schemas/relatedUser'
        totalRecords:
          type: integer
    relatedUser:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Related user who have ever started export
      properties:
        firstName:
          description: First name
          type: string
        lastName:
          description: Last name
          type: string
        userId:
          description: User id
          type: string
x-refined-from:
- folio-mod-data-export-openapi.json
- folio-mod-data-export-openapi.yml