Skip to content

Contracts docs: REST request/response schema reference #442

Description

@codebestia

Write apps/backend/docs/contracts-rest-schemas.md — the strict reference companion to the API usage docs: every Zod schema used to validate REST request bodies (schemas/auth.schemas.ts and any others found in middleware/validate.ts call sites) with field-level types, constraints, and default values.

Acceptance criteria:

  • Every exported Zod schema used by a route is listed with its full shape (field name, type, optional/required, constraint like .uuid()/.regex()/.max())
  • Cross-referenced by name from each relevant api-*.md doc rather than duplicating full schema bodies there
  • Kept in one file rather than split per-route

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions