Vai al contenuto
CLUP.life

Sviluppatori Changelog

Versioning and changelog

How the CLUP.life API is versioned and what changed when.

La documentazione tecnica è disponibile in tedesco e inglese; nella tua lingua mostriamo la versione inglese.

Versioning#

  • The version is in the path: /api/v1/…. The current version is v1.
  • Within v1 we only make backwards-compatible changes: new routes, new optional parameters, new fields in responses, new scopes, new webhook events and new MCP tools. Write your code tolerantly: ignore unknown fields and unknown event types.
  • Incompatible changes (removing fields, changing meaning) only come with a new version in the path and are announced here beforehand. We will define the deprecation period before the first incompatible change is due and state it here.
  • The version number of the description is in info.version of the OpenAPI file.

Download the specification#

The OpenAPI 3.1 description can be imported into Swagger UI, Postman, Insomnia or a code generator: openapi.json · openapi.yaml. The file is generated from the same source as the API itself; the live version is served by GET /api/v1/ext/openapi.json (no key needed).

Changelog#

  1. NovitàDocs

    The developer documentation is now public at /entwickler: reference generated from the OpenAPI description, examples in curl, JavaScript and Python, webhook receivers, MCP setup and a “Try it” console. The specification can be downloaded as JSON and YAML.

  2. Novitàv1.0.0

    First release of API v1: personal read-only keys (Basic), organization keys with write access to events, announcements and tasks (Premium), iCal/CSV exports, signed webhooks (8 events, Premium) and the MCP server with 9 tools.

Versioning and changelog · CLUP.life