Skip to content

Commit 41ba83e

Browse files
wucm667zirain
wucm667
authored and
zirain
committed
fix(api): remove implementation note from RateLimitSelectCondition headers field
The comment about reverting once upstream Gateway API supports >64 items was appearing in generated CRD descriptions and API docs. Per reviewer feedback, remove it from the source file. Signed-off-by: wucm667 <stevenwucongmin@gmail.com>
1 parent 5576d33 commit 41ba83e

7 files changed

Lines changed: 1 addition & 33 deletions

File tree

‎api/v1alpha1/ratelimit_types.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,6 @@ type RateLimitSelectCondition struct {
229229
//
230230
// +optional
231231
// +kubebuilder:validation:MaxItems=64
232-
// Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
233-
// Revert this change once the upstream Gateway API supports items more than 64.
234232
Headers []HeaderMatch `json:"headers,omitempty"`
235233

236234
// Methods is a list of request methods to match. Multiple method values are ORed together,

‎charts/gateway-crds-helm/templates/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1468,9 +1468,6 @@ spec:
14681468
description: |-
14691469
Headers is a list of request headers to match. Multiple header values are ANDed together,
14701470
meaning, a request MUST match all the specified headers.
1471-
1472-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1473-
Revert this change once the upstream Gateway API supports items more than 64.
14741471
items:
14751472
description: HeaderMatch defines the match attributes
14761473
within the HTTP Headers of the request.
@@ -1855,9 +1852,6 @@ spec:
18551852
description: |-
18561853
Headers is a list of request headers to match. Multiple header values are ANDed together,
18571854
meaning, a request MUST match all the specified headers.
1858-
1859-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1860-
Revert this change once the upstream Gateway API supports items more than 64.
18611855
items:
18621856
description: HeaderMatch defines the match attributes
18631857
within the HTTP Headers of the request.

‎charts/gateway-helm/charts/crds/crds/generated/gateway.envoyproxy.io_backendtrafficpolicies.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1467,9 +1467,6 @@ spec:
14671467
description: |-
14681468
Headers is a list of request headers to match. Multiple header values are ANDed together,
14691469
meaning, a request MUST match all the specified headers.
1470-
1471-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1472-
Revert this change once the upstream Gateway API supports items more than 64.
14731470
items:
14741471
description: HeaderMatch defines the match attributes
14751472
within the HTTP Headers of the request.
@@ -1854,9 +1851,6 @@ spec:
18541851
description: |-
18551852
Headers is a list of request headers to match. Multiple header values are ANDed together,
18561853
meaning, a request MUST match all the specified headers.
1857-
1858-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1859-
Revert this change once the upstream Gateway API supports items more than 64.
18601854
items:
18611855
description: HeaderMatch defines the match attributes
18621856
within the HTTP Headers of the request.

‎site/content/en/latest/api/extension_types.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5228,7 +5228,7 @@ _Appears in:_
52285228

52295229
| Field | Type | Required | Default | Description |
52305230
| --- | --- | --- | --- | --- |
5231-
| `headers` | _[HeaderMatch](#headermatch) array_ | false | | Headers is a list of request headers to match. Multiple header values are ANDed together,<br />meaning, a request MUST match all the specified headers.<br />Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.<br />Revert this change once the upstream Gateway API supports items more than 64. |
5231+
| `headers` | _[HeaderMatch](#headermatch) array_ | false | | Headers is a list of request headers to match. Multiple header values are ANDed together,<br />meaning, a request MUST match all the specified headers. |
52325232
| `methods` | _[MethodMatch](#methodmatch) array_ | false | | Methods is a list of request methods to match. Multiple method values are ORed together,<br />meaning, a request can match any one of the specified methods. If not specified, it matches all methods. |
52335233
| `path` | _[PathMatch](#pathmatch)_ | false | | Path is the request path to match.<br />Support Exact, PathPrefix and RegularExpression match types. |
52345234
| `sourceCIDR` | _[SourceMatch](#sourcematch)_ | false | | SourceCIDR is the client IP Address range to match on. |

‎test/helm/gateway-crds-helm/all.out.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23995,9 +23995,6 @@ spec:
2399523995
description: |-
2399623996
Headers is a list of request headers to match. Multiple header values are ANDed together,
2399723997
meaning, a request MUST match all the specified headers.
23998-
23999-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
24000-
Revert this change once the upstream Gateway API supports items more than 64.
2400123998
items:
2400223999
description: HeaderMatch defines the match attributes
2400324000
within the HTTP Headers of the request.
@@ -24382,9 +24379,6 @@ spec:
2438224379
description: |-
2438324380
Headers is a list of request headers to match. Multiple header values are ANDed together,
2438424381
meaning, a request MUST match all the specified headers.
24385-
24386-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
24387-
Revert this change once the upstream Gateway API supports items more than 64.
2438824382
items:
2438924383
description: HeaderMatch defines the match attributes
2439024384
within the HTTP Headers of the request.

‎test/helm/gateway-crds-helm/e2e.out.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1968,9 +1968,6 @@ spec:
19681968
description: |-
19691969
Headers is a list of request headers to match. Multiple header values are ANDed together,
19701970
meaning, a request MUST match all the specified headers.
1971-
1972-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1973-
Revert this change once the upstream Gateway API supports items more than 64.
19741971
items:
19751972
description: HeaderMatch defines the match attributes
19761973
within the HTTP Headers of the request.
@@ -2355,9 +2352,6 @@ spec:
23552352
description: |-
23562353
Headers is a list of request headers to match. Multiple header values are ANDed together,
23572354
meaning, a request MUST match all the specified headers.
2358-
2359-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
2360-
Revert this change once the upstream Gateway API supports items more than 64.
23612355
items:
23622356
description: HeaderMatch defines the match attributes
23632357
within the HTTP Headers of the request.

‎test/helm/gateway-crds-helm/envoy-gateway-crds.out.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1968,9 +1968,6 @@ spec:
19681968
description: |-
19691969
Headers is a list of request headers to match. Multiple header values are ANDed together,
19701970
meaning, a request MUST match all the specified headers.
1971-
1972-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
1973-
Revert this change once the upstream Gateway API supports items more than 64.
19741971
items:
19751972
description: HeaderMatch defines the match attributes
19761973
within the HTTP Headers of the request.
@@ -2355,9 +2352,6 @@ spec:
23552352
description: |-
23562353
Headers is a list of request headers to match. Multiple header values are ANDed together,
23572354
meaning, a request MUST match all the specified headers.
2358-
2359-
Increase the maxItems from 16 to 64, aligning with HTTPHeaderFilter.
2360-
Revert this change once the upstream Gateway API supports items more than 64.
23612355
items:
23622356
description: HeaderMatch defines the match attributes
23632357
within the HTTP Headers of the request.

0 commit comments

Comments
 (0)