Skip to content

fix(openapi): preserve typed default errors #2002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flemzord merged 1 commit into from
Aug 6, 2026
+5 −6
Merged

fix(openapi): preserve typed default errors #2002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ validate-openapi:
jq -e '.components.schemas as $schemas | [ $schemas | .. | objects | select(.discriminator.mapping? != null) | .discriminator.mapping[] | select(type == "string" and startswith("#/components/schemas/")) | sub("^#/components/schemas/"; "") | select($schemas[.] == null) ] | length == 0' releases/build/generate.json >/dev/null
# Ledger query-template helpers rely on these resource constants.
jq -e '[.components.schemas.ledger_V2QueryParams.oneOf[].properties.resource | select(.const == null or .enum != null)] | length == 0' releases/build/generate.json >/dev/null
# Error responses must not be generated as successful response variants.
test "$(jq -c '.paths["x-speakeasy-errors"].statusCodes' releases/build/generate.json)" = '["4XX","5XX","default"]'
# Preserve typed default errors instead of shadowing them with generic range matchers.
test "$(jq -c '.paths["x-speakeasy-errors"].statusCodes' releases/build/generate.json)" = '["default"]'
# Every operation tag must be declared globally.
jq -e '[.tags[].name] as $tags | [.paths[] | to_entries[] | select(.key | IN("get", "post", "put", "patch", "delete", "options", "head", "trace")) | .value.tags[]? | select(. as $tag | $tags | index($tag) == null)] | length == 0' releases/build/generate.json >/dev/null
# Composition cleanups must remain applied when component specs change.
Expand Down
7 changes: 3 additions & 4 deletions releases/overlays/shared.overlay.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,13 @@ actions:
- target: $.components.schemas.payments_LegacyPaymentStatus.enum[14]
remove: true

# Treat all HTTP error responses as errors. Component specs contribute their
# own defaults during merge, so remove the merged value before replacing it.
# Preserve each component's typed default error response. Global 4XX/5XX
# matchers take precedence over the default schema in generated SDKs and
# would turn structured API errors into generic SDK errors.
- target: $.paths.x-speakeasy-errors
remove: true
- target: $.paths
update:
x-speakeasy-errors:
statusCodes:
- 4XX
- 5XX
- default
Loading