Skip to content
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

docs: fixed for the issue (#146) #147

Merged
merged 1 commit into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## v0.6.1

- `RetryConfig` allows users to configure `Jitter`. Any Jitter can be set by setting the `Jitter` object to `jitter` in `RetryConfig`. ([#144](https://github.com/mastodon-dart/mastodon-api/issues/144))
- Added links in `README`.

## v0.6.0

Expand Down
80 changes: 75 additions & 5 deletions README.md

Large diffs are not rendered by default.

68 changes: 31 additions & 37 deletions lib/src/service/v1/accounts/accounts_v1_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts HTTP/1.1
/// - POST /api/v1/accounts HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -96,7 +96,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/verify_credentials HTTP/1.1
/// - GET /api/v1/accounts/verify_credentials HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -136,7 +136,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - PATCH https://mastodon.example/api/v1/accounts/update_credentials HTTP/1.1
/// - PATCH /api/v1/accounts/update_credentials HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -167,7 +167,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - PATCH https://mastodon.example/api/v1/accounts/update_credentials HTTP/1.1
/// - PATCH /api/v1/accounts/update_credentials HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -192,7 +192,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - PATCH https://mastodon.example/api/v1/accounts/update_credentials HTTP/1.1
/// - PATCH /api/v1/accounts/update_credentials HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -222,7 +222,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id HTTP/1.1
/// - GET /api/v1/accounts/:id HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -260,7 +260,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id/statuses HTTP/1.1
/// - GET /api/v1/accounts/:id/statuses HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -295,7 +295,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id/followers HTTP/1.1
/// - GET /api/v1/accounts/:id/followers HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -324,7 +324,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id/following HTTP/1.1
/// - GET /api/v1/accounts/:id/following HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -350,7 +350,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id/featured_tags HTTP/1.1
/// - GET /api/v1/accounts/:id/featured_tags HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -371,7 +371,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/:id/lists HTTP/1.1
/// - GET /api/v1/accounts/:id/lists HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -407,7 +407,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/follow HTTP/1.1
/// - POST /api/v1/accounts/:id/follow HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -435,7 +435,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/unfollow HTTP/1.1
/// - POST /api/v1/accounts/:id/unfollow HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -460,7 +460,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/remove_from_followers HTTP/1.1
/// - POST /api/v1/accounts/:id/remove_from_followers HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -486,7 +486,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/block HTTP/1.1
/// - POST /api/v1/accounts/:id/block HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -511,7 +511,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/unblock HTTP/1.1
/// - POST /api/v1/accounts/:id/unblock HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -542,7 +542,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/mute HTTP/1.1
/// - POST /api/v1/accounts/:id/mute HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -569,7 +569,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/unmute HTTP/1.1
/// - POST /api/v1/accounts/:id/unmute HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -595,7 +595,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/pin HTTP/1.1
/// - POST /api/v1/accounts/:id/pin HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -620,7 +620,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/unpin HTTP/1.1
/// - POST /api/v1/accounts/:id/unpin HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -649,7 +649,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/accounts/:id/note HTTP/1.1
/// - POST /api/v1/accounts/:id/note HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -675,7 +675,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/relationships HTTP/1.1
/// - GET /api/v1/accounts/relationships HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -701,7 +701,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/familiar_followers HTTP/1.1
/// - GET /api/v1/accounts/familiar_followers HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -734,7 +734,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/search HTTP/1.1
/// - GET /api/v1/accounts/search HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -767,7 +767,7 @@ abstract class AccountsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/accounts/lookup HTTP/1.1
/// - GET /api/v1/accounts/lookup HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down Expand Up @@ -1732,12 +1732,10 @@ class _AccountsV1Service extends BaseService implements AccountsV1Service {
}) async =>
super.transformMultiDataResponse(
await super.get(
UserContext.oauth2Only,
'/api/v1/accounts/relationships',
queryParameters: {
'id[]': accountIds,
}
),
UserContext.oauth2Only, '/api/v1/accounts/relationships',
queryParameters: {
'id[]': accountIds,
}),
dataBuilder: Relationship.fromJson,
);

Expand All @@ -1747,12 +1745,8 @@ class _AccountsV1Service extends BaseService implements AccountsV1Service {
}) async =>
super.transformMultiDataResponse(
await super.get(
UserContext.oauth2Only,
'/api/v1/accounts/familiar_followers',
queryParameters: {
'id[]': accountIds
}
),
UserContext.oauth2Only, '/api/v1/accounts/familiar_followers',
queryParameters: {'id[]': accountIds}),
dataBuilder: FamiliarFollower.fromJson,
);

Expand Down
6 changes: 3 additions & 3 deletions lib/src/service/v1/apps/apps_v1_service.dart
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ abstract class AppsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/apps HTTP/1.1
/// - GET /api/v1/apps HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -64,7 +64,7 @@ abstract class AppsV1Service {
///
/// ## Endpoint Url
///
/// - GET https://mastodon.example/api/v1/apps/verify_credentials HTTP/1.1
/// - GET /api/v1/apps/verify_credentials HTTP/1.1
///
/// ## Authentication Methods
///
Expand All @@ -86,7 +86,7 @@ abstract class AppsV1Service {
///
/// ## Endpoint Url
///
/// - POST https://mastodon.example/api/v1/emails/confirmation HTTP/1.1
/// - POST /api/v1/emails/confirmation HTTP/1.1
///
/// ## Authentication Methods
///
Expand Down
Loading