Claire
2dd9d6a3e0
Add documentation for /api/v2/notifications/:group_key/accounts ( #1531 )
...
Also fixes a few URLs that were still referencing `v2_alpha`
2024-09-17 11:56:35 +02:00
Claire
49546c285a
Add documentation for /api/v2/notifications/* ( #1530 )
...
* Add documentation for `/api/v2/notifications/*`
This is a renamed and slightly updated version of https://docs.joinmastodon.org/methods/notifications_alpha/
* Update notifications_alpha.md to point to the finalized API
2024-09-17 11:39:57 +02:00
Mahan
b780066232
Update rule_ids type in /v1/reports ( #1467 )
...
* Update rule_ids type in /v1/reports
* add reference to the ID docs
2024-09-04 10:10:53 +02:00
Claire
7eefdcbfc6
Add documentation for grouped_types parameter in grouped notifications endpoints ( #1525 )
2024-08-30 09:47:09 +02:00
Claire
54f7d5a63f
Add documentation for /api/v2_alpha/notifications ( #1517 )
...
* 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
2024-08-23 16:51:12 +02:00
Claire
12c37c8f15
Add documentation for notifications_merged streaming event ( #1513 )
2024-08-23 15:12:45 +02:00
Claire
a98ee3515a
Add documentation for /api/v1/notifications/requests/merged ( #1516 )
...
* Add documentation for `/api/v1/notifications/requests/merged`
* Apply review suggestions
Co-authored-by: David Roetzel <david@roetzel.de>
---------
Co-authored-by: David Roetzel <david@roetzel.de>
2024-08-23 10:36:44 +02:00
Claire
d94ac10884
Add documentation for bulk operations on notification requests ( #1511 )
...
* Add documentation for bulk operations on notification requests
* Apply suggestions from code review
2024-08-23 09:37:27 +02:00
Renaud Chaput
9b6dbb491e
Add documentation for the new icons attribute in /api/v2/instances ( #1510 )
2024-08-22 17:52:50 +02:00
David Roetzel
495285ba35
Clarify scope parameter of oauth token creation ( #1509 )
...
* Clarify `scope` parameter of oauth token creation
* Improve wording
Co-authored-by: Claire <claire.github-309c@sitedethib.com>
---------
Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-08-22 15:12:45 +02:00
Claire
b59b7fea62
Add documentation for /api/v2/notifications/policy ( #1503 )
...
* Rename `NotificationPolicy` entity to `V1::NotificationPolicy`
* Add documentation for v2 NotificationPolicy
* Add deprecation warning
2024-08-22 11:20:40 +02:00
Eva Tatarka
d1899d20fb
Add missing array syntax to follow lanagues query param ( #1502 )
2024-08-21 23:30:12 +01:00
Marcin Mikołajczak
f5a1f6bef4
filters API methods: Fix typo ( #1493 )
2024-08-21 23:29:38 +01:00
Claire
1f59ac9fde
Add documentation for /api/v1/notifications/unread_count ( #1492 )
...
* Add documentation for `/api/v1/notifications`
* Fix issues following review feedback
* Document unread_count's return type
2024-08-02 15:36:31 +02:00
Marcin Mikołajczak
9b660bb152
featured_tags API methods: Fix typo ( #1494 )
2024-07-31 18:22:41 +01:00
Claire
0e88921543
Fix missing HTTP line for accept-request notification method ( #1484 )
2024-07-25 15:52:50 +02:00
Nik Clayton
61481fb191
Provide more detail about the use of resolve in search queries ( #1488 )
...
Provide more detail about the use of `resolve` in search queries
2024-07-23 12:07:05 +01:00
Claire
de8d6ac149
Add documentation for /api/v1/timelines/link ( #1481 )
...
* Add documentation for `/api/v1/timelines/link`
* Update content/en/methods/timelines.md
2024-07-15 21:37:01 +01:00
Mahan
0552a6f71c
Add description to polls methods ( #1474 )
2024-07-12 15:35:05 +01:00
David Roetzel
c0353e222b
Remove flag that no longer exists. ( #1482 )
...
See https://github.com/mastodon/mastodon/pull/31008
2024-07-12 13:52:53 +02:00
Renaud Chaput
522d9c2ad8
Fix dismiss notification request title ( #1466 )
2024-06-19 11:30:37 +02:00
Claire
878e5836b7
Add documentation for notification policies ( #1447 )
...
* Add documentation for GET /api/v1/notifications/policy
* Add documentation for `PATCH /api/v1/notifications/policy`
* Add documentation for `GET /api/v1/notifications/requests`
* Add documentation for `GET /api/v1/notifications/requests/:id`
* Add documentation for accepting and rejecting requests
* Remove redundant HTTP request examples
* Add documentation for the `NotificationPolicy` entity
* Add documentation for the `NotificationRequest` entity
2024-06-13 18:01:35 +02:00
Mahan
61d28de915
Add description to timelines/public ( #1448 )
2024-06-11 11:25:59 +01:00
Mahan
2557e19c63
Add description and type to /emails/confirmations ( #1451 )
2024-06-11 11:24:06 +01:00
Mahan
b903b07128
Add description to /followed_tags ( #1452 )
2024-06-11 11:18:16 +01:00
Mahan
662543d692
Add description to v1/markers ( #1459 )
2024-06-11 11:15:55 +01:00
Emelia Smith
5f0bd3cb77
Update admin/domain_blocks to include conflict response ( #1417 )
...
* Update admin/domain_blocks to include conflict response
When creating a domain block, if there is already a domain block rule for the domain, then the existing block is returned. This documents that behavior.
I've also documented the `digest` property which was added in https://github.com/mastodon/mastodon/pull/29092
* Document digest in Admin DomainBlock Entity
2024-05-07 18:54:14 +01:00
Claire
59c5876836
Add documentation for GET /api/v1/accounts and GET /api/v1/statuses ( #1433 )
...
* Add documentation for `GET /api/v1/accounts`
See https://github.com/mastodon/mastodon/pull/27871
* Add documentation for `GET /api/v1/statuses`
2024-05-07 11:43:48 +02:00
Matt Jankowski
1005443460
Add max_pinned_statuses property to instances.accounts ( #1425 )
2024-04-02 22:28:17 +02:00
Andy Piper
a610154747
Removed unused (not implemented) query parameter. ( #1369 )
...
Signed-off-by: Andy Piper <andypiper@users.noreply.github.com>
2024-03-29 11:18:40 +01:00
Dale Price
fa868c3a9b
Add documentation for legal report category ( #1422 )
...
This category was was added in mastodon/mastodon#23941
2024-03-27 08:49:49 +00:00
sgtatham
07b3bd95fc
Fix token type in account creation. ( #1387 )
2024-01-13 22:27:13 +00:00
a
92f25458d5
Remove "required" label from no-longer-required methods ( #1378 )
2024-01-07 22:21:15 +00:00
Wesley Moore
c185e7dec0
Clarify that apps verify_credentials requires app token + read ( #1190 )
2023-12-10 18:47:29 +00:00
Christian Schmidt
0ca2155229
New translations attributes ( #1203 )
2023-12-10 18:44:53 +00:00
Manish Roy
b87c68c120
Fix notification query param LIMIT doc #24684 ( #1210 )
...
* Fix notification query param LIMIT doc
The notification query param LIMIT should return 40 notifications as default & Maximum notifications depends on the LIMIT param as evident from the code in api/v1/notifications_controller
* LIMIT param default & max notifications updated
* limit param doc updated
2023-12-08 21:25:44 +00:00
Christian Schmidt
5bed9cfe82
Document /api/v1/instance/translation_languages ( #1189 )
2023-12-08 21:23:03 +00:00
Claire
70f4386efd
Update documentation for /api/v1/accounts/update_credentials ( #1302 )
...
This was missing `source[language]` as well as `hide_collections` and the upcoming `indexable`.
2023-12-08 15:30:02 +00:00
Emelia Smith
e3d00bd75e
Remove the admin/ prefix on Admin APIs for consistency ( #1228 )
2023-12-07 18:58:05 +00:00
cucmberium
c2d93f344f
Added missing parameter information in Filter ( #1312 )
2023-12-07 13:36:38 +00:00
JakePaustian
f2b3dfb70a
An important parameter is missing from the API doc on editing a post #1239 ( #1351 )
...
* Update content/en/methods/statuses.md
2023-12-06 11:57:15 +00:00
Mahan
66612d0084
Add missing type of id. ( #1296 )
2023-12-05 22:47:25 +01:00
Mahan
3c7c5caed1
update return empty return types to Empty ( #1298 )
2023-12-05 18:20:37 +00:00
Emelia Smith
9b534bb024
Add documentation for VAPID public key in instance metadata ( #1342 )
...
* Add documentation for VAPID public key in instance metadata
* Mark Application#vapid_key as deprecated
2023-11-28 19:25:04 +01:00
Levi Bard
cbe1295e15
Add exclusive parameter to list update documentation ( #1327 )
2023-11-13 18:21:51 +01:00
Ludovic HOCHET
02a694869a
Update the end point url on emails.md ( #1334 )
...
/api/v1/emails/confirmation should be /api/v1/emails/confirmations (with an ending s) otherwise a 404 is returned
2023-11-10 13:29:32 +01:00
Claire
10ee12b62a
Add documentation for with_suspended params ( #1333 )
...
Add documentation for https://github.com/mastodon/mastodon/pull/27667
2023-11-09 15:50:30 +01:00
Claire
b6c62a040d
Document exclusive lists ( #1310 )
2023-09-28 11:49:54 +02:00
Lennart Hengstmengel
e4e88f0fb7
Fixed some consistency issues in the documentation ( #1274 )
...
* fixed invalid json examples
* correct type: integer for a count, not number
* correct type: array of string, not string
* add square brackets around entity return type
* added missing path parameter definition
* spacing fix
* PR comment: add link
2023-09-20 10:32:44 +02:00
Daniel M Brasil
1d15e379a4
Document DELETE /api/v1/profile/avatar and /api/v1/profile/header ( #1238 )
...
* document DELETE /api/v1/accounts/picture/:picture
* update documentation
* add mastodon version
* move page to new profile.md file
2023-09-09 23:13:35 +01:00
