hippofish/docs/api-change.md

120 lines
4.1 KiB
Markdown
Raw Normal View History

# Changes to the Firefish API
2023-09-26 06:08:43 +02:00
Breaking changes are indicated by the :warning: icon.
2024-04-21 05:24:41 +02:00
## Unreleased
2024-04-21 22:37:57 +02:00
- Added `filter` optional parameter to `notes/renotes` endpoint to filter the types of renotes. It can take the following values:
- `all` (default)
- `renote`
- `quote`
- :warning: Removed the following optional parameters in `notes/reactions`, as they were not taken into account due to a bug:
2024-04-21 05:24:41 +02:00
- `sinceId`
- `untilId`
2024-04-13 14:34:20 +02:00
## v20240413
2024-04-13 13:03:02 +02:00
- :warning: Removed `patrons` endpoint.
2024-04-04 23:44:16 +02:00
## v20240405
2024-04-01 05:06:59 +02:00
- Added `notes/history` endpoint.
2024-03-18 18:13:38 +01:00
## v20240319
- :warning: `followingCount` and `followersCount` in `users/show` will be `null` (instead of 0) if these values are unavailable.
- :warning: `admin/search/index-all` is removed since posts are now indexed automatically.
- New optional parameters are added to `notes/search` endpoint:
- `sinceDate`
- `untilDate`
- `withFiles`
- `searchCwAndAlt`
- Added `enableGuestTimeline` field to the response of `meta` and `admin/meta`, and the request of `admin/update-meta` (optional).
2024-03-01 03:15:40 +01:00
## v20240301
- With the addition of new features, the following endpoints are added:
- check your follow requests that haven't been approved
- `following/requests/sent`
- per-user reply mutes
- `reply-mute/create`
- `reply-mute/delete`
- `reply-mute/list`
- :warning: The following (horrible) endpoints are removed:
- `admin/vacuum`
- `reset-db`
2024-02-27 20:50:14 +01:00
## v20240228
- :warning: The following endpoints are removed:
- `charts/ap-request`
- `charts/drive`
- `charts/federation`
- `charts/hashtag`
- `charts/instance`
- `charts/notes`
- `charts/user/drive`
- `charts/user/following`
- `charts/user/notes`
- `charts/user/reactions`
- `charts/users`
2024-02-21 00:44:06 +01:00
## v20240221
2024-02-20 09:39:32 +01:00
- Added `admin/set-emoji-moderator` endpoint, where moderators can give these permissions to regular users:
- `add`: Add new custom emojis, set tag/category/license to newly added custom emojis
- `mod`: `add` permission + edit the name/category/tag/license of the existing custom emojis
- `full`: `mod` permission + delete existing custom emojis
- Emoji moderators are able to access to the endpoints under `admin/emoji/`
2024-02-20 19:25:45 +01:00
- Removed `lang` from the response of `i` and the request parameter of `i/update`.
- Added `notes/make-private` endpoint.
2024-02-20 09:39:32 +01:00
2024-02-16 16:00:23 +01:00
## v20240217
- :warning: Since the auto NSFW media detection has been removed, these endpoints are affected:
- `admin/meta`
- These parameter(s) are removed from the response field:
- `sensitiveMediaDetection`
- `sensitiveMediaDetectionSensitivity`
- `setSensitiveFlagAutomatically`
- `enableSensitiveMediaDetectionForVideos`
- `admin/update-meta`
- These parameter(s) are removed from the request field:
- `sensitiveMediaDetection`
- `sensitiveMediaDetectionSensitivity`
- `setSensitiveFlagAutomatically`
- `enableSensitiveMediaDetectionForVideos`
- `admin/show-user`
- These parameter(s) are removed from the response field:
- `autoSensitive`
- `i/update`
- These parameter(s) are removed from the request field:
- `autoSensitive`
2024-02-16 09:26:52 +01:00
- `/api/emojis` endpoint has been added.
2024-02-12 08:37:40 +01:00
## v20240212
- :warning: The field name of the response of `latest-version` has been changed from `tag_name` to `latest_version`.
2024-02-07 18:54:29 +01:00
## v1.0.5-rc
- `admin/update-meta` can now take `moreUrls` parameter, and response of `admin/meta` now includes `moreUrls`
- These URLs are used for the help menu ([related merge request](https://firefish.dev/firefish/firefish/-/merge_requests/10640))
2023-10-16 19:05:32 +02:00
- :warning: response of `meta` no longer includes the following:
- `enableTwitterIntegration`
- `enableGithubIntegration`
- `enableDiscordIntegration`
- :warning: parameter of `admin/update-meta` and response of `admin/meta` no longer include the following:
- `enableTwitterIntegration`
- `enableGithubIntegration`
- `enableDiscordIntegration`
- `twitterConsumerKey`
- `twitterConsumerSecret`
- `githubClientId`
- `githubClientSecret`
- `discordClientId`
- `discordClientSecret`
- :warning: response of `admin/show-user` no longer includes `integrations`.
- Added `lang` parameter to `notes/create` and `notes/edit`.
- :warning: `notes/translate` now requires credentials.