Repository navigation
docs(openapi): show the real carrier error codes in tracking request examples - #444
Merged
Merged
Conversation
…examples The POST /tracking_requests 422 example showed code "blank" for an unrecognized SCAC and for an unsupported carrier. The API never returns that. The tracking request model adds not_recognized or no_integration, and the JSON:API error serializer copies that error type into code. Code "blank" only appears when the SCAC is empty. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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. |
dodeja
added a commit
that referenced
this pull request
Oct 17, 2026
Brings in #434, #437 and #444. The only conflict was the generated Postman collection: took main's copy and regenerated it from the merged docs/openapi.json with openapi-to-postmanv2@6.3.0. SDK types, MCP filter schemas and SDK reference docs regenerate unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 17, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
This follows up a review comment on #440. The
POST /tracking_requests422 example showedcode: "blank"at/data/attributes/scacfor an SCAC that is not blank. The API does not return that.The tracking request model validates the carrier in
validate_scac_is_supported. It adds one of these error types:not_recognized,no_integration,no_container_request_type_support, orno_request_type_support. The jsonapi.rbActiveModelErrorSerializercopies the error type intocode. The API returnsblankonly fromvalidates :scac, presence: true, so only when the SCAC is empty.What changed
In the "Error Examples" example of the
POST /tracking_requests422 response indocs/openapi.json:Scac 'XXXX' is not recognizednow hascode: "not_recognized".Scac 'UALC' is not supported. We do not currently integrate with Universal Africa Linesnow hascode: "no_integration".The
Scac can't be blankandRequest number can't be blankentries keepcode: "blank". Thedetailstrings already match the backend locale file and the backend request spec. No other example in the spec uses this pattern.Verification
docs/openapi.jsonvalidate against their schemas (Ajv, OAS 3.0 nullable semantics). 0 fail.npm run generate:types --workspace @terminal49/sdkproduces no diff, because named examples are not emitted into the generated types.npx vp run checkpasses.npx vp run testpasses: 153, 443, and 387 tests across the three workspaces..spectral.mjsimports returns 404. This failure is not caused by this change.🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need.

Confidence Score: 5/5
This documentation-only change appears safe to merge.Summary
Corrects two carrier error codes in the
POST /tracking_requests422 response example.No actionable issues found.
Reviews (1) · Last reviewed commit: "docs(openapi): show the real carrier err..." · Reviewed by Greptile