[CHORE] add proper postman collection - #295
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| @@ -171,7 +171,7 @@ | |||
| "method": "PATCH", | |||
| "body": { | |||
| "mode": "raw", | |||
| "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": 2329\n }\n}", | |||
| "raw": "{\n \"data\": {\n \"attributes\": {\n \"ref_numbers\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": 1613.000642767508\n }\n}", | |||
There was a problem hiding this comment.
Numeric
type values break JSON:API conformance
Two request bodies were introduced with numeric values for the type field: 1613.000642767508 (line 174, "Edit a container") and 8552 (line 5796, "Edit a tracking request"). JSON:API requires type to be a string member — sending these payloads as-is would result in a validation error from the server. The correct values should be "container" and "tracking_request" respectively. These appear to be Postman-generated placeholder numbers that were not corrected before committing.
Prompt To Fix With AI
This is a comment left during a code review.
Path: Terminal49-API.postman_collection.json
Line: 174
Comment:
**Numeric `type` values break JSON:API conformance**
Two request bodies were introduced with numeric values for the `type` field: `1613.000642767508` (line 174, "Edit a container") and `8552` (line 5796, "Edit a tracking request"). JSON:API requires `type` to be a string member — sending these payloads as-is would result in a validation error from the server. The correct values should be `"container"` and `"tracking_request"` respectively. These appear to be Postman-generated placeholder numbers that were not corrected before committing.
How can I resolve this? If you propose a fix, please make it concise.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Greptile Summary
This PR updates the Postman collection with regenerated item UUIDs, refreshed request/response bodies, and replaces all item IDs throughout the collection. The OpenAPI spec is also updated with
exampleblocks on fourcustom_fieldendpoints and em-dash encoding fixes in two description strings.typefield (1613.000642767508and8552) that violates JSON:API's requirement for string resource types; these should be\"container\"and\"tracking_request\".examplerequest bodies to the create/update custom-field endpoints and converts literal em-dashes to\\u2014Unicode escapes in description text.Confidence Score: 3/5
The Postman collection has two request bodies with numeric
typevalues that would fail JSON:API validation if used directly by developers; the OpenAPI spec changes are clean.The "Edit a container" and "Edit a tracking request" request bodies ship with
typeset to a floating-point number and an integer respectively. Any developer who copies these bodies verbatim and sends them to the API will get a validation error, which defeats the purpose of a "proper" Postman collection. The OpenAPI changes are straightforward and correct.Terminal49-API.postman_collection.json — specifically the request bodies at lines 174 and 5796
Important Files Changed
typevalues (1613.000642767508and8552) in the "Edit a container" and "Edit a tracking request" request bodies — these must be strings per JSON:API spec.examplerequest body blocks to four custom_field endpoints and converts inline em-dash literals to their Unicode escape\u2014in two description strings. No logic changes.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[Postman Collection PR] --> B[ID Regeneration\n218 UUID changes] A --> C[Request Body Updates] A --> D[OpenAPI Spec Changes] C --> E["Edit a container\n⚠️ type: 1613.000642767508\n(should be 'container')"] C --> F["Edit a tracking request\n⚠️ type: 8552\n(should be 'tracking_request')"] C --> G[Other endpoints\n✅ Valid string types] D --> H[Add example blocks\nto custom_field endpoints] D --> I[Em-dash encoding\n— → \u2014]%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A[Postman Collection PR] --> B[ID Regeneration\n218 UUID changes] A --> C[Request Body Updates] A --> D[OpenAPI Spec Changes] C --> E["Edit a container\n⚠️ type: 1613.000642767508\n(should be 'container')"] C --> F["Edit a tracking request\n⚠️ type: 8552\n(should be 'tracking_request')"] C --> G[Other endpoints\n✅ Valid string types] D --> H[Add example blocks\nto custom_field endpoints] D --> I[Em-dash encoding\n— → \u2014]Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "chore: Auto-generate Postman collection ..." | Re-trigger Greptile