Deprecate the auth API #2684
Merged
Deprecate the auth API #2684
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
StephenButtolph
added
the
documentation
joshua-kim
approved these changes
Jan 31, 2024
dhrubabasu
approved these changes
Jan 31, 2024
aaronbuchwald
approved these changes
Jan 31, 2024
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.
Why this should be merged
The Auth API is really a hammer looking for a nail. In reality it is almost never recommended to use the Auth API. Avalanchego should never expose its APIs publicly, so it should never need to authenticate its callers. If caller identification is required, then it should almost certainly be done at a higher level than the end server (like by a load balancer).
How this works
Notifies any (I doubt there are any) users of the Auth API that it may be removed in a future release.
How this was tested
N/A