Eliminate unreachable default branch in Output accessors for default-only responses #816
Conversation
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
…ly responses) Fixes apple#810 OpenAPI operations that declare only a default response produced an accessor like: switch self { case .default: return …; default: throw … } Since the enum has a single case, the fallback was statically unreachable and triggered a compiler warning: “Default will never be executed.” This change omits the fallback branch when the Output enum is provably single-case (default-only), eliminating the warning and keeping the accessor exhaustive. Accessor signatures remain throwing for source compatibility. Details - Generator: Gate the fallback default branch in [`TypesFileTranslator.translateResponseOutcomeInTypes()`](Sources/_OpenAPIGeneratorCore/Translator/Responses/translateResponseOutcome.swift:31) behind a single-case check (contains default and exactly one response outcome). Multi-case outputs remain unchanged and still throw on mismatches. - Tests: Update default-only expected snippet to match the new, exhaustive switch without a fallback in [`SnippetBasedReferenceTests.swift`](Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift:3412). No new tests added.
czechboy0
requested changes
Aug 25, 2025
Sources/_OpenAPIGeneratorCore/Translator/Responses/translateResponseOutcome.swift
Outdated
Show resolved
Hide resolved
|
Thanks @czechboy0! 🙏 I've committed the suggested change. |
czechboy0
approved these changes
Aug 26, 2025
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.
Motivation
OpenAPI operations that declare only a default response caused the generator to emit an accessor switch with an extra fallback branch that is statically unreachable, triggering a Swift compiler warning:
Default will never be executed.The OpenAPI spec explicitly allows default as the only entry in the Responses Object, and tooling validates such specs. This change ensures generated code is clean and warning-free for these valid definitions. Fixes #810.Result
For default-only outputs, the accessor is exhaustive and compiles without unreachable code warnings. Multi-case outputs are unchanged and continue to throw for mismatches. No changes to the public API surface or signatures of generated types
Modifications
Result
Test Plan
Links
Fixes #810, OpenAPI spec rule: https://spec.openapis.org/oas/v3.1.1.html#responses-object