Provided APIs
This directory contains the machine-readable specifications of all APIs that
this system provides (exposes to consumers).
| Format |
File extension |
Use when |
| OpenAPI 3.x |
.yaml / .json |
REST APIs |
| AsyncAPI 3.x |
.yaml / .json |
Events / messages published to consumers (Kafka, AMQP, ...) |
| Protobuf IDL |
.proto |
gRPC / binary protocols |
| GraphQL schema |
.graphql |
GraphQL APIs |
Index
| File |
Protocol |
Consumers |
Notes |
tasks.yaml |
REST |
Web frontend |
Task CRUD operations |
Guidelines
- Spec first — write or update the spec before implementing. The spec is the contract.
- Do not implement handlers manually — generate server stubs from the spec (delegate pattern).
- Treat breaking changes as major version bumps and document the decision in an ADR.
- Validate request/response against the spec in CI to prevent spec drift.