Update swagger-authoring-descriptions.md #1
Merged
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 checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-version
in the path should match theapi-version
in the spec).Quality of Swagger
Looks great! Hope you'll forgive the copy-editing suggestions.
#7 in the list could be "Include links to other content when necessary," and point to how/where to find those. I don't know whether these descriptions support links, so I'll leave that to you to include if it's worthwhile.
You might also note that it's helpful to indicate in the description for a request header/query parameter whether it is required or optional.
I'm not sure what "the Linter" is, although I heard you say it the other day, so that might be good to define here.