Skip to content

Commit b746e41

Browse files
authored
fix: JWT documentation link to point to the correct resource (#3907)
The previous link in the documentation led to a page unrelated to JWT. Updated the URL to https://www.ory.sh/docs/oauth2-oidc/jwt-access-token, which provides proper JWT guidance.
1 parent 5d8635c commit b746e41

File tree

9 files changed

+9
-9
lines changed

9 files changed

+9
-9
lines changed

.schema/config.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,7 @@
874874
},
875875
"access_token": {
876876
"type": "string",
877-
"description": "Defines access token type. jwt is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens",
877+
"description": "Defines access token type. jwt is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token",
878878
"enum": ["opaque", "jwt"],
879879
"default": "opaque"
880880
},

client/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ type Client struct {
303303
// OAuth 2.0 Access Token Strategy
304304
//
305305
// AccessTokenStrategy is the strategy used to generate access tokens.
306-
// Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens
306+
// Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token
307307
// Setting the stragegy here overrides the global setting in `strategies.access_token`.
308308
AccessTokenStrategy string `json:"access_token_strategy,omitempty" db:"access_token_strategy" faker:"-"`
309309

internal/config/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ strategies:
365365
# You may use JSON Web Tokens as access tokens.
366366
#
367367
# But seriously. Don't do that. It's not a great idea and has a ton of caveats and subtle security implications. Read more:
368-
# -> https://www.ory.sh/docs/hydra/advanced#json-web-tokens
368+
# -> https://www.ory.sh/docs/oauth2-oidc/jwt-access-token
369369
#
370370
# access_token: jwt
371371

internal/httpclient/api/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2637,7 +2637,7 @@ components:
26372637
OAuth 2.0 Access Token Strategy
26382638
26392639
AccessTokenStrategy is the strategy used to generate access tokens.
2640-
Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens
2640+
Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token
26412641
Setting the stragegy here overrides the global setting in `strategies.access_token`.
26422642
type: string
26432643
allowed_cors_origins:

internal/httpclient/docs/OAuth2Client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**AccessTokenStrategy** | Pointer to **string** | OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens Setting the stragegy here overrides the global setting in `strategies.access_token`. | [optional]
7+
**AccessTokenStrategy** | Pointer to **string** | OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token Setting the stragegy here overrides the global setting in `strategies.access_token`. | [optional]
88
**AllowedCorsOrigins** | Pointer to **[]string** | | [optional]
99
**Audience** | Pointer to **[]string** | | [optional]
1010
**AuthorizationCodeGrantAccessTokenLifespan** | Pointer to **string** | Specify a time duration in milliseconds, seconds, minutes, hours. | [optional]

internal/httpclient/model_o_auth2_client.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec/api.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@
612612
"description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.",
613613
"properties": {
614614
"access_token_strategy": {
615-
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
615+
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
616616
"type": "string"
617617
},
618618
"allowed_cors_origins": {

spec/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,7 @@
874874
},
875875
"access_token": {
876876
"type": "string",
877-
"description": "Defines access token type. jwt is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens",
877+
"description": "Defines access token type. jwt is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token",
878878
"enum": ["opaque", "jwt"],
879879
"default": "opaque"
880880
},

spec/swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2637,7 +2637,7 @@
26372637
"title": "OAuth 2.0 Client",
26382638
"properties": {
26392639
"access_token_strategy": {
2640-
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
2640+
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/oauth2-oidc/jwt-access-token\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
26412641
"type": "string"
26422642
},
26432643
"allowed_cors_origins": {

0 commit comments

Comments
 (0)