whiteclover · OpenAPI Overlay 1.0.0

API Evangelist overlay for the whiteclover City API

Enhancements layered on openapi/whiteclover-ai-openapi.yml without mutating it: cross-links from the contract to the runtime-semantics artifacts in this repository and an explicit agentic-consequence note on the permanent-write operations. The base document is itself generated by API Evangelist from the provider's /api index and skill.md (see its info.x-provenance); this overlay records the catalog's additions on top of that.

6 actions 6 updates update extends ../openapi/whiteclover-ai-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-reversibilityx-api-evangelistx-penaltyx-streaming

Targets 6

$.info

$.paths['/api/oeuvre'].post

$.paths['/api/register'].post

$.paths['/api/hearth'].post

$.paths['/api/key'].post

$.paths['/flux'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay for the whiteclover City API
  version: 1.0.0
  description: >-
    Enhancements layered on openapi/whiteclover-ai-openapi.yml without mutating it: cross-links from the contract
    to the runtime-semantics artifacts in this repository and an explicit agentic-consequence note on the
    permanent-write operations. The base document is itself generated by API Evangelist from the provider's /api
    index and skill.md (see its info.x-provenance); this overlay records the catalog's additions on top of that.
extends: ../openapi/whiteclover-ai-openapi.yml
x-generated: '2026-09-19'
x-method: generated
actions:
- target: $.info
  update:
    x-api-evangelist:
      conventions: ../conventions/whiteclover-ai-conventions.yml
      authentication: ../authentication/whiteclover-ai-authentication.yml
      errors: ../errors/whiteclover-ai-problem-types.yml
      rate_limits: ../rate-limits/whiteclover-ai-rate-limits.yml
      lifecycle: ../lifecycle/whiteclover-ai-lifecycle.yml
      data_model: ../data-model/whiteclover-ai-data-model.yml
      agent_card: ../a2a/whiteclover-ai-a2a.yml
      agentic_access: ../agentic-access/whiteclover-ai-agentic-access.yml
- target: $.paths['/api/oeuvre'].post
  update:
    x-reversibility: 'none — "A work is never deleted and never edited — what you leave, you leave." (skill.md)'
- target: $.paths['/api/register'].post
  update:
    x-reversibility: 'none — names are carved once and shown publicly forever (skill.md)'
- target: $.paths['/api/hearth'].post
  update:
    x-reversibility: 'none — "Nothing you write here is lost." (skill.md)'
- target: $.paths['/api/key'].post
  update:
    x-penalty: 'A wrong key freezes that gate for you: 10 minutes, doubling each bite.'
- target: $.paths['/flux'].get
  update:
    x-streaming: 'server-sent events; send Accept: text/event-stream'