openapi: 3.2.0
info:
  title: Folio Visible Patron Field Configuration API
  version: v1
  description: 'Operations tagged visible-patron-field-configuration across 2 of this provider''s published API definitions: folio-mod-inn-reach-settings-openapi.json, folio-mod-inn-reach-settings-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /inn-reach/
tags:
- name: visible-patron-field-configuration
paths:
  /central-servers/{centralServerId}/visible-patron-field-configuration:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visiblePatronFieldConfigurationDTO'
        '404':
          $ref: '#/components/responses/trait_response_404'
        '500':
          $ref: '#/components/responses/trait_response_500'
      description: Get Visible Patron Field Configuration by Central Server id
      operationId: getConfigurationByCentralServerId
      tags:
      - visible-patron-field-configuration
      parameters:
      - $ref: '#/components/parameters/centralServerId'
      summary: Get configuration by central server id
      x-summary-source: derived
    put:
      responses:
        '204':
          description: No content
        '400':
          $ref: '#/components/responses/trait_response_validation_400'
        '404':
          $ref: '#/components/responses/trait_response_404'
        '500':
          $ref: '#/components/responses/trait_response_500'
      description: Update Visible Patron Field Configuration
      operationId: updateConfiguration
      tags:
      - visible-patron-field-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/visiblePatronFieldConfigurationDTO'
      parameters:
      - $ref: '#/components/parameters/centralServerId'
      summary: Update configuration
      x-summary-source: derived
    post:
      description: Add new Visible Patron Field Configuration associated with the central server
      operationId: createConfiguration
      tags:
      - visible-patron-field-configuration
      responses:
        '201':
          description: Visible Patron Field Configuration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/visiblePatronFieldConfigurationDTO'
        '400':
          $ref: '#/components/responses/trait_response_validation_400'
        '500':
          $ref: '#/components/responses/trait_response_500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/visiblePatronFieldConfigurationDTO'
        required: true
      parameters:
      - $ref: '#/components/parameters/centralServerId'
      summary: Create configuration
      x-summary-source: derived
    servers:
    - url: /inn-reach/
components:
  schemas:
    validationErrorDTO:
      description: Validation error
      type: object
      properties:
        fieldName:
          type: string
          description: Field name
        message:
          type: string
          description: Validation error message text
      additionalProperties: false
      required:
      - fieldName
      - message
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message text
        type:
          type: string
          description: Error message type
        code:
          type: string
          description: Error message code
      additionalProperties: false
      required:
      - message
    validationErrorsDTO:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        validationErrors:
          type: array
          items:
            $ref: '#/components/schemas/validationErrorDTO'
    visiblePatronFieldConfigurationDTO:
      description: Visible Patron Field Configuration
      type: object
      properties:
        id:
          description: Visible Patron Field Configuration id
          type: string
          format: UUID
        fields:
          description: An array of Visible Patron Fields
          type: array
          items:
            $ref: '#/components/schemas/visiblePatronFieldEnum'
        userCustomFields:
          description: An array of User Custom Fields refIds
          type: array
          items:
            type: string
        metadata:
          description: Entity metadata
          type: object
          $ref: '#/components/schemas/metadata'
      additionalProperties: false
    visiblePatronFieldEnum:
      $schema: http://json-schema.org/draft-04/schema#
      title: Visible Patron Field enum
      description: Visible Patron Field enum
      type: string
      additionalProperties: false
      enum:
      - BARCODE
      - EXTERNAL_SYSTEM_ID
      - FOLIO_RECORD_NUMBER
      - USERNAME
      - USER_CUSTOM_FIELDS
    metadata:
      title: Metadata Schema
      description: Metadata about creation and changes to records, provided by the server (client should not provide)
      type: object
      properties:
        createdDate:
          description: Date and time when the record was created
          type: string
          format: date-time
        createdByUserId:
          description: ID of the user who created the record (when available)
          type: string
          pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
        createdByUsername:
          description: Username of the user who created the record (when available)
          type: string
        updatedDate:
          description: Date and time when the record was last updated
          type: string
          format: date-time
        updatedByUserId:
          description: ID of the user who last updated the record (when available)
          type: string
          pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
        updatedByUsername:
          description: Username of the user who last updated the record (when available)
          type: string
      additionalProperties: false
      required:
      - createdDate
  responses:
    trait_response_404:
      description: Item not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    trait_response_validation_400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/validationErrorsDTO'
    trait_response_500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    centralServerId:
      name: centralServerId
      in: path
      required: true
      schema:
        type: string
        format: uuid
x-refined-from:
- folio-mod-inn-reach-settings-openapi.json
- folio-mod-inn-reach-settings-openapi.yml