Skip to content

Commit 340649d

Browse files
committed
fix: r
Signed-off-by: ashing <[email protected]>
1 parent 1a529e7 commit 340649d

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

config/crd/bases/apisix.apache.org_apisixconsumers.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,8 @@ spec:
168168
algorithm:
169169
description: |-
170170
Algorithm specifies the signing algorithm.
171-
Can be `HS256`, `HS512`, `RS256`, or `ES256`.
171+
Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`.
172+
Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms.
172173
type: string
173174
base64_secret:
174175
description: Base64Secret indicates whether the secret

config/crd/bases/apisix.apache.org_apisixroutes.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ spec:
203203
subject:
204204
description: |-
205205
Subject defines the left-hand side of the expression.
206-
It can be any [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable) or string literal.
206+
It can be any [built-in variable](/apisix/reference/built-in-variables) or string literal.
207207
properties:
208208
name:
209209
description: Name is the name of the header or
@@ -233,6 +233,7 @@ spec:
233233
description: |-
234234
FilterFunc is a user-defined function for advanced request filtering.
235235
The function can use Nginx variables through the `vars` parameter.
236+
This field is supported in APISIX but not in API7 Enterprise.
236237
type: string
237238
hosts:
238239
description: |-

config/crd/bases/apisix.apache.org_apisixupstreams.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ spec:
279279
When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
280280
When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
281281
When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of
282-
[APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable).
282+
[built-in variables](/enterprise/reference/built-in-variables).
283283
type: string
284284
type:
285285
default: roundrobin
@@ -524,7 +524,7 @@ spec:
524524
When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
525525
When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
526526
When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of
527-
[APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable).
527+
[built-in variables](/enterprise/reference/built-in-variables).
528528
type: string
529529
type:
530530
default: roundrobin

docs/en/latest/reference/api-reference.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ LoadBalancer describes the load balancing parameters.
366366
| --- | --- |
367367
| `type` _string_ | Type specifies the load balancing algorithms to route traffic to the backend. Default is `roundrobin`. Can be `roundrobin`, `chash`, `ewma`, or `least_conn`. |
368368
| `hashOn` _string_ | HashOn specified the type of field used for hashing, required when type is `chash`. Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
369-
| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable/). |
369+
| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
370370

371371

372372
_Appears in:_
@@ -788,7 +788,7 @@ ApisixConsumerJwtAuthValue defines configuration for JWT authentication.
788788
| `secret` _string_ | Secret is the shared secret used to sign the JWT (for symmetric algorithms). |
789789
| `public_key` _string_ | PublicKey is the public key used to verify JWT signatures (for asymmetric algorithms). |
790790
| `private_key` _string_ | PrivateKey is the private key used to sign the JWT (for asymmetric algorithms). |
791-
| `algorithm` _string_ | Algorithm specifies the signing algorithm. Can be `HS256`, `HS512`, `RS256`, or `ES256`. |
791+
| `algorithm` _string_ | Algorithm specifies the signing algorithm. Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`. Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms. |
792792
| `exp` _integer_ | Exp is the token expiration period in seconds. |
793793
| `base64_secret` _boolean_ | Base64Secret indicates whether the secret is base64-encoded. |
794794
| `lifetime_grace_period` _integer_ | LifetimeGracePeriod is the allowed clock skew in seconds for token expiration. |
@@ -1084,7 +1084,7 @@ ApisixRouteHTTPMatch defines the conditions used to match incoming HTTP requests
10841084
| `hosts` _string array_ | Hosts specifies Host header values to match. Supports exact and wildcard domains. Only one level of wildcard is allowed (e.g., `*.example.com` is valid, but `*.*.example.com` is not). |
10851085
| `remoteAddrs` _string array_ | RemoteAddrs is a list of source IP addresses or CIDR ranges to match. Supports both IPv4 and IPv6 formats. |
10861086
| `exprs` _[ApisixRouteHTTPMatchExprs](#apisixroutehttpmatchexprs)_ | NginxVars defines match conditions based on Nginx variables. |
1087-
| `filter_func` _string_ | FilterFunc is a user-defined function for advanced request filtering. The function can use Nginx variables through the `vars` parameter. |
1087+
| `filter_func` _string_ | FilterFunc is a user-defined function for advanced request filtering. The function can use Nginx variables through the `vars` parameter. This field is supported in APISIX but not in API7 Enterprise. |
10881088

10891089

10901090
_Appears in:_
@@ -1099,7 +1099,7 @@ ApisixRouteHTTPMatchExpr represents a binary expression used to match requests b
10991099

11001100
| Field | Description |
11011101
| --- | --- |
1102-
| `subject` _[ApisixRouteHTTPMatchExprSubject](#apisixroutehttpmatchexprsubject)_ | Subject defines the left-hand side of the expression. It can be any [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable) or string literal. |
1102+
| `subject` _[ApisixRouteHTTPMatchExprSubject](#apisixroutehttpmatchexprsubject)_ | Subject defines the left-hand side of the expression. It can be any [built-in variable](/apisix/reference/built-in-variables) or string literal. |
11031103
| `op` _string_ | Op specifies the operator used in the expression. Can be `Equal`, `NotEqual`, `GreaterThan`, `GreaterThanEqual`, `LessThan`, `LessThanEqual`, `RegexMatch`, `RegexNotMatch`, `RegexMatchCaseInsensitive`, `RegexNotMatchCaseInsensitive`, `In`, or `NotIn`. |
11041104
| `set` _string array_ | Set provides a list of acceptable values for the expression. This should be used when Op is `In` or `NotIn`. |
11051105
| `value` _string_ | Value defines a single value to compare against the subject. This should be used when Op is not `In` or `NotIn`. Set and Value are mutually exclusive—only one should be set at a time. |
@@ -1133,7 +1133,7 @@ _Base type:_ `[ApisixRouteHTTPMatchExpr](#apisixroutehttpmatchexpr)`
11331133

11341134
| Field | Description |
11351135
| --- | --- |
1136-
| `subject` _[ApisixRouteHTTPMatchExprSubject](#apisixroutehttpmatchexprsubject)_ | Subject defines the left-hand side of the expression. It can be any [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable) or string literal. |
1136+
| `subject` _[ApisixRouteHTTPMatchExprSubject](#apisixroutehttpmatchexprsubject)_ | Subject defines the left-hand side of the expression. It can be any [built-in variable](/apisix/reference/built-in-variables) or string literal. |
11371137
| `op` _string_ | Op specifies the operator used in the expression. Can be `Equal`, `NotEqual`, `GreaterThan`, `GreaterThanEqual`, `LessThan`, `LessThanEqual`, `RegexMatch`, `RegexNotMatch`, `RegexMatchCaseInsensitive`, `RegexNotMatchCaseInsensitive`, `In`, or `NotIn`. |
11381138
| `set` _string array_ | Set provides a list of acceptable values for the expression. This should be used when Op is `In` or `NotIn`. |
11391139
| `value` _string_ | Value defines a single value to compare against the subject. This should be used when Op is not `In` or `NotIn`. Set and Value are mutually exclusive—only one should be set at a time. |
@@ -1471,7 +1471,7 @@ LoadBalancer defines the load balancing strategy for distributing traffic across
14711471
| --- | --- |
14721472
| `type` _string_ | Type specifies the load balancing algorithms to route traffic to the backend. Default is `roundrobin`. Can be `roundrobin`, `chash`, `ewma`, or `least_conn`. |
14731473
| `hashOn` _string_ | HashOn specified the type of field used for hashing, required when type is `chash`. Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
1474-
| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable). |
1474+
| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
14751475

14761476

14771477
_Appears in:_
@@ -1565,8 +1565,6 @@ _Appears in:_
15651565

15661566

15671567

1568-
1569-
15701568
#### UpstreamTimeout
15711569

15721570

0 commit comments

Comments
 (0)