Skip to content

Commit 9170ab6

Browse files
committed
📝 Updated documentation
1 parent 73ba6e0 commit 9170ab6

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 1.0.0
2+
- Updated chopper to v8.0.0
3+
- **BREAKING** Removed oauth_chopper authenticator. Now only the interceptor is needed.
4+
15
## 0.3.0
26
- Fixed issues where credentials where cleared when refreshing token failed on other errors than authorization errors.
37

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This can be override by providing a custom storage implementation.
3333
## Usage
3434

3535
Create a `oauth_chopper` client with the needed authorizationEndpoint, identifier and secret.
36-
Add the `oauth_chopper_authenticator` + `oauth_chopper_interceptor` to your chopper client.
36+
Add the `oauth_chopper_interceptor` to your chopper client.
3737
Request a OAuthGrant on the `oauth_chopper` client.
3838

3939
Example:
@@ -49,7 +49,6 @@ Example:
4949
/// Add the oauth authenticator and interceptor to the chopper client.
5050
final chopperClient = ChopperClient(
5151
baseUrl: Uri.parse('https://example.com'),
52-
authenticator: oauthChopper.authenticator(),
5352
interceptors: [
5453
oauthChopper.interceptor,
5554
],

lib/src/oauth_grant.dart

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ import 'package:oauth2/oauth2.dart' as oauth;
44
/// {@template oauth_grant}
55
/// Interface for a OAuth grant.
66
/// Grants are used to obtain credentials from an authorization server.
7+
///
8+
/// Currently available grants:
9+
/// - [ResourceOwnerPasswordGrant]
10+
/// - [ClientCredentialsGrant]
11+
/// - [AuthorizationCodeGrant]
12+
///
713
/// {@endtemplate}
814
abstract interface class OAuthGrant {
915
/// {@macro oauth_grant}

0 commit comments

Comments
 (0)