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

79 Commits

Author SHA1 Message Date
Claire
5ef698a542
Add documentation for about, privacy_policy and terms_of_service URLs (#1606)
Add documentation for https://github.com/mastodon/mastodon/pull/33849
2025-04-07 15:16:42 +02:00
Claire
a0310e97ad
Add documentation for registrations.reason_required (#1624) 2025-03-26 15:24:56 +01: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
mkljczk
da1e434ee7
MediaAttachment.md: fix typo (#1621) 2025-03-24 15:55:30 +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
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
4afe1ae06f
Add explanation of rate limit in scheduled status entity (#1584)
* Add explanation of rate limit in scheduled status entity

* Add deprecated note
2025-01-09 15:15:41 +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
Nik Clayton
047de3b135
fix: AccountWarning.status_ids can be null (#1580) 2025-01-03 17:23:40 +01:00
Claire
4f8a46d859
Fix incorrect relationship_severance_event attribute name in notifications documentation (#1579)
See https://github.com/mastodon/mastodon/issues/33411
2025-01-03 13:59:30 +01:00
Claire
5c792e83d9
Fix incorrect documentation for RelationshipSeveranceEvent (#1557)
Fixes #1556
2024-12-18 17:03:49 +00: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
2e40eecb12
fix: Show FeaturedTag.last_status_at as a date (#1566)
* fix: FeaturedTag.last_status_at is a date

* Update example
2024-12-02 08:47:46 +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
Nik Clayton
9a8c9659b0
fix: Replace "interacted with" with "reblogged" (#1564)
By clear about the situations in which the `update` status type is sent.
2024-11-22 10:08:47 +01: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
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
aaaaalbert
dc78b2ad5f
Fix #1523, add missing link to entities/Status (#1524)
Add a link in the attribute description of `reblog` for the `Status` API entity which was reported missing by @nikclayton.
2024-08-30 11:38:44 +02:00
Claire
24dd81ef49
Add documentation for authors attribute in preview cards (#1512)
* Add documentation for `authors` attribute in preview cards

* Add `PreviewCardAuthor` entity

* Update PreviewCard.md

* Update PreviewCardAuthor.md
2024-08-23 17:34:28 +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
cff9085e39
Add documentation for api_versions on Instance entity (#1514) 2024-08-23 09:19:48 +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
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
aaaaalbert
122e461f6f
Change {{< type shortcode to {{% (#1489)
Fix #1487, work around an error in the rendering of a {{< type shortcode in the autogenerated Table of Content of a page.
2024-08-03 17:58:00 +01:00
Claire
8efb133f16
Add documentation for hint attribute of Rule entity in REST API (#1478) 2024-07-16 00:42:47 +01:00
Claire
7386be7d76
Add documentation for sources in Suggestion entity (#1480) 2024-07-15 21:35:38 +01:00
Claire
e19829bd51
Add documentation for moderation_warning notification types (#1479)
* Add documentation for `moderation_warning` notification types

* Add documentation for `AccountWarning` entity

* Add documentation for `Appeal` entity
2024-07-15 11:39:10 +02:00
Mahan
db089a94e9
Fix FeaturedTag's statuses_count type (#1472) 2024-07-12 15:40:24 +01:00
Renaud Chaput
c7d87cda76
Fix NotificationRequest fields (#1477)
* NotificationRequest uses `account`, not `from_account`

The example below is correctly using `account` already.

* Fix `notifications_count` type
2024-07-12 16:26:07 +02:00
David Whetstone
ce8146cf60
Mark MediaAttachment.preview_url, blurhash as nullable (#1457)
* Mark MediaAttachment.preview_url as nullable

Had a payload in the wild where preview_url was `null` and the method that generates this value can certainly return `nil` if none of its conditions are met: d326ad0ed9/app/serializers/rest/media_attachment_serializer.rb (L30-L38)

Also both TootSDK and IceCubesApp have this property as nullable.

* Mark MediaAttachment.blurhash as nullable

When the attachment has type `audio`, `blurhash` is `null`.
2024-06-19 10:45:48 +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
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
Mahan
7403a1c55f
Make category in CustomEmoji nullable (#1435)
Update CustomEmoji.md

- Add nullable to category
2024-04-29 10:00:54 +02:00
Mahan
237a8ad45b
Fix incorrect types in Role (#1436)
Update Role.md

- Convert id to String
- Convert permissions to String
2024-04-29 10:00:41 +02:00
Matt Jankowski
1005443460
Add max_pinned_statuses property to instances.accounts (#1425) 2024-04-02 22:28:17 +02:00
Konrad Pozniak
ddfe7b4833
Fix docs of the Translation entity (#1423)
* Fix docs of the Translation entity

The poll attribute is an object, not an array.

* Update Translation.md

* add more information about the atachment and poll option types
2024-04-02 13:12:15 +02:00
Claire
4e46d961ca
Mark contact[account] as nullable in Instance entity (#1415)
* Mark `contact[account]` as nullable in `Instance` entity

* Update V1_Instance.md
2024-03-13 13:56:28 +00:00
Claire
894fb354f3
Fix incorrect property name streaming_api for the Instance entity (#1399)
The entity used for `/api/v2/instance` returns the streaming URL as `streaming`, not `streaming_api`.
2024-02-09 21:12:17 +00:00
a
5ef587184d
Fix typo in Admin::Cohort entity (#1392)
Fix type in Admin::Cohort entity
2024-01-23 10:02:10 +00:00
Claire
6ddc3143f5
Add documentation for the severed_relationships event type (#1385)
* Add documentation for the `severed_relationships` event type
* Create RelationshipSeveranceEvent.md
2024-01-13 22:20:13 +00:00
Claire
17f1e250f9
Add documentation for requested_by (#1381)
Fixes #1380
2024-01-07 22:22:34 +00:00
Emelia Smith
101f48dd87
Fix issue with VAPID Public Key linking in Instance.md (#1375) 2023-12-19 09:36:56 +01:00
Christian Schmidt
0ca2155229
New translations attributes (#1203) 2023-12-10 18:44:53 +00:00
Michael Stanclift
94aa9f71a7
Consistent use of Postgres and PgBouncer (#1353)
* fix pgbouncer
* pghero
2023-12-10 18:40:20 +00:00
Adam Harvey
e3ea6ccf8f
Fix the description of media_attachments in StatusEdit (#1180) 2023-12-08 15:40:09 +00:00
trwnh
128895dbc9
Fix copypaste error for FilterResult.status_matches type (#1214)
Fix https://github.com/mastodon/mastodon/issues/24900
2023-12-08 06:50:10 -08:00
Casper Roursgaard
16dde4cfa3
Fix links to serializers (#1246)
Co-authored-by: Casper Roursgaard Christensen <casper@casrou.com>
2023-12-05 18:18:58 +00:00