add comments on sub message types in base::RetryPolicy

Signed-off-by: Xin Zhuang <stevenzzz@google.com>
stevenzzzz · Feb 27, 2024 · ffa7f72 · ffa7f72
1 parent 8b58e8d
commit ffa7f72
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto
@@ -434,6 +434,7 @@ message DataSource {
 message RetryPolicy {
   option (udpa.annotations.versioning).previous_message_type = "envoy.api.v2.core.RetryPolicy";
 
+  // This is a copy of the Route RetryPriority. See more details at :ref:`RetryPriority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.
   message RetryPriority {
     string name = 1 [(validate.rules).string = {min_len: 1}];
 
@@ -442,6 +443,7 @@ message RetryPolicy {
     }
   }
 
+  // This is a copy of the Route RetryHostPredicate. See more details at :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.
   message RetryHostPredicate {
     string name = 1 [(validate.rules).string = {min_len: 1}];
 

diff --git a/api/envoy/config/core/v3/grpc_service.proto b/api/envoy/config/core/v3/grpc_service.proto
@@ -301,5 +301,7 @@ message GrpcService {
   // <config_http_conn_man_headers_custom_request_headers>`.
   repeated HeaderValue initial_metadata = 5;
 
+  // Optional default retry policy for streams toward the service.
+  // If an async stream doesn't have retry policy configured in its stream options, this retry policy is used.
   RetryPolicy retry_policy = 6;
 }