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

docs: Adjusted guard typing to union of connection classes #3385

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

aranvir
Copy link
Contributor

@aranvir aranvir commented Apr 13, 2024

Description

  • Update guard typing to ASGIConnection | Request | WebSocket to better reflect the object type that is passed to this handler
  • Adjusted documentation accordingly.

Closes

Closes #3356

fix:  update incorrect statement in middleware/authentication
@github-actions github-actions bot added area/docs This PR involves changes to the documentation area/handlers This PR involves changes to the handlers size: small pr/external Triage Required 🏥 This requires triage labels Apr 13, 2024
@aranvir aranvir changed the title Adjusted guard typing to union of connection classes Docs: Adjusted guard typing to union of connection classes Apr 13, 2024
Copy link

codecov bot commented Apr 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (7ac2bef) to head (3443502).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3385   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files         324      324           
  Lines       14774    14774           
  Branches     2346     2346           
=======================================
  Hits        14520    14520           
  Misses        116      116           
  Partials      138      138           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JacobCoffee
Copy link
Member

Could you base this off of the #3344 branch?

@aranvir aranvir force-pushed the docs/security-guards-update branch from e7f1161 to d914230 Compare April 13, 2024 17:42
@github-actions github-actions bot added the area/middleware This PR involves changes to the middleware label Apr 13, 2024
@aranvir
Copy link
Contributor Author

aranvir commented Apr 13, 2024

Could you base this off of the #3344 branch?

Checked out that branch and cherry picked my changes on top of that and force-pushed it on my fork branch - so should be the right history now.. should I change the target or is main okay?

@aranvir aranvir changed the title Docs: Adjusted guard typing to union of connection classes docs: Adjusted guard typing to union of connection classes Apr 19, 2024
@aranvir aranvir marked this pull request as ready for review April 19, 2024 08:14
@aranvir aranvir requested review from a team as code owners April 19, 2024 08:14
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3385

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This PR involves changes to the documentation area/handlers This PR involves changes to the handlers area/middleware This PR involves changes to the middleware pr/external pr/internal size: small Triage Required 🏥 This requires triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update usage/security/guards chapter
2 participants