Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix REQ command operator usage example #13197

Merged
merged 3 commits into from
Sep 23, 2020
Merged

docs: Fix REQ command operator usage example #13197

merged 3 commits into from
Sep 23, 2020

Conversation

dio
Copy link
Member

@dio dio commented Sep 21, 2020

Commit Message: This fixes the docs for REQ command operator usage example in LocalReplyConfig and SubstitutionFormatString protos. $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 dio@tetrate.io

This fixes the docs for REQ command operator usage example in LocalReplyConfig
and SubstitutionFormatString protos.

Signed-off-by: Dhi Aurrahman <dio@tetrate.io>
@repokitteh-read-only
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/envoy/.
CC @envoyproxy/api-watchers: FYI only for changes made to api/envoy/.

🐱

Caused by: #13197 was opened by dio.

see: more, trace.

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe consider using #11394 if it works here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, should the config validation be done automatically?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From looking at the PR, you would need to switch to validated-code-block.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Updated. But yeah, for $REQ()% vs %REQ()% I wish we can catch that too.

Signed-off-by: Dhi Aurrahman <dio@tetrate.io>
Signed-off-by: Dhi Aurrahman <dio@tetrate.io>
@dio
Copy link
Member Author

dio commented Sep 22, 2020

cc. @envoyproxy/api-shepherds

@htuch
Copy link
Member

htuch commented Sep 23, 2020

/lgtm api

@htuch htuch merged commit 130c7c4 into envoyproxy:master Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants