spring-projects / spring-projects/spring-security
Improve documentation for openid package with hint on OpenID version
@BavariaBlue is already working on this.
Since May 31, 2021.
- Dominant language
- Java
- Stars
- 9.6k
- Forks
- 6.3k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 52
Description
As we all know, the spring-security-oauth2 project is marked as deprecated.
In the migration guide, the Spring team recommends a switch to spring-security.OAuth.
While this migration seems to be clear for the overall OAuth2 protocol implementation, the documentation may miss one crucial point.
If newbies don't look closely, they may confuse the package "openid" in "spring-security" with "open id connect (1.0)".
This confusion is reinforced by the following note:
The package openid inside of spring-security seems to be deprecated. The note tells us: "The OpenID 1.0 and 2.0 protocols have been deprecated and users are encouraged to migrate to OpenID Connect, which is supported by spring-security-oauth2." written in https://github.com/spring-projects/spring-security/wiki/OAuth-2.0-Migration-Guide
I'd suggest to rewrite this note or the naming of the package 👍
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.