From b8684f9f5329c5e10bb51c037c54fd3b7535e332 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Fri, 5 Oct 2018 13:00:24 +1000 Subject: [PATCH] Add a further note recommending to not include `TopicDescriptor` in the `.proto` file --- pubsub/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pubsub/README.md b/pubsub/README.md index 215fe00..9537388 100644 --- a/pubsub/README.md +++ b/pubsub/README.md @@ -91,7 +91,9 @@ future. The topic descriptor message is not used in current implementations, but may be used in future to define various options and parameters -of a topic. It currently specifies the topic's human readable name, its +of a topic. For clarity, it is recommended to not include the +`TopicDescriptor` in the `.proto` file until is is used. +It currently specifies the topic's human readable name, its authentication options, and its encryption options. The `TopicDescriptor` protobuf is as follows: