codegen: Permit autogenerating types aliases for endpoints #4213
Conversation
This file contains 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
|
That's quite a big set of changes. Nice work! :) |
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.
Adds a new
openapiGenerateEndpointTypessetting (default false).If 'true', we will generate type aliases for generated endpoint declarations (see changes to openapi-codegen/sbt-plugin/src/sbt-test/sbt-openapi-codegen/oneOf-json-roundtrip/Expected.scala.txt).
If 'false' the only behavioural change should be that the LUB type is specified explicitly when generating
.errorOut(oneOf[LUB](oneOfVariant...stuff (this is actually a little nicer usually -- it means the type will beTheParentTyperather thanTheParentType with Product with Serializable)I would find having pre-defined type aliases for all the endpoint types to be extremely useful; locally I have a sourceGenerator step that replaces the
lazy val generatedEndpoints = List(...)declaration on generated files with an HList (which is easy to do) to help ensure exhaustivity on implementation; having the type aliases available would make the subsequent 'serverLogic' binding declarations so much nicer, and it's next to impossible to generate them outside of the tapir code generation itself.