Update OpenAPI spec from ziptax-api#4
Open
Laith-Alayassa wants to merge 1 commit into
Open
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Comment on lines
+2035
to
2095
| "responses": { | ||
| "200": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/SetMerchantCredentialsResponse" | ||
| } | ||
| } | ||
| }, | ||
| "description": "OK" | ||
| }, | ||
| "400": { | ||
| "content": { | ||
| "application/problem+json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ErrorModel" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Bad Request" | ||
| }, | ||
| "401": { | ||
| "content": { | ||
| "application/problem+json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ErrorModel" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Unauthorized" | ||
| }, | ||
| "403": { | ||
| "content": { | ||
| "application/problem+json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ErrorModel" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Forbidden" | ||
| }, | ||
| "summary_name": { | ||
| "description": "Summary description", | ||
| "type": "string" | ||
| "422": { | ||
| "content": { | ||
| "application/problem+json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ErrorModel" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Unprocessable Entity" | ||
| }, | ||
| "tax_type": { | ||
| "description": "Tax type", | ||
| "enum": [ | ||
| "SALES_TAX", | ||
| "USE_TAX" | ||
| ], | ||
| "type": "string" | ||
| "500": { | ||
| "content": { | ||
| "application/problem+json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ErrorModel" | ||
| } | ||
| } | ||
| }, | ||
| "description": "Internal Server Error" | ||
| } |
There was a problem hiding this comment.
🟡 Missing 404 response on /merchant/credentials/set endpoint
The /merchant/credentials/set endpoint accepts a merchantId in its request body to identify which merchant's credentials to set, but its documented responses are missing a 404 Not Found status code. Every other merchant endpoint that operates on an existing merchant by merchantId (/merchant/delete, /merchant/update, /merchant/credentials/get, /merchant/credentials/delete) includes a 404 response for the case where the merchant doesn't exist. This omission means SDK/client code generators will not handle the 404 case for this endpoint, and API documentation will be incomplete.
Prompt for agents
In openapi/openapi.json, the /merchant/credentials/set path's responses object (around line 2035-2095) is missing a 404 Not Found response. Add a 404 response block between the 403 and 422 responses, matching the pattern used by the other merchant endpoints (e.g., /merchant/credentials/get or /merchant/credentials/delete). The block should reference the ErrorModel schema with application/problem+json content type and description 'Not Found'.
Was this helpful? React with 👍 or 👎 to provide feedback.
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
2 participants
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.
Automated update from ziptax-api@deee6a015c345e903894d9d063e3b94fd01d7180.
Generated by
make openapi(which includesx-fern-audiencestagging for Fern docs).Review notes
via the raw URL consumed by
ziptax-docs.