FOLIO · OpenAPI Overlay 1.0.0

API Evangelist overlay for FOLIO mod-agreements

1 action 1 update update extends ../openapi/_original/folio-mod-agreements-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for FOLIO's API. It is a proposal applied on top of the contract, not a document FOLIO publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-folio-deploymentx-apievangelist-source

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay for FOLIO mod-agreements
  version: 1.0.0
extends: ../openapi/_original/folio-mod-agreements-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/folio-mod-agreements-openapi.yml
x-rationale: Spec already declares security schemes; adds only a self-hosting note. Never mutates the original OpenAPI.
actions:
- target: $.info
  description: 'Record that FOLIO is self-hosted: there is no single public base URL.'
  update:
    x-folio-deployment:
      hosting: self-hosted
      note: Each library (or hosting vendor) runs its own FOLIO deployment and exposes this module through its own
        gateway URL; requests carry X-Okapi-Tenant and X-Okapi-Token headers.
      servers_in_spec:
      - https://folio-snapshot-okapi.dev.folio.org
      - https://folio-snapshot-2-okapi.dev.folio.org
      - https://folio-etesting-snapshot-kong.ci.folio.org
      servers_note: Servers declared in the module spec are relative paths, localhost, stub hosts or FOLIO CI/snapshot
        environments, not a production endpoint.
    x-apievangelist-source: openapi/_original/folio-mod-agreements-openapi.json