Freeze and document the /v1 response schema #52

New issue

Open

opened 2026-07-01 00:59:12 +00:00 by manlycucumber · 0 comments

manlycucumber commented

2026-07-01 00:59:12 +00:00

(Migrated from github.com)

Problem

Before launch the /v1 contract must be declared stable so external developers can depend on it. The exact response schema for every endpoint needs to be pinned and documented as the frozen surface.

Acceptance criteria

The response schema for each /v1 endpoint is documented as stable.
Allowed future changes are limited to additive, non-breaking fields.
The frozen schema is published in the repo as the source of truth.
Any deviation from the schema is flagged during review.

Notes

Additive-only evolution preserves the immutable-per-key cache guarantees.

## Problem Before launch the `/v1` contract must be declared stable so external developers can depend on it. The exact response schema for every endpoint needs to be pinned and documented as the frozen surface. ## Acceptance criteria - [ ] The response schema for each `/v1` endpoint is documented as stable. - [ ] Allowed future changes are limited to additive, non-breaking fields. - [ ] The frozen schema is published in the repo as the source of truth. - [ ] Any deviation from the schema is flagged during review. ## Notes Additive-only evolution preserves the immutable-per-key cache guarantees.

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Directorium/Api#52

No description provided.

Rows
Columns