reflection: add comments on protos (#5209)

grpc · Feb 26, 2022 · 6f314bd · 6f314bd
1 parent 328efcc
commit 6f314bd
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 4 deletions.
diff --git a/reflection/grpc_testing_not_regenerate/dynamic.proto b/reflection/grpc_testing_not_regenerate/dynamic.proto
@@ -1,3 +1,20 @@
+/*
+ * Copyright 2022 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 syntax = "proto3";
 
 option go_package = "google.golang.org/grpc/reflection/grpc_testing_not_regenerate";
@@ -8,6 +25,9 @@ message DynamicRes {}
 
 message DynamicReq {}
 
+// DynamicService is used to test reflection on dynamically constructed protocol
+// buffer messages.
 service DynamicService {
+  // DynamicMessage1 is a test RPC for dynamically constructed protobufs.
   rpc DynamicMessage1(DynamicReq) returns (DynamicRes);
 }
diff --git a/reflection/grpc_testing_not_regenerate/testv3.pb.go b/reflection/grpc_testing_not_regenerate/testv3.pb.go
diff --git a/reflection/grpc_testing_not_regenerate/testv3.proto b/reflection/grpc_testing_not_regenerate/testv3.proto
@@ -1,3 +1,20 @@
+/*
+ * Copyright 2022 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 syntax = "proto3";
 
 option go_package = "google.golang.org/grpc/reflection/grpc_testing_not_regenerate";
@@ -31,7 +48,11 @@ message SearchRequestV3 {
   string query = 1;
 }
 
+// SearchServiceV3 is used to test grpc server reflection.
 service SearchServiceV3 {
+  // Search is a unary RPC.
   rpc Search(SearchRequestV3) returns (SearchResponseV3);
+
+  // StreamingSearch is a streaming RPC.
   rpc StreamingSearch(stream SearchRequestV3) returns (stream SearchResponseV3);
 }