Allow annotating schema type as external reference #55
+235
−9
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
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.
A common impediment to reusing JSON schemas is the difficulty in scoping qualified type names across different schemas. To assist partially with this problem, we introduce a custom annotation
x-sgen-typenamewhich allows to fully qualify the name of a schema type.When a schema type is indicated to be fully qualified, it is automatically considered external, and its definition is omitted from the generated code. The tests demonstrate an example of what a schema reuse infrastructure leveraging this custom annotation might look like.
Fixes #40