API Evangelist overlay for Catalogi API

overlay: 1.0.0
info:
  title: API Evangelist overlay for Catalogi API
  version: 1.0.0
extends: ../openapi/_original/vng-realisatie-catalogi-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/vng-realisatie-catalogi-openapi.yml
x-rationale: Adds provider metadata, the documentation link recorded in apis.yml, and an x-agent-safe marker on every GET
  operation. Derived only from the saved contract and apis.yml; the original OpenAPI is not modified.
actions:
- target: $.info
  description: Attach API Evangelist provider metadata without mutating the contract.
  update:
    x-provider: VNG Realisatie
    x-provider-slug: vng-realisatie
    x-apis-json-name: Catalogi API
    x-provider-hosted-openapi: https://raw.githubusercontent.com/VNG-Realisatie/catalogi-api/develop/src/openapi.yaml
- target: $
  description: Point to the provider documentation recorded in apis.yml.
  update:
    externalDocs:
      description: Catalogi API documentation (VNG Realisatie)
      url: https://vng-realisatie.github.io/gemma-zaken/
- target: $.paths['/besluittypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/besluittypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/catalogussen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/catalogussen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/eigenschappen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/eigenschappen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/informatieobjecttypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/informatieobjecttypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/resultaattypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/resultaattypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/roltypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/roltypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/statustypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/statustypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaakobjecttypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaakobjecttypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaaktype-informatieobjecttypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaaktype-informatieobjecttypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaaktypen'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true
- target: $.paths['/zaaktypen/{uuid}'].get
  description: Mark read-only (safe for agent use without side effects).
  update:
    x-agent-safe: true