Skip to content

Commit

Permalink
Merge pull request #108 from mastodon-dart/add-links-v0.3.2
Browse files Browse the repository at this point in the history 
docs: add links
  • Loading branch information
@myConsciousness
myConsciousness committed Jan 1, 2023
2 parents 748b5e2 + b626add commit 0b1d9c4
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 8 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Release Note

## v0.3.2

- Added links in `README`.

## v0.3.1

- Supported `mutes API methods`. ([#10](https://github.com/mastodon-dart/mastodon-api/issues/10))
Expand Down
37 changes: 31 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,19 +236,44 @@ Future<void> main() async {
| [GET /api/v1/accounts/familiar_followers](https://docs.joinmastodon.org/methods/accounts/#familiar_followers) | [lookupFamiliarFollowers](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupFamiliarFollowers.html) |
| [GET /api/v1/accounts/search](https://docs.joinmastodon.org/methods/accounts/#search) | [searchAccounts](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/searchAccounts.html) |
| [GET /api/v1/accounts/lookup](https://docs.joinmastodon.org/methods/accounts/#lookup) | [lookupAccountFromWebFingerAddress](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupAccountFromWebFingerAddress.html) |
| [GET /api/v1/preferences](https://docs.joinmastodon.org/methods/preferences/#get) | [lookupPreferences](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupPreferences.html) |
| [GET /api/v1/featured_tags](https://docs.joinmastodon.org/methods/featured_tags/#get) | [lookupOwnedFeaturedTags](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupOwnedFeaturedTags.html) |
| [POST /api/v1/featured_tags](https://docs.joinmastodon.org/methods/featured_tags/#feature) | [createFeaturedTag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/createFeaturedTag.html) |
| [DELETE /api/v1/featured_tags/:id](https://docs.joinmastodon.org/methods/featured_tags/#unfeature-a-tag-unfeature) | [destroyFeaturedTag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/destroyFeaturedTag.html) |
| [GET /api/v1/featured_tags/suggestions](https://docs.joinmastodon.org/methods/featured_tags/#suggestions) | [lookupSuggestedTags](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupSuggestedTags.html) |
| [GET /api/v1/followed_tags](https://docs.joinmastodon.org/methods/followed_tags/#get) | [lookupFollowedTags](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupFollowedTags.html) |
| [DELETE /api/v1/suggestions/:account_id](https://docs.joinmastodon.org/methods/suggestions/#remove) | [destroyFollowSuggestion](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/destroyFollowSuggestion.html) |
| [GET /api/v1/tags/:id](https://docs.joinmastodon.org/methods/tags/#get) | [lookupTag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupTag.html) |
| [POST /api/v1/tags/:id/follow](https://docs.joinmastodon.org/methods/tags/#follow) | [createFollowingTag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/createFollowingTag.html) |
| [POST /api/v1/tags/:id/unfollow](https://docs.joinmastodon.org/methods/tags/#unfollow) | [destroyFollowingTag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/destroyFollowingTag.html) |
| [POST /api/v1/reports](https://docs.joinmastodon.org/methods/reports/#post) | [createReport](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/createReport.html) |
| [GET /api/v1/endorsements](https://docs.joinmastodon.org/methods/endorsements/#get) | [lookupFeaturedProfiles](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupFeaturedProfiles.html) |
| [GET /api/v1/mutes](https://docs.joinmastodon.org/methods/mutes/#get) | [lookupMutedAccounts](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupMutedAccounts.html) |
| [GET /api/v1/favourites](https://docs.joinmastodon.org/methods/favourites/#get) | [lookupFavouritedStatuses](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupFavouritedStatuses.html) |
| [GET /api/v1/blocks](https://docs.joinmastodon.org/methods/blocks/#get) | [lookupBlockedAccounts](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupBlockedAccounts.html) |
| [GET /api/v1/bookmarks](https://docs.joinmastodon.org/methods/bookmarks/#get) | [lookupBookmarkedStatuses](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV1Service/lookupBookmarkedStatuses.html) |

#### 1.3.4.2. v2

| [GET /api/v2/suggestions](https://docs.joinmastodon.org/methods/suggestions/#v2) | [lookupFollowSuggestions](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/AccountsV2Service/lookupFollowSuggestions.html) |

### 1.3.5. Timelines Service

#### 1.3.5.1. v1

| **Endpoint** | **Method Name** |
| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [GET /api/v1/timelines/public](https://docs.joinmastodon.org/methods/timelines/#public) | [lookupPublicTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupPublicTimeline.html) |
| [GET /api/v1/timelines/tag/:hashtag](https://docs.joinmastodon.org/methods/timelines/#tag) | [lookupTimelineByHashtag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupTimelineByHashtag.html) |
| [GET /api/v1/timelines/home](https://docs.joinmastodon.org/methods/timelines/#home) | [lookupHomeTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupHomeTimeline.html) |
| [GET /api/v1/timelines/list/:list_id](https://docs.joinmastodon.org/methods/timelines/#list) | [lookupListTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupListTimeline.html) |
| **Endpoint** | **Method Name** |
| ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| [GET /api/v1/timelines/public](https://docs.joinmastodon.org/methods/timelines/#public) | [lookupPublicTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupPublicTimeline.html) |
| [GET /api/v1/timelines/tag/:hashtag](https://docs.joinmastodon.org/methods/timelines/#tag) | [lookupTimelineByHashtag](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupTimelineByHashtag.html) |
| [GET /api/v1/timelines/home](https://docs.joinmastodon.org/methods/timelines/#home) | [lookupHomeTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupHomeTimeline.html) |
| [GET /api/v1/timelines/list/:list_id](https://docs.joinmastodon.org/methods/timelines/#list) | [lookupListTimeline](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupListTimeline.html) |
| [GET /api/v1/conversations](https://docs.joinmastodon.org/methods/conversations/#get) | [lookupConversations](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupConversations.html) |
| [DELETE /api/v1/conversations/:id](https://docs.joinmastodon.org/methods/conversations/#delete) | [destroyConversation](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/destroyConversation.html) |
| [POST /api/v1/conversations/:id/read](https://docs.joinmastodon.org/methods/conversations/#read) | [createMarkConversationAsRead](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/createMarkConversationAsRead.html) |
| [GET /api/v1/markers](https://docs.joinmastodon.org/methods/markers/#get) | [lookupStatusSnapshot](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupStatusSnapshot.html) |
| [GET /api/v1/markers](https://docs.joinmastodon.org/methods/markers/#get) | [lookupNotificationSnapshot](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/lookupNotificationSnapshot.html) |
| [POST /api/v1/markers](https://docs.joinmastodon.org/methods/markers/#create) | [createStatusSnapshot](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/createStatusSnapshot.html) |
| [POST /api/v1/markers](https://docs.joinmastodon.org/methods/markers/#create) | [createNotificationSnapshot](https://pub.dev/documentation/mastodon_api/latest/mastodon_api/TimelinesV1Service/createNotificationSnapshot.html) |

### 1.3.6. Statuses Service

Expand Down
2 changes: 1 addition & 1 deletion lib/src/service/v1/timelines/timelines_v1_service.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ abstract class TimelinesV1Service {
///
/// ## Reference
///
/// - https://docs.joinmastodon.org/methods/conversations/#delete
/// - https://docs.joinmastodon.org/methods/conversations/#read
Future<MastodonResponse<Conversation>> createMarkConversationAsRead({
required String conversationId,
});
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: mastodon_api
description: The easiest and powerful Dart/Flutter library for Mastodon API.
version: 0.3.1
version: 0.3.2
repository: https://github.com/mastodon-dart/mastodon-api
issue_tracker: https://github.com/mastodon-dart/mastodon-api/issues

Expand Down

0 comments on commit 0b1d9c4

Please sign in to comment.