openiddict / openiddict/openiddict-documentation

Add a page describing the degraded mode and explaining how to enable it

Open
#39 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
106
Forks
85
Avg merge
1m
Merged PRs (30d)
2

Description

Confirm you've already contributed to this project or that you sponsor it
  • I confirm I'm a sponsor or a contributor
Describe the solution you'd like

Enabling the degraded mode has multiple effects that should be listed in the documentation:

// Explicitly disable all the features that are implicitly excluded when the degraded mode is active.
if (options.EnableDegradedMode)
{
    options.DisableAuthorizationStorage = options.DisableTokenStorage = options.DisableRollingRefreshTokens = true;
    options.IgnoreEndpointPermissions = options.IgnoreGrantTypePermissions = true;
    options.IgnoreResponseTypePermissions = options.IgnoreScopePermissions = true;
    options.UseReferenceAccessTokens = options.UseReferenceRefreshTokens = false;
}

https://github.com/openiddict/openiddict-core/blob/186d3d8ddb84d600876e620fe9c236748a7e885b/src/OpenIddict.Server/OpenIddictServerConfiguration.cs#L31-L38

Additional context

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/OpenIddict.Server/OpenIddictServerConfiguration.cs around lines 31-38 and review the EnableDegradedMode option and its related settings. Add a documentation page explaining how to enable degraded mode and list each effect shown in the issue; done means the behavior and configuration steps are clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.