v0.3: Publish rituals-api-spec as FOSS surface — README, versioning, breaking-change detection #3

New issue

Closed

opened 2026-06-29 14:49:03 +00:00 by peterswimm · 0 comments

peterswimm commented

2026-06-29 14:49:03 +00:00

Owner

Wish: a6c5234e — Publish rituals-api-spec as FOSS surface on Forgejo public

What

rituals-api-spec is the public API contract for the Toilville Rituals platform. Ensure it is a complete, public-facing FOSS surface with stable documentation, versioning, and tooling for breaking-change detection.

Tasks

Confirm repo visibility is public on git.toilville.dev/Toilville/rituals-api-spec
Write README: what the spec is, how to use it, how to run the breaking-change detector
Add OpenAPI/AsyncAPI spec files if not already present (HTTP endpoints + Kafka topics)
Tag v0.1.0 matching the current stable API surface
Wire breaking-change detection into Forgejo Actions on PR (fail PR if spec breaks without a version bump)
Document the client ↔ server data mapping (Ritual ↔ Pattern, LineageEntry ↔ Lineage event, ConsentTier ↔ Zone)

Key reference

CLAUDE.md ## How Rituals connects to the Forge section for current endpoint and data mapping documentation.

Acceptance criteria

Public README covers all stable endpoints and Kafka topics
v0.1.0 release tag exists
Forgejo Actions workflow runs spec diff on every PR

Forge wish: a6c5234e

> **Wish:** `a6c5234e` — Publish rituals-api-spec as FOSS surface on Forgejo public ## What `rituals-api-spec` is the public API contract for the Toilville Rituals platform. Ensure it is a complete, public-facing FOSS surface with stable documentation, versioning, and tooling for breaking-change detection. ## Tasks - [x] Confirm repo visibility is public on git.toilville.dev/Toilville/rituals-api-spec - [ ] Write README: what the spec is, how to use it, how to run the breaking-change detector - [ ] Add OpenAPI/AsyncAPI spec files if not already present (HTTP endpoints + Kafka topics) - [ ] Tag `v0.1.0` matching the current stable API surface - [ ] Wire breaking-change detection into Forgejo Actions on PR (fail PR if spec breaks without a version bump) - [ ] Document the client ↔ server data mapping (Ritual ↔ Pattern, LineageEntry ↔ Lineage event, ConsentTier ↔ Zone) ## Key reference CLAUDE.md `## How Rituals connects to the Forge` section for current endpoint and data mapping documentation. ## Acceptance criteria - [ ] Public README covers all stable endpoints and Kafka topics - [ ] `v0.1.0` release tag exists - [ ] Forgejo Actions workflow runs spec diff on every PR _Forge wish: `a6c5234e`_