Skip to content

schema

Scope: OpenAPI schema contract.
Audience: API users and contributors.
Guarantees: Schema file is authoritative.
Non-Goals: Client SDK generation.
Why: This doc exists to record its single responsibility for review.

Overview

This doc defines one responsibility.
Architecture components are defined in Architecture.
Read Overview before edits.
Read Docs Style for context.

Contracts

Each statement is a contract.
Contracts align with api/v1/schema.yaml.
Contracts link to Overview and Docs Style.

Invariants

Invariants describe stable behavior.
Checks align with api/v1/schema.yaml.
Invariants align with Overview.

Failure Modes

Failures are explicit and tested.
Failure coverage aligns with api/v1/schema.yaml.
Failures align with Docs Style.

Extension Points

Extensions require tests and docs.
Extensions are tracked in Overview.
Extensions align with api/v1/schema.yaml.

Exit Criteria

This doc becomes obsolete when the surface ends.
The replacement is linked in Docs Style.
Obsolete docs are removed.

Code refs: api/v1/schema.yaml.