Skip to content

Commit 28d36db

Browse files
AlinsRanCopilot
andcommitted
docs: remove JWT algorithm support note
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d8c4d62 commit 28d36db

4 files changed

Lines changed: 1 addition & 4 deletions

File tree

api/v2/apisixconsumer_types.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,6 @@ type ApisixConsumerJwtAuthValue struct {
146146
PrivateKey string `json:"private_key,omitempty" yaml:"private_key,omitempty"`
147147
// Algorithm specifies the signing algorithm.
148148
// Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`.
149-
// Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms.
150149
Algorithm string `json:"algorithm,omitempty" yaml:"algorithm,omitempty"`
151150
// Exp is the token expiration period in seconds.
152151
Exp int64 `json:"exp,omitempty" yaml:"exp,omitempty"`

config/crd-nocel/apisix.apache.org_v2.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ spec:
180180
description: |-
181181
Algorithm specifies the signing algorithm.
182182
Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`.
183-
Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms.
184183
type: string
185184
base64_secret:
186185
description: Base64Secret indicates whether the secret

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,6 @@ spec:
177177
description: |-
178178
Algorithm specifies the signing algorithm.
179179
Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`.
180-
Currently APISIX only supports `HS256`, `HS512`, `RS256`, and `ES256`. API7 Enterprise supports all algorithms.
181180
type: string
182181
base64_secret:
183182
description: Base64Secret indicates whether the secret

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -793,7 +793,7 @@ and unset algorithm do not require any key field.
793793
| `secret` _string_ | Secret is the shared secret used to sign the JWT (for symmetric algorithms). |
794794
| `public_key` _string_ | PublicKey is the public key used to verify JWT signatures (for asymmetric algorithms). |
795795
| `private_key` _string_ | PrivateKey is the private key used to sign the JWT (for asymmetric algorithms). |
796-
| `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. |
796+
| `algorithm` _string_ | Algorithm specifies the signing algorithm. Can be `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, `RS512`, `ES256`, `ES384`, `ES512`, `PS256`, `PS384`, `PS512`, or `EdDSA`. |
797797
| `exp` _integer_ | Exp is the token expiration period in seconds. |
798798
| `base64_secret` _boolean_ | Base64Secret indicates whether the secret is base64-encoded. |
799799
| `lifetime_grace_period` _integer_ | LifetimeGracePeriod is the allowed clock skew in seconds for token expiration. |

0 commit comments

Comments
 (0)