feat(dart-dio): add methods to remove auth tokens in api client#23386
Open
nopjar wants to merge 1 commit intoOpenAPITools:masterfrom
Open
feat(dart-dio): add methods to remove auth tokens in api client#23386nopjar wants to merge 1 commit intoOpenAPITools:masterfrom
nopjar wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
There is currently no way to easily remove a previously set auth token. Adding these methods will provide a convenient way to 'revoke' tokens. Design-Choice: Adding those new methods is a better alternative as just making the values of existing methods nullable, as e.g. #setBasicAuth(String, String, String) has two value parameters, which then would have to be checked for nullability and special handling would be required if only one value is null. This would result in a less clear API. By adding new methods following the naming #removeXY(String) no ambiguity is added and a clear API is kept.
This file contains hidden or 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
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.
There is currently no way to easily remove a previously set auth token. Adding these methods will provide a convenient way to 'revoke' tokens.
Design-Choice:
Adding those new methods is a better alternative as just making the values of existing methods nullable, as e.g. #setBasicAuth(String, String, String) has two value parameters, which then would have to be checked for nullability and special handling would be required if only one value is null. This would result in a less clear API. By adding new methods following the naming #removeXY(String) no ambiguity is added and a clear API is kept.
Output was tested and is working as expected.
Mentions as this only targets Dart code (like required in the PR checklist): @jaumard @josh-burton @amondnet @sbu-WBT @kuhnroyal @agilob @ahmednfwela
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Added removal methods for auth credentials in
dart-dioAPI clients so apps can revoke tokens/keys at runtime without recreating the client.removeOAuthToken(name)removes tokens fromOAuthInterceptor.removeBearerAuth(name)removes tokens fromBearerAuthInterceptor.removeBasicAuth(name)removes credentials fromBasicAuthInterceptor.removeApiKey(name)removes keys fromApiKeyAuthInterceptor.Written for commit 76736b2. Summary will update on new commits.