Toilville/rituals-api-spec
Watch
5
0
Fork
You've already forked rituals-api-spec
 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions
Rituals API specification, schema design, and breaking change detection
86 commits 5 branches 0 tags 953 KiB
  • Python 97.7%
  • Shell 2.3%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Peter Swimm cb01e20f69
All checks were successful
CI / schema-registry (push) Successful in 12s
Details
Merge pull request 'fix(spec): mirror FrameStatusKind/FrameStatusKinds into openapi.yaml' (#26) from fix/mirror-frame-status-kinds-into-openapi into main 
Reviewed-on: #26
2026-10-28 02:33:01 +00:00
.forgejo test(dynseal): run the security scenarios, and fix the two they were hiding 2026-09-28 13:53:15 -07:00
.spel new claude 2026-03-10 15:33:00 -07:00
config/vocabularies/SPELWork chore: Add Vale configuration and documentation linter guide 2026-02-20 11:07:04 -08:00
docs fix(spec): mirror FrameStatusKind/FrameStatusKinds into openapi.yaml 2026-10-27 18:34:09 -07:00
dynseal Merge pull request 'test(dynseal): run the security scenarios, and fix the two they were hiding' (#12) from fix/dynseal-tests-run into main 2026-09-29 15:50:35 +00:00
examples chore: remove stale SQLite-era scripts and orphaned docs 2026-03-09 15:45:13 -07:00
manifests First draft API including Swagger file 2025-08-17 14:19:59 -07:00
schemas feat(spec): generate the frame vocabulary, pin the submit path, add FrameEvidence 2026-10-24 17:51:42 -07:00
styles chore: Add Vale configuration and documentation linter guide 2026-02-20 11:07:04 -08:00
tools feat(spec): generate the frame vocabulary, pin the submit path, add FrameEvidence 2026-10-24 17:51:42 -07:00
.gitignore docs: Update API documentation to reflect rituals-api-spec branding 2026-02-01 16:32:28 -08:00
.vale.ini chore: Add Vale configuration and documentation linter guide 2026-02-20 11:07:04 -08:00
bootstrap.sh First draft API including Swagger file 2025-08-17 14:19:59 -07:00
breaking_change_detector.py feat: rebuild pipeline — Postgres-native generators + updated openapi spec 2026-03-08 18:04:47 -07:00
CHANGELOG.md fix(spec): mirror FrameStatusKind/FrameStatusKinds into openapi.yaml 2026-10-27 18:34:09 -07:00
CLAUDE.md feat: PatternSchema status enum + documentation workflow fix 2026-03-08 17:13:55 -07:00
CONTRIBUTING.md docs: adopt org-wide contributor-review policy (v1) 2026-08-22 14:12:42 -07:00
DYNSEAL_README.md refactor(dynseal): one copy of the subsystem, not two and a half 2026-09-28 12:55:38 -07:00
extract_db_docs.py chore(docs): delete two stale copies of the forge schema 2026-10-22 20:18:27 -07:00
forge_config.py feat(dynseal): the server asserts its schema instead of inventing one 2026-09-28 13:42:36 -07:00
gcm-diagnose.log chore: gcm diagnose log 2026-05-29 14:08:34 -07:00
models.py feat: rebuild pipeline — Postgres-native generators + updated openapi spec 2026-03-08 18:04:47 -07:00
openapi.yaml fix(spec): mirror FrameStatusKind/FrameStatusKinds into openapi.yaml 2026-10-27 18:34:09 -07:00
pytest.ini feat(spec): generate the frame vocabulary, pin the submit path, add FrameEvidence 2026-10-24 17:51:42 -07:00
README.md refactor(docs): convert README to TOC; stub duplicate catalog files 2026-03-10 15:52:57 -07:00
requirements.txt feat: rebuild pipeline — Postgres-native generators + updated openapi spec 2026-03-08 18:04:47 -07:00
schema.json Neu Docs 2025-10-02 10:29:09 -07:00
SCHEMA_API_DESIGN.md feat: Add SPELWork Schema API with 100% Prism validation 2025-10-02 15:36:25 -07:00
schema_openapi.yaml feat: Add SPELWork Schema API with 100% Prism validation 2025-10-02 15:36:25 -07:00
spelwork.schema.json Align API with foundation.db schema and add documentation pipeline 2025-09-19 16:28:15 -07:00
start-dynseal-server.sh feat(dynseal): the server asserts its schema instead of inventing one 2026-09-28 13:42:36 -07:00
test-dynseal-api.sh feat: Add Dynseal security layer to SPELWork API 2025-09-20 08:11:23 -07:00
VALE_LORE_GUIDE.md chore: Add Vale configuration and documentation linter guide 2026-02-20 11:07:04 -08:00

README.md

API Specification

REST API (OpenAPI 3.1) and Kafka event schemas (AsyncAPI) for the rituals orchestration service.

Specs

File Description
openapi.yaml REST API — all endpoints, request/response schemas
docs/src/01-overview.md API overview and integration guide

Canonical Catalogs

These files are generated from the live DB. View canonical source, not the stubs:

Stub Canonical Source
docs/event-catalog.md docs/src/04-event-catalog.md
docs/intent-catalog.md docs/src/06-intent-catalog.md

Regenerate

# Regenerate event + intent catalogs from DB
reconcile --lore generate --type forge_event_catalog
reconcile --lore generate --type forge_intent_catalog