pass through descriptions alongside interfaces #4
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.
ReadMe and the OpenApi spec as well as a maintainer all say that as of 3.1 it is supported to provide a
description
alongside a$ref
.I modified the code to pass through the description field for
interfaces
. Any other fields will be rejected and error. This enables use to just use adescription
field instead of the union workaround below, which was causing issues with the generated client library.can now be:
I verified that the generated code renders as expected in Readme and plays nicely with
openapi-typescript
. This resolves these two issues that Blake reported: #3 #2