Skip to content

Commit e0d48ad

Browse files
ragnorcclaude
andcommitted
Document openapi.json auto-sync in CI
Describe the CI workflow that regenerates openapi.json on PRs and the fork fallback. The workflow itself is added in a follow-up commit via the GitHub API (local tooling lacks workflow-scope). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 9eb3c9f commit e0d48ad

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ cargo test --workspace
1616
If you touch S3-backed flows, the CI model uses a local RustFS instance for
1717
integration tests.
1818

19+
### OpenAPI spec
20+
21+
`openapi.json` is a committed artifact generated from the Utoipa annotations in
22+
`crates/omnigraph-server`. For PRs opened from this repository, a CI job
23+
regenerates it automatically and commits the updated file back to the PR
24+
branch. For PRs from forks (where CI cannot push), run the regeneration
25+
manually:
26+
27+
```bash
28+
OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date
29+
```
30+
31+
The workspace test run fails if the committed `openapi.json` drifts from what
32+
the source generates.
33+
1934
## Pull Requests
2035

2136
- keep changes focused

0 commit comments

Comments
 (0)