astelm
/
grpcurl
mirror of https://github.com/fullstorydev/grpcurl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix doc section regarding protoset and proto sources 

There was a paragraph that mentioned protoset files but failed to mention support for proto source files. Now fixed.
This commit is contained in:
Joshua Humphries 2018-07-16 14:44:31 -04:00 committed by GitHub
parent b709105be9
commit 9d19f10af7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -14,12 +14,13 @@ This program accepts messages using JSON encoding, which is much more friendly f
humans and scripts.
With this tool you can also browse the schema for gRPC services, either by querying
a server that supports [service reflection](https://github.com/grpc/grpc/blob/master/src/proto/grpc/reflection/v1alpha/reflection.proto)
or by loading in "protoset" files (files that contain encoded file
a server that supports [service reflection](https://github.com/grpc/grpc/blob/master/src/proto/grpc/reflection/v1alpha/reflection.proto),
by reading proto source files, or by loading in compiled "protoset" files (files that contain encoded file
[descriptor protos](https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto)).
In fact, the way the tool transforms JSON request data into a binary encoded protobuf
is using that very same schema. So, if the server you interact with does not support
reflection, you will need to build "protoset" files that `grpcurl` can use.
reflection, you will either need the proto source files that define the service or need
protoset files that `grpcurl` can use.
This repo also provides a library package, `github.com/fullstorydev/grpcurl`, that has
functions for simplifying the construction of other command-line tools that dynamically