Create an Unresolved* typealias for all supported OpenAPI types #74
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
andrewse02
commented
Jun 19, 2023
Sources/_OpenAPIGeneratorCore/Translator/RequestBody/TypedRequestBody.swift
Outdated
Show resolved
Hide resolved
Sources/_OpenAPIGeneratorCore/Translator/TypeAssignment/TypeAssigner.swift
Outdated
Show resolved
Hide resolved
czechboy0
requested changes
Jun 19, 2023
Contributor
czechboy0
left a comment
czechboy0
left a comment
There was a problem hiding this comment.
Making all the Unresolved* aliases is great, but as you suggested, let's get rid of the Resolved* aliases, as they create an extra layer of indirection to clear types, like JSONSchema/OpenAPI.Parameter, and so on. Thanks 🙏
added 8 commits
June 19, 2023 01:18
andrewse02
force-pushed
the
ae/unresolved-typealiases
branch
from
d587582 to
0a6f78f
Compare
simonjbeaumont
requested changes
Jun 19, 2023
Sources/_OpenAPIGeneratorCore/Translator/Parameters/TypedParameter.swift
Show resolved
Hide resolved
Sources/_OpenAPIGeneratorCore/Translator/Responses/TypedResponseHeader.swift
Show resolved
Hide resolved
Collaborator
|
@andrewse02 thanks for taking the time to clean this up. Just one minor nit from me—otherwise LGTM! |
simonjbeaumont
approved these changes
Jun 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Motivation
Currently, when referencing OpenAPI types that may not be referenceable, it requires a very long and unintuitive type name (e.g.,
Either<JSONReference<OpenAPI.Request>, OpenAPI.Request>). We can clean this up, by exposing more usable, and practical typealiases to improve quality of life and speed while working on the generator.Modifications
Added and used
Unresolved*typaliases for:Result
New typealiases will be added, decreasing confusion, and increasing symmetry when using OpenAPI types.
Resolves
Resolves #12
Edits
Resolved*typealiases