Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minimize duplication in OIDC Bearer and Code flow docs #45142

Open
sberyozkin opened this issue Dec 16, 2024 · 1 comment
Open

Minimize duplication in OIDC Bearer and Code flow docs #45142

sberyozkin opened this issue Dec 16, 2024 · 1 comment
Labels
area/housekeeping Issue type for generalized tasks not related to bugs or enhancements area/oidc area/security

Comments

@sberyozkin
Copy link
Member

Description

OIDC bearer and code flow reference docs start with some flow specific content and then cover the material which is relevant to both flows, such the discovery, userinfo, token access.

Sometimes one of these docs links to another one and it can become very confusing.

Implementation ideas

Even though there is some shared content, moving it all into a dedicated doc to be referenced from both OIDC bearer and code flow docs may not work as each each flow has some nuances or specifics. For example, when dealing the bearer tokens, it is irrelevant how the OIDC token endpoint can be discovered since the OIDC token acquisition only works during the code flow, etc.

It looks like, the simplest approach is to do the clean duplication, avoiding each of the docs linking to some parts of the other docs. For example, currently, OIDC bearer doc section on the OIDC request filters links to the the relevant section in the OIDC code flow doc - forcing users to switch focus to another, more complex code flow reference doc, even though they may not be interested in it

@sberyozkin sberyozkin added the area/housekeeping Issue type for generalized tasks not related to bugs or enhancements label Dec 16, 2024
Copy link

quarkus-bot bot commented Dec 16, 2024

/cc @pedroigor (bearer-token,oidc)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/housekeeping Issue type for generalized tasks not related to bugs or enhancements area/oidc area/security
Projects
None yet
Development

No branches or pull requests

1 participant