From 69ea7829362450eb643a049b323879dc41861661 Mon Sep 17 00:00:00 2001 From: Joshua Humphries Date: Thu, 18 Oct 2018 13:54:51 -0400 Subject: [PATCH] reconcile with recent change to "describe" output --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d2c184a..445df32 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,10 @@ grpcurl localhost:8787 list my.custom.server.Service ### Describing Elements The "describe" verb will print the type of any symbol that the server knows about -or that is found in a given protoset file and also print the full descriptor for the -symbol, in JSON. +or that is found in a given protoset file. It also prints a description of that +symbol, in the form of snippets of proto source. It won't necessarily be the +original source that defined the element, but it will be equivalent. + ```shell # Server supports reflection grpcurl localhost:8787 describe my.custom.server.Service.MethodOne @@ -152,7 +154,7 @@ grpcurl -import-path ../protos -proto my-stuff.proto describe my.custom.server.S The `grpcurl` tool can operate on a variety of sources for descriptors. The descriptors are required, in order for `grpcurl` to understand the RPC schema, translate inputs into the protobuf binary format as well as translate responses from the binary format -into text. The sections below describe the supported sources and what command-line flags +into text. The sections below document the supported sources and what command-line flags are needed to use them. ### Server Reflection @@ -189,7 +191,7 @@ by using protoset files (since it skips the parsing and compilation steps with e invocation). Protoset files contain binary encoded `google.protobuf.FileDescriptorSet` protos. To create -a protoset file, invoke `protoc` with the `*.proto` files that describe the service: +a protoset file, invoke `protoc` with the `*.proto` files that define the service: ```shell protoc --proto_path=. \ --descriptor_set_out=myservice.protoset \