docs: Fix REQ command operator usage example #13197
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes the docs for REQ command operator usage example in LocalReplyConfig and SubstitutionFormatString protos. Signed-off-by: Dhi Aurrahman <[email protected]>
htuch
reviewed
Sep 21, 2020
| @@ -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 | |||
There was a problem hiding this comment.
Maybe consider using #11394 if it works here.
There was a problem hiding this comment.
Sorry, should the config validation be done automatically?
There was a problem hiding this comment.
From looking at the PR, you would need to switch to validated-code-block.
There was a problem hiding this comment.
Thanks! Updated. But yeah, for $REQ()% vs %REQ()% I wish we can catch that too.
Signed-off-by: Dhi Aurrahman <[email protected]>
Signed-off-by: Dhi Aurrahman <[email protected]>
zuercher
approved these changes
Sep 22, 2020
|
cc. @envoyproxy/api-shepherds |
|
/lgtm api |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit Message: This fixes the docs for
REQcommand operator usage example inLocalReplyConfigandSubstitutionFormatStringprotos.$REQ(:path)%is an invalid command operator, it should be%REQ(:path)%.Risk Level: N/A
Testing: N/A
Docs Changes: This is a docs change.
Release Notes: N/A
Signed-off-by: Dhi Aurrahman [email protected]