Skip to content

Added docs for the OAuth2introspection library #818

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

wcabus
Copy link
Member

@wcabus wcabus commented Jul 14, 2025

This PR adds documentation for the ASP.NET Core OAuth 2.0 introspection authentication handler library, previously known as IdentityModel.AspNetCore.OAuth2Introspection:

  • Docs added in a new folder introspection-auth-handler, which is included in astro.config.mjs
  • Added a new card on the docs homepage to showcase this FOSS library
  • Fixed references on identityserver/apis/aspnetcore/reference.md to the old library
  • Updated the linkchecker NPM task to reflect the settings used during builds, and added an alternative that runs on Windows machines

@wcabus wcabus requested a review from khalidabuhakmeh July 14, 2025 14:00
@wcabus wcabus self-assigned this Jul 14, 2025
@khalidabuhakmeh
Copy link
Contributor

Should we be clear about it being "OAuth" and not just "Auth"?

@wcabus
Copy link
Member Author

wcabus commented Jul 15, 2025

Should we be clear about it being "OAuth" and not just "Auth"?

You mean in astro.config.mjs? The "Auth" there is an abbreviation of "Authentication", the result of a discussion on how to format this entry in the sidebar. The other choices were too long and didn't fit on a single line.

@khalidabuhakmeh
Copy link
Contributor

khalidabuhakmeh commented Jul 15, 2025

Maybe we should call it "OAuth Introspection"?

CleanShot 2025-07-15 at 14 26 33@2x

Another option.

CleanShot 2025-07-15 at 14 28 13@2x

@wcabus
Copy link
Member Author

wcabus commented Jul 16, 2025

I can live with OAuth 2.0 Introspection as the title there.
We did have a discussion somewhere else though where the general preference was to allude that this is about an ASP.NET Core authentication handler: if we give this section a generic "introspection" title, people might think it's a library for introspecting tokens anywhere (mobile, desktop, ...)

@wcabus
Copy link
Member Author

wcabus commented Jul 17, 2025

@khalidabuhakmeh How about this for the sidebar?
image

@maartenba
Copy link
Member

Does the docs need updating after https://github.com/DuendeSoftware/issues/issues/457 ?

@wcabus
Copy link
Member Author

wcabus commented Jul 22, 2025

Does the docs need updating after DuendeSoftware/issues#457 ?

To verify, but normally I already took into account the expected new naming.

Copy link
Member

@maartenba maartenba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few suggestions

@wcabus wcabus force-pushed the wca/introspection-foss-docs branch from 0fc744b to da8fffa Compare July 25, 2025 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants