FOLIO · OpenAPI Overlay 1.0.0

API Evangelist overlay for FOLIO mod-consortia-keycloak-sharing-settings

2 actions 2 updates security extends ../openapi/_original/folio-mod-consortia-keycloak-sharing-settings-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

componentssecurityx-folio-deploymentx-apievangelist-source

Targets 2

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay for FOLIO mod-consortia-keycloak-sharing-settings
  version: 1.0.0
extends: ../openapi/_original/folio-mod-consortia-keycloak-sharing-settings-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/folio-mod-consortia-keycloak-sharing-settings-openapi.yml
x-rationale: Adds the documented X-Okapi-Token security scheme the module spec omits, and a self-hosting note. Never
  mutates the original OpenAPI.
actions:
- target: $
  description: Add the X-Okapi-Token header scheme and a root requirement. The scheme is copied from the provider's
    own declarations in mod-agreements (okapiToken, apiKey in header x-okapi-token) and mod-marc-migrations (ApiKey,
    header X-Okapi-Token); this spec declares none.
  update:
    components:
      securitySchemes:
        okapiToken:
          type: apiKey
          in: header
          name: X-Okapi-Token
          description: FOLIO access token issued by the deployment gateway (Okapi or Kong/Keycloak). Requests are
            also scoped to a tenant with the X-Okapi-Tenant header.
    security:
    - okapiToken: []
- 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:
      - /consortia/{consortiumId}/sharing
      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-consortia-keycloak-sharing-settings-openapi.json