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

RPC command --help could give a list of fields and types #16

Open
anzboi opened this issue Nov 28, 2021 · 0 comments
Open

RPC command --help could give a list of fields and types #16

anzboi opened this issue Nov 28, 2021 · 0 comments

Comments

@anzboi
Copy link

anzboi commented Nov 28, 2021

For discovery and help purposes, it would help to give more information through the --help command on Services and their RPCs

Services and RPCs can return their docstring as found in the proto files, while RPCs could additionally return a list of request fields and their types.

Examples

Service

$ grpctl {Service} --help
path.to.Service (path/to/file.proto)

Docstring

Available Commands:
...

Flags:
...

Global Flags:
...

Method

$ grpctl {Service} {RPC} --help
path.to.Service/RPC (path/to/file.proto)

Docstring

Request:
[num] field_name - Type

Flags:
...

Global Flags:
...
@anzboi anzboi changed the title V2 RPC command --help could give a list of fields and types RPC command --help could give a list of fields and types Dec 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant