Skip to content

Commit 9abcfe0

Browse files
committed
update CRD doc
1 parent 817720b commit 9abcfe0

File tree

8 files changed

+12
-1603
lines changed

8 files changed

+12
-1603
lines changed

api/v2/apisixconsumer_types.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,7 @@ type ApisixConsumerJwtAuthValue struct {
140140
// PrivateKey is the private key used to sign the JWT (for asymmetric algorithms).
141141
PrivateKey string `json:"private_key" yaml:"private_key,omitempty"`
142142
// Algorithm specifies the signing algorithm.
143-
// Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`.
144-
// Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms.
143+
// Can be `HS256`, `HS512`, `RS256`, or `ES256`.
145144
Algorithm string `json:"algorithm,omitempty" yaml:"algorithm,omitempty"`
146145
// Exp is the token expiration period in seconds.
147146
Exp int64 `json:"exp,omitempty" yaml:"exp,omitempty"`

api/v2/apisixroute_types.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,6 @@ type ApisixRouteHTTPMatch struct {
156156

157157
// FilterFunc is a user-defined function for advanced request filtering.
158158
// The function can use Nginx variables through the `vars` parameter.
159-
// This field is supported in APISIX but not in API7 Enterprise.
160159
FilterFunc string `json:"filter_func,omitempty" yaml:"filter_func,omitempty"`
161160
}
162161

@@ -252,7 +251,7 @@ type ApisixRouteStreamBackend struct {
252251
// ApisixRouteHTTPMatchExpr represents a binary expression used to match requests based on Nginx variables.
253252
type ApisixRouteHTTPMatchExpr struct {
254253
// Subject defines the left-hand side of the expression.
255-
// It can be any [built-in variable](/apisix/reference/built-in-variables) or string literal.
254+
// It can be any [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable) or string literal.
256255
Subject ApisixRouteHTTPMatchExprSubject `json:"subject" yaml:"subject"`
257256

258257
// Op specifies the operator used in the expression.

api/v2/apisixupstream_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ type LoadBalancer struct {
182182
// When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
183183
// When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
184184
// When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of
185-
// [built-in variables](/enterprise/reference/built-in-variables).
185+
// [APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable).
186186
Key string `json:"key,omitempty" yaml:"key,omitempty"`
187187
}
188188

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,7 @@ spec:
168168
algorithm:
169169
description: |-
170170
Algorithm specifies the signing algorithm.
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.
171+
Can be `HS256`, `HS512`, `RS256`, or `ES256`.
173172
type: string
174173
base64_secret:
175174
description: Base64Secret indicates whether the secret

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

Lines changed: 1 addition & 2 deletions
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 [built-in variable](/apisix/reference/built-in-variables) or string literal.
206+
It can be any [APISIX variable](https://apisix.apache.org/docs/apisix/apisix-variable) or string literal.
207207
properties:
208208
name:
209209
description: Name is the name of the header or
@@ -233,7 +233,6 @@ 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.
237236
type: string
238237
hosts:
239238
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-
[built-in variables](/enterprise/reference/built-in-variables).
282+
[APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable).
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-
[built-in variables](/enterprise/reference/built-in-variables).
527+
[APISIX variables](https://apisix.apache.org/docs/apisix/apisix-variable).
528528
type: string
529529
type:
530530
default: roundrobin

0 commit comments

Comments
 (0)