From 887fd0e843fbd6e08f25a36db8727ff7ccb300e6 Mon Sep 17 00:00:00 2001 From: wbpcode Date: Mon, 17 Oct 2022 10:09:43 +0000 Subject: [PATCH 1/7] api: add attention to HeaderValueOption.append to avoid removing this field Signed-off-by: wbpcode --- api/envoy/config/core/v3/base.proto | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 52a3b8a2c54e4..49bed30283b39 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -358,6 +358,17 @@ message HeaderValueOption { // existing values. Otherwise it replaces any existing values. // This field is deprecated and please use // :ref:`append_action ` as replacement. + // + // .. attention:: + // The :ref:`ext_authz filter ` and + // :ref:`ext_proc filter ` have + // error default value (false) for this field. + // And the default value of + // :ref:`new append_action ` + // is always APPEND_IF_EXISTS_OR_ADD. + // It means if we remove this field, the default behavior in these filter will be changed and may break our + // users. + // So we should keep this field and couldn't remove it until the above issue is resolved one day. google.protobuf.BoolValue append = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; From 05b9d193db118cdf316b73db664d85da303e4272 Mon Sep 17 00:00:00 2001 From: code Date: Mon, 17 Oct 2022 20:45:24 +0800 Subject: [PATCH 2/7] Update api/envoy/config/core/v3/base.proto Co-authored-by: phlax Signed-off-by: code --- api/envoy/config/core/v3/base.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 49bed30283b39..4bf7560395d90 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -362,7 +362,7 @@ message HeaderValueOption { // .. attention:: // The :ref:`ext_authz filter ` and // :ref:`ext_proc filter ` have - // error default value (false) for this field. + // error default value (``false``) for this field. // And the default value of // :ref:`new append_action ` // is always APPEND_IF_EXISTS_OR_ADD. From cd56fbdf68eea399042e562743b1b6bd5173e161 Mon Sep 17 00:00:00 2001 From: code Date: Mon, 17 Oct 2022 20:45:30 +0800 Subject: [PATCH 3/7] Update api/envoy/config/core/v3/base.proto Co-authored-by: phlax Signed-off-by: code --- api/envoy/config/core/v3/base.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 4bf7560395d90..f87146d12d764 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -365,7 +365,7 @@ message HeaderValueOption { // error default value (``false``) for this field. // And the default value of // :ref:`new append_action ` - // is always APPEND_IF_EXISTS_OR_ADD. + // is always ``APPEND_IF_EXISTS_OR_ADD``. // It means if we remove this field, the default behavior in these filter will be changed and may break our // users. // So we should keep this field and couldn't remove it until the above issue is resolved one day. From 822bb3d838088a3b3aeb0534424d80b2363d6487 Mon Sep 17 00:00:00 2001 From: wbpcode Date: Tue, 18 Oct 2022 02:00:27 +0000 Subject: [PATCH 4/7] minor comments update Signed-off-by: wbpcode --- api/envoy/config/core/v3/base.proto | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index f87146d12d764..948625b27b1a5 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -360,15 +360,14 @@ message HeaderValueOption { // :ref:`append_action ` as replacement. // // .. attention:: - // The :ref:`ext_authz filter ` and - // :ref:`ext_proc filter ` have + // The :ref:`external authorization service ` and + // :ref:`external processor service ` have // error default value (``false``) for this field. - // And the default value of - // :ref:`new append_action ` + // And the default value of field + // :ref:`append_action ` // is always ``APPEND_IF_EXISTS_OR_ADD``. - // It means if we remove this field, the default behavior in these filter will be changed and may break our - // users. - // So we should keep this field and couldn't remove it until the above issue is resolved one day. + // 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. google.protobuf.BoolValue append = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"]; From 7549d3a3911507d213fd2780a8af3d3ab9e22ca4 Mon Sep 17 00:00:00 2001 From: wbpcode Date: Tue, 18 Oct 2022 02:41:52 +0000 Subject: [PATCH 5/7] fix link in the comments Signed-off-by: wbpcode --- api/envoy/config/core/v3/base.proto | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 948625b27b1a5..0cb6aa639c482 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -360,8 +360,8 @@ message HeaderValueOption { // :ref:`append_action ` as replacement. // // .. attention:: - // The :ref:`external authorization service ` and - // :ref:`external processor service ` have + // The :ref:`external authorization service ` and + // :ref:`external processor service ` have // error default value (``false``) for this field. // And the default value of field // :ref:`append_action ` From eb0246f472e07c5ae40a716500094bee152150c8 Mon Sep 17 00:00:00 2001 From: code Date: Tue, 18 Oct 2022 23:06:24 +0800 Subject: [PATCH 6/7] Update api/envoy/config/core/v3/base.proto Co-authored-by: Matt Klein Signed-off-by: code --- api/envoy/config/core/v3/base.proto | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 0cb6aa639c482..09c7aa4d41a04 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -362,7 +362,7 @@ message HeaderValueOption { // .. attention:: // The :ref:`external authorization service ` and // :ref:`external processor service ` have - // error default value (``false``) for this field. + // default value (``false``) for this field. // And the default value of field // :ref:`append_action ` // is always ``APPEND_IF_EXISTS_OR_ADD``. From c977fdce08ddae20c01b376e129ac44fba4fd2fe Mon Sep 17 00:00:00 2001 From: wbpcode Date: Tue, 18 Oct 2022 15:33:54 +0000 Subject: [PATCH 7/7] minor update Signed-off-by: wbpcode --- api/envoy/config/core/v3/base.proto | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/api/envoy/config/core/v3/base.proto b/api/envoy/config/core/v3/base.proto index 09c7aa4d41a04..383b3d96398ae 100644 --- a/api/envoy/config/core/v3/base.proto +++ b/api/envoy/config/core/v3/base.proto @@ -359,15 +359,10 @@ message HeaderValueOption { // This field is deprecated and please use // :ref:`append_action ` as replacement. // - // .. attention:: + // .. note:: // The :ref:`external authorization service ` and // :ref:`external processor service ` have // default value (``false``) for this field. - // And the default value of field - // :ref:`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. google.protobuf.BoolValue append = 2 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];