Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Path parameters description invisible in --help #157

Closed
ganli opened this issue Jan 4, 2023 · 0 comments
Closed

Path parameters description invisible in --help #157

ganli opened this issue Jan 4, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@ganli
Copy link

ganli commented Jan 4, 2023

Hello,

I want to use restish to generate command line tools with good documentation.
But it seems the path parameters is not well documented in --help, for example:
The restish example OpenAPI:

restish1

The command line help for get-image:
restish2

The "type" parameter is not described in --help, so the user may need refer to other document to know which "type" could be.

I'm not sure if it is a new requirement? Or some bug?

Thanks in advance! A very potential tool.

@danielgtaylor danielgtaylor added the enhancement New feature or request label Jan 4, 2023
danielgtaylor added a commit that referenced this issue Aug 4, 2023
feat: document args/options schemas, fixes #157
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants