Skip to content

[CHORE] add proper postman collection - #295

Merged
sinankeskin merged 2 commits into
mainfrom
fix-custom-fields-payload
Jul 8, 2026
Merged

[CHORE] add proper postman collection#295
sinankeskin merged 2 commits into
mainfrom
fix-custom-fields-payload

Conversation

@sinankeskin

@sinankeskin sinankeskin commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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 example blocks on four custom_field endpoints and em-dash encoding fixes in two description strings.

  • Postman collection: All request and response item IDs are regenerated; request bodies for several endpoints are updated to match the current schema. Two request bodies — "Edit a container" and "Edit a tracking request" — contain a numeric type field (1613.000642767508 and 8552) that violates JSON:API's requirement for string resource types; these should be \"container\" and \"tracking_request\".
  • OpenAPI spec: Adds concrete example request bodies to the create/update custom-field endpoints and converts literal em-dashes to \\u2014 Unicode escapes in description text.

Confidence Score: 3/5

The Postman collection has two request bodies with numeric type values 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 type set 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

Filename Overview
Terminal49-API.postman_collection.json Regenerates all request/response UUIDs and updates request bodies; introduces two incorrect numeric type values (1613.000642767508 and 8552) in the "Edit a container" and "Edit a tracking request" request bodies — these must be strings per JSON:API spec.
docs/openapi.json Adds example request body blocks to four custom_field endpoints and converts inline em-dash literals to their Unicode escape \u2014 in 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]
Loading
%%{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]
Loading

Fix All in Codex

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
Terminal49-API.postman_collection.json:174
**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.

Reviews (1): Last reviewed commit: "chore: Auto-generate Postman collection ..." | Re-trigger Greptile

Greptile also left 1 inline comment on this PR.

@sinankeskin sinankeskin self-assigned this Jul 8, 2026
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api Ready Ready Preview, Comment Jul 8, 2026 7:04pm

Request Review

@sinankeskin
sinankeskin merged commit ebdc5fc into main Jul 8, 2026
4 checks passed
@@ -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}",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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.

Fix in Codex

@mintlify

mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
terminal49 🟢 Ready View Preview Jul 8, 2026, 7:53 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant