mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-09 01:35:18 +02:00
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>
This commit is contained in:
parent
9eb3c9fde4
commit
e0d48ad825
1 changed files with 15 additions and 0 deletions
|
|
@ -16,6 +16,21 @@ cargo test --workspace
|
|||
If you touch S3-backed flows, the CI model uses a local RustFS instance for
|
||||
integration tests.
|
||||
|
||||
### OpenAPI spec
|
||||
|
||||
`openapi.json` is a committed artifact generated from the Utoipa annotations in
|
||||
`crates/omnigraph-server`. For PRs opened from this repository, a CI job
|
||||
regenerates it automatically and commits the updated file back to the PR
|
||||
branch. For PRs from forks (where CI cannot push), run the regeneration
|
||||
manually:
|
||||
|
||||
```bash
|
||||
OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date
|
||||
```
|
||||
|
||||
The workspace test run fails if the committed `openapi.json` drifts from what
|
||||
the source generates.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- keep changes focused
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue