Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/server-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ jobs:
- name: Type-check
run: pnpm tsc --noEmit

- name: Check generated OpenAPI document
run: pnpm check:openapi

- name: Check registered routes against OpenAPI
run: pnpm check:route-spec

- name: Test
id: tests
continue-on-error: true
Expand Down Expand Up @@ -109,4 +115,4 @@ jobs:

- name: Fail when tests fail
if: steps.tests.outcome == 'failure'
run: exit 1
run: exit 1
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,9 @@ without inspecting the URL path.
The canonical OpenAPI 3.0 spec lives at [`docs/openapi.yaml`](./docs/openapi.yaml).
Update it whenever you add or modify an endpoint. The spec is the contract
between the server and all consumers (frontend, mobile, third-party integrations).
Server CI also checks the methods and paths mounted in `server/src/routes/index.ts`
against `server/openapi.json`; update the route operations and regenerate the JSON
whenever a route is added, removed, or moved.

---

Expand Down
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading