Publish an OpenAPI specification for /v1 #56

New issue

Open

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

manlycucumber commented

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

(Migrated from github.com)

Problem

External developers need a machine-readable OpenAPI spec to generate clients and understand the contract. The spec must match the frozen schema exactly.

Acceptance criteria

An OpenAPI document describes every /v1 endpoint, parameter, and response.
The spec matches the frozen schema and is validated in CI.
The spec is served/published alongside the docs.
A sample generated client can call a real endpoint successfully.

Notes

Keep the spec generated or checked against real responses to avoid drift.

## Problem External developers need a machine-readable OpenAPI spec to generate clients and understand the contract. The spec must match the frozen schema exactly. ## Acceptance criteria - [ ] An OpenAPI document describes every `/v1` endpoint, parameter, and response. - [ ] The spec matches the frozen schema and is validated in CI. - [ ] The spec is served/published alongside the docs. - [ ] A sample generated client can call a real endpoint successfully. ## Notes Keep the spec generated or checked against real responses to avoid drift.

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#56

No description provided.

Rows
Columns