publiq · OpenAPI Overlay 1.0.0

API Evangelist overlay for publiq museumPASSmusées Partner API

7 actions 7 updates update extends ../openapi/_original/publiq-museumpassmusees-partner-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for publiq's API. It is a proposal applied on top of the contract, not a document publiq publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-hintsexternalDocsx-apievangelist

Targets 7

$
$.info
$.paths['/voucher-lists'].post
$.paths['/passes/{cardNumber}'].get
$.paths['/visits'].post
$.paths['/external-cards/{type}/{identification}'].get
$.paths['/external-cards/{type}/{identification}/visits'].post

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist overlay for publiq museumPASSmusées Partner API
  version: 1.0.0
extends: ../openapi/_original/publiq-museumpassmusees-partner-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/publiq-museumpassmusees-partner-openapi.yml
x-rationale: Adds documentation links and agent-facing hints (read-only/destructive flags per operation, derived from the
  HTTP method) without mutating the original contract.
actions:
- target: $
  description: Link the provider documentation for this API.
  update:
    externalDocs:
      description: museumPASSmusées Partner API documentation (docs.publiq.be)
      url: https://docs.publiq.be/docs/museumpassmusees/introduction
- target: $.info
  description: 'Point to cross-cutting publiq docs: authentication, errors, release notes.'
  update:
    x-apievangelist:
      provider: publiq
      authentication_docs: https://docs.publiq.be/docs/authentication
      errors_docs: https://docs.publiq.be/docs/errors
      release_notes: https://docs.publiq.be/docs/release-notes
      support: https://platform.publiq.be/nl/ondersteuning
- target: $.paths['/voucher-lists'].post
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
      requiresAuth: true
- target: $.paths['/passes/{cardNumber}'].get
  update:
    x-agent-hints:
      readOnly: true
      destructive: false
      requiresAuth: true
- target: $.paths['/visits'].post
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
      requiresAuth: true
- target: $.paths['/external-cards/{type}/{identification}'].get
  update:
    x-agent-hints:
      readOnly: true
      destructive: false
      requiresAuth: true
- target: $.paths['/external-cards/{type}/{identification}/visits'].post
  update:
    x-agent-hints:
      readOnly: false
      destructive: false
      requiresAuth: true