Skip to content

api: add attention to HeaderValueOption.append to avoid removing this field #23518

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.

Sign up for GitHub

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

Merged
mattklein123 merged 7 commits into from
Oct 18, 2022
Merged

api: add attention to HeaderValueOption.append to avoid removing this field #23518

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
887fd0e
api: add attention to HeaderValueOption.append to avoid removing this…
Oct 17, 2022
05b9d19
Update api/envoy/config/core/v3/base.proto
Oct 17, 2022
cd56fbd
Update api/envoy/config/core/v3/base.proto
Oct 17, 2022
822bb3d
minor comments update
Oct 18, 2022
7549d3a
fix link in the comments
Oct 18, 2022
eb0246f
Update api/envoy/config/core/v3/base.proto
Oct 18, 2022
c977fdc
minor update
Oct 18, 2022
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
10 changes: 10 additions & 0 deletions api/envoy/config/core/v3/base.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,16 @@ message HeaderValueOption {
// existing values. Otherwise it replaces any existing values.
// This field is deprecated and please use
// :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.
//
// .. attention::
// The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
// :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
// error default value (``false``) for this field.
Comment thread
wbpcode marked this conversation as resolved.
Outdated
// And the default value of field
// :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>`
// is always ``APPEND_IF_EXISTS_OR_ADD``.
// It means that the default behavior of ``HeaderValueOption`` in these two services will be changed after
// this field is removed in the future version of API.

@mattklein123 mattklein123 Oct 18, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Per other comments, it's not going to get removed, so let's remove this. It's still not clear to me what we are telling the end user. Are we just telling them that the default is false when used in these 2 services? If so can we just say that clearly?

google.protobuf.BoolValue append = 2
[deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];

Expand Down