ms2k/remora
SHA256
Watch
0
Code Releases Activity

Govern wire schemas from TypeSpec

Browse source
This commit is contained in:
ms2k 2026-07-19 02:00:47 +09:00
commit 2020dd4ed3
1 changed files with 10189 additions and 1571 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/README.md
View file

@ -1,10 +1,16 @@
# Remora API implementation contract
These files are mutable implementation artifacts. They describe the current
HTTP operations and WebSocket frames but are not authoritative over
The HTTP and WebSocket artifacts in this directory are generated from
[`contracts/typespec/main.tsp`](../../contracts/typespec/main.tsp). Edit and
regenerate that TypeSpec source instead of editing these files. The generated
artifacts describe the current wire contract but are not authoritative over
[`Remora.tla`](../protocol/Remora.tla) or
[`architecture.md`](../spec/architecture.md). Conflicts are corrected here.
Run `npm ci --prefix contracts/typespec` and
`npm run generate --prefix contracts/typespec` after changing the contract.
CI uses the corresponding `check` command to reject stale artifacts.
OpenAPI `3.2.0` describes HTTP operations and JSON Schema Draft 2020-12
describes WebSocket frames. The API contract version is `1.0.0`; additive
fields require clients to tolerate unknown response fields only after a