Add ProtoApiScrubber HTTP filter configuration proto #38155
Conversation
Signed-off-by: Sumit Kumar <[email protected]>
|
Hi @sumitkmr2, welcome and thank you for your contribution. We will try to review your Pull Request as quickly as possible. In the meantime, please take a look at the contribution guidelines if you have not done so already. |
|
CC @envoyproxy/api-shepherds: Your approval is needed for changes made to |
Signed-off-by: Sumit Kumar <[email protected]>
Signed-off-by: Sumit Kumar <[email protected]>
Signed-off-by: Sumit Kumar <[email protected]>
|
/docs |
|
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-pr/38155/docs/index.html The docs are (re-)rendered each time the CI |
Signed-off-by: Sumit Kumar <[email protected]>
Signed-off-by: Sumit Kumar <[email protected]>
Signed-off-by: Sumit Kumar <[email protected]>
|
Overall, Looks good to me. Do you also plan to update the fields in commit message? I think it's safe to mention that the Design Document has been approved internally by the team at Google. |
Thanks Divya! I have updated the commit message. |
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
| option (xds.annotations.v3.file_status).work_in_progress = true; | ||
|
|
||
| // [#not-implemented-hide:] |
There was a problem hiding this comment.
@sumitkmr2 i would like to review the docs here - i can see issues in the source - but kinda need it rendered
i think because of this its not currently rendering - could you temporarily disable it please
Signed-off-by: Sumit Kumar <[email protected]>
Signed-off-by: Sumit Kumar <[email protected]>
| // }, | ||
| // "restrictions": { | ||
| // "method_restrictions": { | ||
| // "library.book_service.get_books": { |
There was a problem hiding this comment.
nit: does this method name match the proto?
| SOURCE_UNSPECIFIED = 0; | ||
|
|
||
| // The entitlement will be fetched from the request header ``key``. | ||
| REQUEST_HEADER = 1; |
There was a problem hiding this comment.
Will this header come from client?
| Source source = 1; | ||
|
|
||
| // The key to lookup the entitlement from the specified ``source``. | ||
| string key = 2; |
There was a problem hiding this comment.
Is this restriction type?
|
docs build is failing with Did you forget to add 'envoy.filters.http.proto_api_scrubber' to extensions_build_config.bzl, extensions_metadata.yaml, contrib_build_config.bzl, or contrib/extensions_metadata.yaml?i think it needs to be setup correctly - wondering if there is an implementation - its not so common to add just an api without implementation |
Commit Message: Add ProtoApiScrubber HTTP filter configuration proto.
Additional Description: We are adding a new envoy filter for API filtering for the APIs which are backed by protobuf definitions. This is the first PR for the same which contains just the filter config. Subsequent PRs will include adding more fields to the filter config to support further usecases, filter runtime code, etc. The design doc for this filter is internally approved within Google.
Risk Level: NONE
Testing: NOT DONE. Will be done once the actual filter runtime code is added.
Docs Changes: NOT DONE.
Release Notes: NA. Will be added once the actual filter runtime code is added.
Platform Specific Features: NONE.
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]