fix: parser / add summary attribute to endpoint model #404
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.
This PR add an optional
summary
attribute to the Endpoint model.By reading the specs the field
summary
anddescription
seem to be ~six of one, half-a-dozen of another.Thus, merging the two fields in the already existing
description
attr of the Endpoint is probably a bad idea.In my case I use it with a custom template to generate docstring. An other solution will be to use the
summary
value of the scheme as a fall-back value for the Endpoint description; but their is maybe someone out there that need these two fields.