feat: document args/options schemas, fixes #157 #212
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.
Since the built-in
--help
generator only gives a name of each argument and a short text description of each option, this PR adds schema information for both to the generated description. There are two groups: 1. path parameter arguments and 2. query param / header arguments. Each is rendered as an object where the keys are the parameter name and the schema for each is shown next to it, similar to how the request/response body schemas work.To take the example in #157, it now produces this to describe the image type argument: