From a66bee7d6429d206e835b18c00554a1fe3032dff Mon Sep 17 00:00:00 2001 From: Rama Chavali Date: Fri, 23 Feb 2018 05:13:42 +0530 Subject: [PATCH] docs:fix doc links (#508) Signed-off-by: Rama --- XDS_PROTOCOL.md | 3 ++- tools/protodoc/protodoc.py | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/XDS_PROTOCOL.md b/XDS_PROTOCOL.md index 050317e8..f7fafc58 100644 --- a/XDS_PROTOCOL.md +++ b/XDS_PROTOCOL.md @@ -98,7 +98,8 @@ messages: The version provides Envoy and the management server a shared notion of the currently applied configuration, as well as a mechanism to ACK/NACK configuration updates. If Envoy had instead rejected configuration update __X__, -it would reply with [`error_detail`] (https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/discovery.proto#envoy-api-field-discoveryrequest-error-detail) +it would reply with +[`error_detail`](https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/discovery.proto#envoy-api-field-discoveryrequest-error-detail) populated and its previous version, which in this case was the empty initial version. The error_detail has more details around the exact error message populated in the message field: diff --git a/tools/protodoc/protodoc.py b/tools/protodoc/protodoc.py index ccaf8d4f..cc0b553f 100755 --- a/tools/protodoc/protodoc.py +++ b/tools/protodoc/protodoc.py @@ -24,6 +24,9 @@ ENVOY_PREFIX = '.envoy.' # Namespace prefix for WKTs. WKT_NAMESPACE_PREFIX = '.google.protobuf.' +# Namespace prefix for RPCs. +RPC_NAMESPACE_PREFIX = '.google.rpc.' + # http://www.fileformat.info/info/unicode/char/2063/index.htm UNICODE_INVISIBLE_SEPARATOR = u'\u2063' @@ -433,6 +436,12 @@ def FormatFieldType(type_context, field): wkt, 'https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#%s' % wkt.lower()) + elif field.type_name.startswith(RPC_NAMESPACE_PREFIX): + rpc = field.type_name[len(RPC_NAMESPACE_PREFIX):] + return FormatExternalLink( + rpc, + 'https://cloud.google.com/natural-language/docs/reference/rpc/google.rpc#%s' + % rpc.lower()) elif field.type_name: return field.type_name