openapi: 3.2.0
info:
  title: Folio Tenant Addresses API
  version: v1
  description: 'Operations tagged Tenant Addresses across 2 of this provider''s published API definitions: folio-mod-settings-openapi.json, folio-mod-settings-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Tenant Addresses
paths:
  /tenant-addresses:
    parameters:
    - $ref: '#/components/parameters/okapi-tenant'
    - $ref: '#/components/parameters/query'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/offset'
    get:
      operationId: getTenantAddresses
      responses:
        '200':
          description: The tenant addresses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tenantAddresses'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Tenant Addresses
      summary: Get tenant addresses
      x-summary-source: derived
    post:
      operationId: createTenantAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenantAddress'
      responses:
        '201':
          description: Tenant address created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tenantAddress'
        '400':
          $ref: '#/components/responses/trait_400'
        '422':
          description: Tenant address validation error
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Tenant Addresses
      summary: Create tenant address
      x-summary-source: derived
  /tenant-addresses/{id}:
    parameters:
    - $ref: '#/components/parameters/okapi-tenant'
    - in: path
      name: id
      required: true
      description: Tenant address identifier
      schema:
        type: string
        format: uuid
    get:
      description: Get tenant address by id
      operationId: getTenantAddress
      responses:
        '200':
          description: The tenant address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tenantAddress'
        '404':
          $ref: '#/components/responses/trait_404'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Tenant Addresses
      summary: Get tenant address
      x-summary-source: derived
    put:
      operationId: updateTenantAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tenantAddress'
      responses:
        '204':
          description: Tenant address updated
        '400':
          $ref: '#/components/responses/trait_400'
        '404':
          $ref: '#/components/responses/trait_404'
        '422':
          description: Tenant address validation error
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Tenant Addresses
      summary: Update tenant address
      x-summary-source: derived
    delete:
      operationId: deleteTenantAddress
      responses:
        '204':
          description: Tenant address deleted
        '404':
          $ref: '#/components/responses/trait_404'
        '500':
          $ref: '#/components/responses/trait_500'
      tags:
      - Tenant Addresses
      summary: Delete tenant address
      x-summary-source: derived
components:
  parameters:
    offset:
      in: query
      name: offset
      description: Skip over number of elements (default is first element)
      required: false
      schema:
        type: integer
        default: 0
        minimum: 0
    okapi-tenant:
      in: header
      name: X-Okapi-Tenant
      description: Okapi Tenant
      required: true
      schema:
        type: string
        pattern: ^[_a-z][_a-z0-9]*$
    query:
      in: query
      name: query
      description: CQL query
      required: false
      schema:
        type: string
    limit:
      in: query
      name: limit
      description: Limit the number of elements returned in the response
      required: false
      schema:
        type: integer
        default: 10
        minimum: 0
  responses:
    trait_400:
      description: Bad request
      content:
        text/plain:
          schema:
            type: string
            example: Invalid JSON in request
        application/json:
          schema:
            type: object
            example:
              error: Invalid JSON in request
    trait_404:
      description: Not Found
      content:
        text/plain:
          schema:
            type: string
            example: Identifier 596d9f60-cda3-44d2-a4a1-2f48b7d4d23c not found
        application/json:
          schema:
            type: object
            example:
              error: Identifier 596d9f60-cda3-44d2-a4a1-2f48b7d4d23c not found
    trait_500:
      description: Internal error
      content:
        text/plain:
          schema:
            type: string
            example: Internal server error, contact administrator
  schemas:
    metadata:
      description: Metadata containing user and date information
      type: object
      properties:
        createdByUserId:
          description: Created by user id
          type: string
          format: uuid
        createdDate:
          description: Creation date
          type: string
        updatedByUserId:
          description: Updated by user id
          type: string
          format: uuid
        updatedDate:
          description: Update date
          type: string
      additionalProperties: false
      required:
      - createdDate
    tenantAddress:
      description: Tenant address entry
      type: object
      properties:
        id:
          description: Identifier
          type: string
          format: uuid
        name:
          description: Display name for the address
          type: string
        address:
          description: Address text
          type: string
        metadata:
          type: object
          description: Metadata containing user and date information
          $ref: '#/components/schemas/metadata'
      additionalProperties: false
      required:
      - name
      - address
    tenantAddresses:
      description: Tenant addresses
      type: object
      properties:
        addresses:
          type: array
          description: List of tenant addresses
          items:
            $ref: '#/components/schemas/tenantAddress'
      additionalProperties: false
      required:
      - addresses
x-refined-from:
- folio-mod-settings-openapi.json
- folio-mod-settings-openapi.yml