From 9e2f44fb12767f4ef3d1a232eef90b41d2eb765a Mon Sep 17 00:00:00 2001 From: Dhi Aurrahman Date: Mon, 21 Sep 2020 07:20:33 +0700 Subject: [PATCH 1/3] docs: Fix REQ command operator usage example This fixes the docs for REQ command operator usage example in LocalReplyConfig and SubstitutionFormatString protos. Signed-off-by: Dhi Aurrahman --- .../core/v3/substitution_format_string.proto | 20 ++++++++++--------- .../v4alpha/substitution_format_string.proto | 20 ++++++++++--------- .../v3/http_connection_manager.proto | 20 +++++++++---------- .../v4alpha/http_connection_manager.proto | 20 +++++++++---------- .../core/v3/substitution_format_string.proto | 20 ++++++++++--------- .../v4alpha/substitution_format_string.proto | 20 ++++++++++--------- .../v3/http_connection_manager.proto | 20 +++++++++---------- .../v4alpha/http_connection_manager.proto | 20 +++++++++---------- 8 files changed, 84 insertions(+), 76 deletions(-) diff --git a/api/envoy/config/core/v3/substitution_format_string.proto b/api/envoy/config/core/v3/substitution_format_string.proto index 24f1687cfda9..3174fb22a342 100644 --- a/api/envoy/config/core/v3/substitution_format_string.proto +++ b/api/envoy/config/core/v3/substitution_format_string.proto @@ -23,15 +23,17 @@ message SubstitutionFormatString { // Specify a format with command operators to form a text string. // Its details is described in :ref:`format string`. // - // .. code-block:: + // For example, setting ``text_format`` like below, // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // .. code-block:: yaml // - // The following plain text will be created: + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // .. code-block:: + // generates plain text similar to: // - // upstream connect error:204:path=/foo + // .. code-block:: text + // + // upstream connect error:503:path=/foo // string text_format = 1 [(validate.rules).string = {min_bytes: 1}]; @@ -41,11 +43,11 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -70,7 +72,7 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: + // .. code-block:: yaml // // content_type: "text/html; charset=UTF-8" // diff --git a/api/envoy/config/core/v4alpha/substitution_format_string.proto b/api/envoy/config/core/v4alpha/substitution_format_string.proto index 39dd12c441a7..d9e789471721 100644 --- a/api/envoy/config/core/v4alpha/substitution_format_string.proto +++ b/api/envoy/config/core/v4alpha/substitution_format_string.proto @@ -27,15 +27,17 @@ message SubstitutionFormatString { // Specify a format with command operators to form a text string. // Its details is described in :ref:`format string`. // - // .. code-block:: + // For example, setting ``text_format`` like below, // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // .. code-block:: yaml // - // The following plain text will be created: + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // .. code-block:: + // generates plain text similar to: // - // upstream connect error:204:path=/foo + // .. code-block:: text + // + // upstream connect error:503:path=/foo // string text_format = 1 [(validate.rules).string = {min_bytes: 1}]; @@ -45,11 +47,11 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -74,7 +76,7 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: + // .. code-block:: yaml // // content_type: "text/html; charset=UTF-8" // diff --git a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index 68c5c8cad2a3..ae93a83116f4 100644 --- a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -571,27 +571,27 @@ message LocalReplyConfig { // The configuration to form response body from the :ref:`command operators ` // and to specify response content type as one of: plain/text or application/json. // - // Example one: plain/text body_format. + // Example one: "plain/text" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // The following response body in `plain/text` format will be generated for a request with + // The following response body in "plain/text" format will be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. // - // .. code-block:: + // .. code-block:: text // // upstream connect error:503:path=/foo // - // Example two: application/json body_format. + // Example two: "application/json" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% - // path: $REQ(:path)% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "$REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. diff --git a/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto b/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto index 9db92927ebbe..0254fbdce9c1 100644 --- a/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto +++ b/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto @@ -573,27 +573,27 @@ message LocalReplyConfig { // The configuration to form response body from the :ref:`command operators ` // and to specify response content type as one of: plain/text or application/json. // - // Example one: plain/text body_format. + // Example one: "plain/text" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // The following response body in `plain/text` format will be generated for a request with + // The following response body in "plain/text" format will be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. // - // .. code-block:: + // .. code-block:: text // // upstream connect error:503:path=/foo // - // Example two: application/json body_format. + // Example two: "application/json" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% - // path: $REQ(:path)% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "$REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. diff --git a/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto b/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto index 24f1687cfda9..3174fb22a342 100644 --- a/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto +++ b/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto @@ -23,15 +23,17 @@ message SubstitutionFormatString { // Specify a format with command operators to form a text string. // Its details is described in :ref:`format string`. // - // .. code-block:: + // For example, setting ``text_format`` like below, // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // .. code-block:: yaml // - // The following plain text will be created: + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // .. code-block:: + // generates plain text similar to: // - // upstream connect error:204:path=/foo + // .. code-block:: text + // + // upstream connect error:503:path=/foo // string text_format = 1 [(validate.rules).string = {min_bytes: 1}]; @@ -41,11 +43,11 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -70,7 +72,7 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: + // .. code-block:: yaml // // content_type: "text/html; charset=UTF-8" // diff --git a/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto b/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto index 39dd12c441a7..d9e789471721 100644 --- a/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto +++ b/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto @@ -27,15 +27,17 @@ message SubstitutionFormatString { // Specify a format with command operators to form a text string. // Its details is described in :ref:`format string`. // - // .. code-block:: + // For example, setting ``text_format`` like below, // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // .. code-block:: yaml // - // The following plain text will be created: + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // .. code-block:: + // generates plain text similar to: // - // upstream connect error:204:path=/foo + // .. code-block:: text + // + // upstream connect error:503:path=/foo // string text_format = 1 [(validate.rules).string = {min_bytes: 1}]; @@ -45,11 +47,11 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -74,7 +76,7 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: + // .. code-block:: yaml // // content_type: "text/html; charset=UTF-8" // diff --git a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index d3bd19a7abc0..e9a7056cd3dc 100644 --- a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -576,27 +576,27 @@ message LocalReplyConfig { // The configuration to form response body from the :ref:`command operators ` // and to specify response content type as one of: plain/text or application/json. // - // Example one: plain/text body_format. + // Example one: "plain/text" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // The following response body in `plain/text` format will be generated for a request with + // The following response body in "plain/text" format will be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. // - // .. code-block:: + // .. code-block:: text // // upstream connect error:503:path=/foo // - // Example two: application/json body_format. + // Example two: "application/json" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% - // path: $REQ(:path)% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "$REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. diff --git a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto index 9db92927ebbe..0254fbdce9c1 100644 --- a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto +++ b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto @@ -573,27 +573,27 @@ message LocalReplyConfig { // The configuration to form response body from the :ref:`command operators ` // and to specify response content type as one of: plain/text or application/json. // - // Example one: plain/text body_format. + // Example one: "plain/text" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // - // text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)% + // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // - // The following response body in `plain/text` format will be generated for a request with + // The following response body in "plain/text" format will be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. // - // .. code-block:: + // .. code-block:: text // // upstream connect error:503:path=/foo // - // Example two: application/json body_format. + // Example two: "application/json" ``body_format``. // - // .. code-block:: + // .. code-block:: yaml // // json_format: - // status: %RESPONSE_CODE% - // message: %LOCAL_REPLY_BODY% - // path: $REQ(:path)% + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "$REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. From c22f37c51d0e1c59a0585d4177dc79b2a8e3faab Mon Sep 17 00:00:00 2001 From: Dhi Aurrahman Date: Tue, 22 Sep 2020 06:47:17 +0700 Subject: [PATCH 2/3] Use validated-code-block Signed-off-by: Dhi Aurrahman --- .../core/v3/substitution_format_string.proto | 15 +++++++++------ .../v3/http_connection_manager.proto | 14 ++++++++------ 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/api/envoy/config/core/v3/substitution_format_string.proto b/api/envoy/config/core/v3/substitution_format_string.proto index 3174fb22a342..d3c0915c8242 100644 --- a/api/envoy/config/core/v3/substitution_format_string.proto +++ b/api/envoy/config/core/v3/substitution_format_string.proto @@ -25,7 +25,8 @@ message SubstitutionFormatString { // // For example, setting ``text_format`` like below, // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -43,11 +44,12 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -72,7 +74,8 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // content_type: "text/html; charset=UTF-8" // diff --git a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index ae93a83116f4..b8c5f4de05ff 100644 --- a/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/api/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -573,7 +573,8 @@ message LocalReplyConfig { // // Example one: "plain/text" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -586,12 +587,13 @@ message LocalReplyConfig { // // Example two: "application/json" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" - // path: "$REQ(:path)%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "%REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. From 01fcbfa67cb7a2c8db8a668c402837ce16b241bf Mon Sep 17 00:00:00 2001 From: Dhi Aurrahman Date: Tue, 22 Sep 2020 06:57:35 +0700 Subject: [PATCH 3/3] Generated Signed-off-by: Dhi Aurrahman --- .../core/v4alpha/substitution_format_string.proto | 15 +++++++++------ .../v4alpha/http_connection_manager.proto | 14 ++++++++------ .../core/v3/substitution_format_string.proto | 15 +++++++++------ .../core/v4alpha/substitution_format_string.proto | 15 +++++++++------ .../v3/http_connection_manager.proto | 14 ++++++++------ .../v4alpha/http_connection_manager.proto | 14 ++++++++------ 6 files changed, 51 insertions(+), 36 deletions(-) diff --git a/api/envoy/config/core/v4alpha/substitution_format_string.proto b/api/envoy/config/core/v4alpha/substitution_format_string.proto index d9e789471721..3cb2e6781e0e 100644 --- a/api/envoy/config/core/v4alpha/substitution_format_string.proto +++ b/api/envoy/config/core/v4alpha/substitution_format_string.proto @@ -29,7 +29,8 @@ message SubstitutionFormatString { // // For example, setting ``text_format`` like below, // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -47,11 +48,12 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -76,7 +78,8 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // content_type: "text/html; charset=UTF-8" // diff --git a/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto b/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto index 0254fbdce9c1..6e92671bca1e 100644 --- a/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto +++ b/api/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto @@ -575,7 +575,8 @@ message LocalReplyConfig { // // Example one: "plain/text" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -588,12 +589,13 @@ message LocalReplyConfig { // // Example two: "application/json" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" - // path: "$REQ(:path)%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "%REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. diff --git a/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto b/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto index 3174fb22a342..d3c0915c8242 100644 --- a/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto +++ b/generated_api_shadow/envoy/config/core/v3/substitution_format_string.proto @@ -25,7 +25,8 @@ message SubstitutionFormatString { // // For example, setting ``text_format`` like below, // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -43,11 +44,12 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -72,7 +74,8 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // content_type: "text/html; charset=UTF-8" // diff --git a/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto b/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto index d9e789471721..3cb2e6781e0e 100644 --- a/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto +++ b/generated_api_shadow/envoy/config/core/v4alpha/substitution_format_string.proto @@ -29,7 +29,8 @@ message SubstitutionFormatString { // // For example, setting ``text_format`` like below, // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -47,11 +48,12 @@ message SubstitutionFormatString { // Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). // See the documentation for a specific command operator for details. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" // // The following JSON object would be created: // @@ -76,7 +78,8 @@ message SubstitutionFormatString { // If this field is not set then ``text/plain`` is used for *text_format* and // ``application/json`` is used for *json_format*. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // content_type: "text/html; charset=UTF-8" // diff --git a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto index e9a7056cd3dc..17d3939b3e77 100644 --- a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto +++ b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto @@ -578,7 +578,8 @@ message LocalReplyConfig { // // Example one: "plain/text" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -591,12 +592,13 @@ message LocalReplyConfig { // // Example two: "application/json" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" - // path: "$REQ(:path)%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "%REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo. diff --git a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto index 0254fbdce9c1..6e92671bca1e 100644 --- a/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto +++ b/generated_api_shadow/envoy/extensions/filters/network/http_connection_manager/v4alpha/http_connection_manager.proto @@ -575,7 +575,8 @@ message LocalReplyConfig { // // Example one: "plain/text" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // // text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n" // @@ -588,12 +589,13 @@ message LocalReplyConfig { // // Example two: "application/json" ``body_format``. // - // .. code-block:: yaml + // .. validated-code-block:: yaml + // :type-name: envoy.config.core.v3.SubstitutionFormatString // - // json_format: - // status: "%RESPONSE_CODE%" - // message: "%LOCAL_REPLY_BODY%" - // path: "$REQ(:path)%" + // json_format: + // status: "%RESPONSE_CODE%" + // message: "%LOCAL_REPLY_BODY%" + // path: "%REQ(:path)%" // // The following response body in "application/json" format would be generated for a request with // local reply body of "upstream connection error", response_code=503 and path=/foo.