1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

92 Commits

Author SHA1 Message Date
Claire
5e2b739ee1
Add documentation for admin.sign_up notification grouping (#1626) 2025-03-28 14:00:07 +00:00
Claire
3540a72082
Add documentation for blur_media filter action (#1620)
* Add documentation for `blur_media` filter action

* Add `blur_media` documentation

* Rename `blur_media` to `blur`

* Rename `blur_media` to `blur`
2025-03-26 10:45:57 +01:00
Eugen Rochko
8fdb111109
Add documentation for age verification (#1613) 2025-03-17 17:55:51 +01:00
S1m
7da6e97fcc
Add standard push notifications (#1585) 2025-03-05 22:02:08 +01:00
Claire
c88771d7a0
Add documentation for Mastodon API version 4 media deletion methods (#1605)
* Add documentation for `delete_media` parameter to `DELETE /api/v1/statuses/:id`

* Add documentation for `DELETE /api/v1/media/:id`

* It's actually version 4

* It's actually version 4
2025-03-04 09:47:39 +01:00
Dale Price
481d6455cb
Add privacy policy and terms of service endpoints (#1594)
* Add privacy policy and terms of service endpoints

* Shorten the example privacy policy response
2025-02-05 10:23:52 +01:00
Christian Schmidt
91c68f33b3
Add documentation for attribution_domains (#1558)
* Add attribution_domains

* Adjust version

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

* Moved to CredentialAccount

* Revert merge error

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2025-01-17 09:48:02 +01:00
Matt Jankowski
441d374ce6
Restore application_id docs (#1583)
* Revert "Remove accidentally included `application_id` params attribute from `ScheduledStatus` (#1572)"

This reverts commit 1204ebeab8f7934eb572f3b54073f54b696482e6.

* Add note about the utter contempt we hold for this useless value

* Update ScheduledStatus.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

* Update ScheduledStatus.md

Co-authored-by: David Roetzel <david@roetzel.de>

---------

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
Co-authored-by: David Roetzel <david@roetzel.de>
2025-01-09 14:48:47 +01:00
Bastian
c7d6167dbc
Document Authorization header for WebSocket API (#1576)
Fixes #1575

Co-authored-by: Bastian Blank <waldi@debian.org>
2024-12-19 08:57:37 +01:00
Matt Jankowski
1204ebeab8
Remove accidentally included application_id params attribute from ScheduledStatus (#1572) 2024-12-17 09:54:37 +01:00
Matt Jankowski
afe3b8f3f0
Add media attachment description limit (#1567)
* Add media `description_limit` to instance

* Add media `description_limit` to instance
2024-12-04 16:10:24 +01:00
Nik Clayton
49868155b9
feat: Document datetime and date formats (#1565)
Add a new document that precisely describes the string representation of
datetime and date types.

The previous description of them as "ISO 8601 Datetime" was very
imprecise, as ISO 8601 describes many different ways of representing a
datetime and date.

Specify the datetime format precisely as the ISO 8601 profile described
in RFC 3339, and the date format precisely as the "Complete date" format
from the W3C note on date and time formats.

Adjust all the references to ISO 8601 datetimes or dates to link back
to the definition.

Fixes #1420
2024-11-27 15:08:51 +00:00
David Roetzel
4a0d6cc7ce
Fix typo in oauth api parameters (#1545)
Fix typo.
2024-10-10 18:59:26 +02:00
Emelia Smith
cb3aa4de10
Document new OAuth changes for 4.3.0 (#1445)
* Improve deprecation messaging for Application#vapid_key

* Format JSON examples in Instance methods

* Remove vapid_key from Apps API examples, since this property is deprecated on Application entity

* Add documentation for new OAuth 2.0 features added in 4.3.0

* Improve documentation for oauth-scopes

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Update content/en/api/oauth-scopes.md

Co-authored-by: Matt Jankowski <matt@jankowski.online>

* Add deprecated and removed shortcode labels

* Use deprecated and removed shortcodes

* Improve OAuth documentation

* More OAuth documentation improvements

* Correct streaming API documentation after 4.2.0 changes

* Add note about improved Push Subscription API validation in 4.3.0

* Fix inconsistent OAuth label formatting

* Add note that there is a relationship between Accounts and the Application used to create them

* Add note that application registration endpoint also supports JSON bodies

* Be consistent in the formatting of placeholder values for Bearer tokens

* code review changes

* Slight changes in wording

* Add documentation for PKCE

* Removal of crypto oauth scope

* Cross-link authorization's scope with the OAuth Scopes documentation

* Update content/en/methods/oauth.md

* Update content/en/api/oauth-scopes.md

---------

Co-authored-by: Matt Jankowski <matt@jankowski.online>
Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-10 14:44:19 +02:00
Claire
c99799ac3e
Add documentation for include_filtered (#1543)
* Add documentation for `include_filtered`

* Update grouped_notifications.md
2024-10-09 16:54:13 +02:00
Claire
42a8dbc20d
Clarify group_key for ungrouped notifications (#1539)
* Clarify `group_key` for ungrouped notifications

* Clarify that `grouped_types` affects `group_key` but not streaming API

* Update content/en/methods/grouped_notifications.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>

---------

Co-authored-by: David Roetzel <david@roetzel.de>
2024-10-08 11:34:32 +02:00
Renaud Chaput
9d2ff8b31c
Update documentation to add follow notifications grouping (#1536)
Related to https://github.com/mastodon/mastodon/pull/32085
2024-09-25 15:49:16 +02:00
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