Add an option to fallback to comments if a description is not provided #564
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
The default behavior, to match existing behavior, is to fallback to comments. Setting `commentsAsFallbackDescription` to false in the `SchemaParserOptions` will result in comments not being used when a description is not provided.
2 tasks
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.
Checklist
Description
The existing behavior is to always fallback to comments from the schema. This change would add a configuration option to
SchemaParserOptionsthat would make it possible to ignore comments and exclusively use descriptions from the schema.For example:
This schema with the current behavior would result in the description being
Copyright 2020\nAuthors: ....With the
commentsAsFallbackDescriptionoption set as false, the description will be null.