You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/latest/reference/api-reference.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -366,7 +366,7 @@ LoadBalancer describes the load balancing parameters.
366
366
| --- | --- |
367
367
|`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`. |
368
368
|`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). |
370
370
371
371
372
372
_Appears in:_
@@ -788,7 +788,7 @@ ApisixConsumerJwtAuthValue defines configuration for JWT authentication.
788
788
|`secret`_string_| Secret is the shared secret used to sign the JWT (for symmetric algorithms). |
789
789
|`public_key`_string_| PublicKey is the public key used to verify JWT signatures (for asymmetric algorithms). |
790
790
|`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. |
792
792
|`exp`_integer_| Exp is the token expiration period in seconds. |
793
793
|`base64_secret`_boolean_| Base64Secret indicates whether the secret is base64-encoded. |
794
794
|`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
1084
1084
|`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). |
1085
1085
|`remoteAddrs`_string array_| RemoteAddrs is a list of source IP addresses or CIDR ranges to match. Supports both IPv4 and IPv6 formats. |
1086
1086
|`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. |
1088
1088
1089
1089
1090
1090
_Appears in:_
@@ -1099,7 +1099,7 @@ ApisixRouteHTTPMatchExpr represents a binary expression used to match requests b
1099
1099
1100
1100
| Field | Description |
1101
1101
| --- | --- |
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. |
1103
1103
|`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`. |
1104
1104
|`set`_string array_| Set provides a list of acceptable values for the expression. This should be used when Op is `In` or `NotIn`. |
1105
1105
|`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. |
|`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. |
1137
1137
|`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`. |
1138
1138
|`set`_string array_| Set provides a list of acceptable values for the expression. This should be used when Op is `In` or `NotIn`. |
1139
1139
|`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
1471
1471
| --- | --- |
1472
1472
|`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`. |
1473
1473
|`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). |
0 commit comments