Skip to content

docs: replace example document payloads with synthetic data #462

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
dodeja merged 6 commits into from
Oct 19, 2026
Merged

docs: replace example document payloads with synthetic data #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0657c84
docs: replace example document payloads with synthetic data
dodeja Oct 18, 2026
4db8b3a
chore(lint): load the Spectral ruleset locally
dodeja Oct 18, 2026
755b742
chore(lint): use a YAML Spectral ruleset
dodeja Oct 19, 2026
c2ca009
Merge origin/main into docs/synthetic-examples
dodeja Oct 19, 2026
b3d3d09
docs: use realistic fabricated values in document payload examples
dodeja Oct 19, 2026
cf733f7
Merge remote-tracking branch 'origin/main' into docs/synthetic-examples
dodeja Oct 19, 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
2 changes: 1 addition & 1 deletion .github/workflows/claude.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ jobs:

Useful commands:
- cd docs && mintlify dev
- spectral lint --ruleset .spectral.mjs docs/openapi.json
- spectral lint --ruleset .spectral.yaml docs/openapi.json
- openapi2postmanv2 -s docs/openapi.json -o Terminal49-API.postman_collection.json -p -O folderStrategy=Tags,enableOptionalParameters=false

If API behavior or schemas change, update docs/openapi.json first. Regenerate the Postman collection only when explicitly needed.
Expand Down
2 changes: 0 additions & 2 deletions .spectral.mjs
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions .spectral.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extends: ["spectral:oas"]
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ For substantive documentation writing, use the repo-local skill at `skills/termi

### Docs
- Preview locally: `cd docs && mintlify dev`
- Lint the OpenAPI spec: `spectral lint --ruleset .spectral.mjs docs/openapi.json`
- Lint the OpenAPI spec: `spectral lint --ruleset .spectral.yaml docs/openapi.json`
- Regenerate Postman: `openapi2postmanv2 -s docs/openapi.json -o Terminal49-API.postman_collection.json -p -O folderStrategy=Tags,enableOptionalParameters=false`

### Code (npm workspaces)
Expand Down
Loading
Loading