wholetrans/docs-mastodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for /api/v2_alpha/notifications (#1517)

Browse source 
* Add rough documentation for `/api/v2_alpha/notifications`

* Update notifications_alpha.md

* Add very rough documentation about notification groups entities

* Add documentation for `NotificationGroup` entity

* Document pagination-only `NotificationGroup` attributes

* Fix documentation issue with `/api/v2_alpha/notifications/:group_key` and add example output

* Add blurb about the goal of grouped notifications

* Update notifications_alpha.md

* Specify that the 80 limit is for notification groups, not notifications

* Add documentation for `group_key` to `Notification` entity

* Make `max_id`, `since_id` and `min_id` more explicit
This commit is contained in:
Claire 2024-08-23 16:51:12 +02:00 • committed by GitHub
parent 8d67de74f9
commit 54f7d5a63f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 605 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
content/en/entities/Notification.md
View file

@ -46,6 +46,13 @@ aliases: [
4.0.0 - added `admin.report`\
4.3.0 - added `severed_relationships` and `moderation_warning`
### `group_key` {#group_key}
**Description:** Group key shared by similar notifications, to be used in the grouped notifications feature. Should be considered opaque.
**Type:** String\
**Version history:**\
4.3.0 - added
### `created_at` {#created_at}
**Description:** The timestamp of the notification.\