-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Add documentation section on client authentication #6998
Add documentation section on client authentication #6998
Conversation
|
@Dreamsorcerer I am proposing this documentation enhancements, since there's been at least 2 people who were wondering how to do this recently. Let me know if you have any feedback. |
|
@webknjaz @Dreamsorcerer Please authorize workflows when you have a minute. |
Codecov Report
@@ Coverage Diff @@
## master #6998 +/- ##
=======================================
Coverage 97.50% 97.50%
=======================================
Files 103 103
Lines 29957 29957
Branches 3633 3633
=======================================
Hits 29211 29211
Misses 567 567
Partials 179 179
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Co-authored-by: Sam Bull <aa6bs0@sambull.org>
|
@Dreamsorcerer @webknjaz Comments addressed, please authorize pipes and review. |
|
@Dreamsorcerer Unlikely these failing tests on py 3.11 are related to the docs updates. Are we able to merge with failing tests? Or how do we resolve this? |
They don't block merging, they are marked as experimental. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine to me. @webknjaz Happy with adding this?
|
@webknjaz Nudge :) |
|
@Dreamsorcerer any other maintainers beside @webknjaz who could approve this? |
|
@asvetlov possibly? |
|
It's not like your changes will appear anywhere until we make a new release. There's no rush, we'll get back to it. |
|
@Dreamsorcerer I appreciate that. However, to clear my head it would be nice if a simple doc change could be merged in a reasonable timescale. I really would like to get back to the question how we could/should actually enhance the auth experience. Just being able to close out PRs as soon as possible seems good practice. It also is encouraging for the community of contributors :) |
|
Thanks @Dreamsorcerer |
What do these changes do?
Adds a dedicated section on client authentication using the
authargument for HTTP Basic Auth. Also explains how to configure other authentication flows including periodic renewal of credentials.Are there changes in behavior for the user?
No. Just makes it easier for developers to access authentication
aiohttpfeatures. Avoids users asking questions like this: #6908Related issue number
Issue #6915
Checklist
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange it to the pr id after creating the pr.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.