Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions api/envoy/config/core/v3/substitution_format_string.proto
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,18 @@ message SubstitutionFormatString {
// Specify a format with command operators to form a text string.
// Its details is described in :ref:`format string<config_access_log_format_strings>`.
//
// .. code-block::
// For example, setting ``text_format`` like below,
//
// text_format: %LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=$REQ(:path)%
// .. validated-code-block:: yaml
// :type-name: envoy.config.core.v3.SubstitutionFormatString
//
// 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}];

Expand All @@ -41,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::
// .. 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:
//
Expand All @@ -70,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::
// .. validated-code-block:: yaml
// :type-name: envoy.config.core.v3.SubstitutionFormatString
//
// content_type: "text/html; charset=UTF-8"
//
Expand Down
25 changes: 15 additions & 10 deletions api/envoy/config/core/v4alpha/substitution_format_string.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -571,27 +571,29 @@ message LocalReplyConfig {
// The configuration to form response body from the :ref:`command operators <config_access_log_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::
// .. validated-code-block:: yaml
// :type-name: envoy.config.core.v3.SubstitutionFormatString
//
// 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::
// .. 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.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.