search

pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.64k stars 464 forks source link

Add "streaming" indicator to requests/responses of streaming RPCs #372

Closed htdvisser closed 6 years ago

htdvisser commented 6 years ago

Hi @pseudomuto,

Until now, streaming RPCs were rendered exactly the same as unary RPCs. This PR adds a "stream" indicator to the requests/responses of streaming RPCs. Output for unary RPCs is unchanged, except for the JSON output, where the boolean fields requestStreaming and responseStreaming are added (and are "false" for unary RPCs).

I also updated the examples to include a streaming RPC. If that's not desired, the last commit in this PR can be excluded.

htdvisser commented 6 years ago

Added entry to CHANGELOG and rebased on top of master.