lib: add Basic Authentication to HTTP extension #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Query whether it's worth adding a function to add the basic auth header into requests. |
Previously, the only way to enable Basic Authentication was to manually construct a request object, adding the Authorization header appropriately and then using do_request. This change allows users to specify a Basic Authentication user/pass for all request using the head, get and post functions. Requests returned by request, get_request and post_request are not affected by the state of the Basic Authentication parameter as they can be easily altered using the wither pattern shown in the request documentation example. No validation of the state of the auth parameter is made and this is the responsibility of the caller of lib.HTTP/lib.HTTPWithContext.
andrewkroh
approved these changes
Feb 27, 2023
This convenience method allows users to directly add basic auth to an existing constructed request map without needing to use a wither pattern. Also update the wither pattern example to correctly reflect the actions that need to be done if using that approach.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the only way to enable Basic Authentication was to manually construct a request object, adding the Authorization header appropriately and then using do_request. This change allows users to specify a Basic Authentication user/pass for all request using the head, get and post functions. Requests returned by request, get_request and post_request are not affected by the state of the Basic Authentication parameter as they can be easily altered using the wither pattern shown in the request documentation example.
No validation of the state of the auth parameter is made and this is the responsibility of the caller of
lib.HTTP/lib.HTTPWithContext.For elastic/beats#34609