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

documentation: Enhancing documentation on Spring Security integration limitations in DGS Framework #1767

Open
appreciated opened this issue Jan 8, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation investigate

Comments

@appreciated
Copy link

What are you missing in the docs

The current documentation lacks detailed information about the limitations of the Spring Security integration with the DGS Framework. Specifically, it's not clear where SecurityContextHolder can be appropriately used and where it cannot. This leaves a gap in understanding the full scope of security implementations within the framework.

Some Thoughts which Information should be included in the updated Documentation

I propose to include a section in the documentation that addresses the limitations of the Spring Security integration in the DGS Framework. This section should clarify the contexts in which SecurityContextHolder is applicable and areas where its use is not supported.

Additionally, it would be beneficial to include a direct link to the section on the DGS documentation site that discusses using Spring features like SecurityContextHolder within a CompletableFuture. This can be found at Using Spring Features such as SecurityContextHolder inside a CompletableFuture. This link will guide users to more detailed information on this specific topic, enhancing the overall utility of the documentation.

@appreciated appreciated added the documentation Improvements or additions to documentation label Jan 8, 2024
@appreciated appreciated changed the title documentation: Enhancing Documentation on Spring Security Integration Limitations in DGS Framework documentation: Enhancing documentation on Spring Security integration limitations in DGS Framework Jan 8, 2024
@srinivasankavitha
Copy link
Contributor

Thanks for the detailed issue. We will update our docsto clarify this better.

@mikita-reshatko-epam
Copy link

Hi, it is also would be nice to have documented limitations about https://docs.spring.io/spring-security/reference/servlet/integrations/mvc.html#mvc-authentication-principal annotation as I can see it is not working as well.

@srinivasankavitha
Copy link
Contributor

Thanks for the feedback. We will review our security docs and update accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation investigate
Projects
None yet
Development

No branches or pull requests

5 participants