Repository navigation
docs: replace example document payloads with synthetic data - #462
Conversation
The document processing guide's example webhook payloads now use fictional companies, example.com contacts, 555-01xx phone numbers, generic addresses, and placeholder BOL, booking, PO, seal, and container values. Container numbers use a TSTU owner code with check digits that do not validate. The JSON structure of every example is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
.spectral.mjs imported a remote ruleset that no longer resolves, so `spectral lint` exited before checking anything. Extend the built-in spectral:oas recommended ruleset instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This comment has been minimized.
This comment has been minimized.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4db8b3a9ed
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -1,2 +1,3 @@ | |||
| import ruleset from 'https://stoplight.io/api/v1/projects/cHJqOjMxNg/spectral.js?branch_slug=feat%2Fcontainer-event-timestamps&token=0049d374-6767-468e-8313-d3f211429e84'; | |||
| export default { extends: ruleset }; | |||
| import { oas } from '@stoplight/spectral-rulesets'; | |||
There was a problem hiding this comment.
A clean npm ci does not install @stoplight/spectral-rulesets because it is absent from both package.json and the authoritative lockfile, so loading this configuration fails with ERR_MODULE_NOT_FOUND before the documented Spectral lint command can inspect the OpenAPI file. Add the package as a root development dependency and update package-lock.json.
AGENTS.md reference: AGENTS.md:L11-L11
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 755b742 without adding a dependency. .spectral.mjs is replaced by .spectral.yaml containing extends: ["spectral:oas"]. That is a built-in alias the Spectral CLI resolves itself, so the ruleset has no import and nothing to install. AGENTS.md and the command list in .github/workflows/claude.yml now point at .spectral.yaml.
Verified from a clean git archive export with no node_modules: npx @stoplight/spectral-cli@6 lint --ruleset .spectral.yaml docs/openapi.json reports 36 problems (2 errors, 34 warnings), and its full output is byte-identical to the previous ruleset's output.
The JS ruleset imported @stoplight/spectral-rulesets, which the root install does not provide. A YAML ruleset extending the built-in spectral:oas alias needs no import, and the CLI resolves it itself. Lint output on docs/openapi.json is unchanged (2 errors, 34 warnings). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Summary
example.com/example.netand 555-01xx numbers, and addresses use invented streets. Container numbers use carrier owner codes with valid ISO 6346 check digits; BOL, booking, seal, PO, and file-name values are randomly generated in each carrier's format. Cargo figures, document dates, and resource IDs are also freshly generated. The JSON structure and value types of every example are unchanged..spectral.mjsimported a remote ruleset that no longer resolves, sospectral lintexited with an error before checking anything. It now extends the built-inspectral:oasrecommended ruleset.docs/openapi.jsonis not changed in this PR.Verification
mainexactly (scripted comparison).npx mintlify@latest broken-links(isolated install fromdocs/) reports no broken links.npx vp run checkpasses.spectral lint --ruleset .spectral.mjs docs/openapi.json: before, the run aborted while loading the ruleset (exit 2, no results). After, it runs and reports 36 problems (2 errors, 34 warnings). The 2 errors are pre-existing spec issues (path-paramson/vessels/{imo},oas3-valid-media-exampleonPOST /custom_fields) and are left for a separate change. CI does not run Spectral.🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need.
The PR appears safe to merge; no actionable defects were established.Summary
Replaces document webhook examples with synthetic company names, contacts, addresses, and shipping identifiers. Changes
.spectral.mjsto extend the recommended OpenAPI rules.Reviews (1) · Last reviewed commit: "chore(lint): load the Spectral ruleset l..." · Reviewed by Greptile