Skip to content

feat(api): commit a drift-gated OpenAPI contract as the API's source of truth #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JonnyTran merged 5 commits into from
Aug 20, 2026
Merged

feat(api): commit a drift-gated OpenAPI contract as the API's source of truth #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
efbb6a9
feat(api): commit a drift-gated OpenAPI contract as the API's source …
JonnyTran Aug 19, 2026
ce66d45
fix(api): pin error response descriptions so the contract is interpre…
JonnyTran Aug 19, 2026
2eb1c57
ci(sdk): run the SDK suite on one Python version instead of five
JonnyTran Aug 20, 2026
d95f867
ci(sdk): pin the single SDK matrix leg to 3.13 rather than 3.9
JonnyTran Aug 20, 2026
c3e7387
ci: let each package workflow trigger on changes to itself
JonnyTran Aug 20, 2026
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
4 changes: 4 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@

# Use bd merge for beads JSONL files
.beads/issues.jsonl merge=beads

# Machine-generated API contract artifacts (see ENG-40)
openapi/v1.json linguist-generated
extralit-frontend/types/generated/** linguist-generated
7 changes: 7 additions & 0 deletions .github/workflows/extralit-frontend.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ on:
- release
paths:
- "extralit-frontend/**"
- "openapi/v1.json"
- ".github/workflows/extralit-frontend.yml"

pull_request:
paths:
- "extralit-frontend/**"
- "openapi/v1.json"
Comment thread
JonnyTran marked this conversation as resolved.
- ".github/workflows/extralit-frontend.yml"

permissions:
Expand All @@ -44,6 +46,11 @@ jobs:
run: |
npm install

- name: Check generated API types are current 🔗
run: |
npm run api:types
git diff --exit-code -- types/generated/api.d.ts

- name: Run lint 🧹
continue-on-error: true
run: |
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/extralit-server.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ on:
- "v[0-9]+.[0-9]+.[0-9]+"
paths:
- "extralit-server/**"
- "openapi/v1.json"
- ".github/workflows/extralit-server.yml"

pull_request:
paths:
- "extralit-server/**"
- "openapi/v1.json"
- ".github/workflows/extralit-server.yml"

permissions:
id-token: write
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/extralit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,16 @@ on:
- "extralit/**"
- "!extralit/docs/**"
- "!extralit/mkdocs.yml"
- "openapi/v1.json"
- ".github/workflows/extralit.yml"

pull_request:
paths:
- "extralit/**"
- "!extralit/docs/**"
- "!extralit/mkdocs.yml"
- "openapi/v1.json"
- ".github/workflows/extralit.yml"

permissions:
id-token: write
Expand All @@ -50,7 +54,8 @@ jobs:
strategy:
fail-fast: true
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
# Newest supported version (requires-python <3.14).
python-version: ["3.13"]
steps:
- uses: actions/checkout@v4
- name: Install uv
Expand Down Expand Up @@ -131,7 +136,7 @@ jobs:
- name: Upload artifact
uses: actions/upload-artifact@v4
# Upload the package to be used in the next jobs only once
if: ${{ matrix.python-version == '3.9' }}
if: ${{ matrix.python-version == '3.13' }}
with:
name: extralit
path: extralit/dist
Expand Down
1 change: 1 addition & 0 deletions extralit-frontend/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ dist

# Lockfiles and generated data
package-lock.json
types/generated
2 changes: 1 addition & 1 deletion extralit-frontend/eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default [
"v1/domain/entities/document/Document.ts",
"v1/domain/usecases/get-extraction-completion-use-case.ts",
"components/base/base-render-table/**",
"v2/infrastructure/api/generated/**",
"types/generated/**",
],
},

Expand Down
4 changes: 2 additions & 2 deletions extralit-frontend/package-lock.json
View file
Open in desktop

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

1 change: 1 addition & 0 deletions extralit-frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"scripts": {
"dev": "nuxi dev",
"postinstall": "nuxi prepare",
"api:types": "openapi-typescript ../openapi/v1.json -o types/generated/api.d.ts",
"build": "nuxi build",
"start": "nuxi preview",
"generate": "nuxi generate",
Expand Down
Loading
Loading