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

468 Commits

Author SHA1 Message Date
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
Renaud Chaput
8d67de74f9
Add OTEL configuration, and deprecate StatsD (#1518) 2024-08-23 16:02:37 +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
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
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
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
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
Michael
336b597506
Update Ubuntu requirements (#1486) 2024-08-01 16:25:08 +01:00
Michael Stanclift
89348a77e3
Add AVIF to allowed image types (#1495)
avif
2024-08-01 16:24:43 +01: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
8efb133f16
Add documentation for hint attribute of Rule entity in REST API (#1478) 2024-07-16 00:42:47 +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
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
Thomas Hansen
04a9453da4
Update install.md (#1469)
Fix ruby-build install command
2024-07-12 15:35:51 +01:00
Mahan
0552a6f71c
Add description to polls methods (#1474) 2024-07-12 15:35:05 +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 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
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
Michael Stanclift
28a7f3162c
Add config for REDIS_DRIVER (#1462)
* Add REDIS_DRIVER documention

* fix typo

* add version history
2024-06-19 10:45:28 +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
Val Lorentz
9294788aaa
tootctl search deploy: Document changes since v3.5.0 (#1454) 2024-06-11 11:25:14 +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
Adrian
509b20926b
Update authorized.md (#1455) 2024-06-11 11:17:47 +01:00
Mahan
662543d692
Add description to v1/markers (#1459) 2024-06-11 11:15:55 +01:00
Mahan
58deaeb0b5
Add mastodon-entities to libraries (#1434) 2024-05-21 12:24:39 +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
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
07f305fe82
Add doc for AR encryption env vars (#1427) 2024-04-17 11:35:17 +02:00
Michael Stanclift
8a0b1e2079
Cleanup duplicate Redis cache instructions (#1429)
* cleanup duplicate instructions
* Update content/en/admin/scaling.md

Co-authored-by: Claire <claire.github-309c@sitedethib.com>
2024-04-11 15:37:39 +01: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
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
Claire
c20d658062
Document ES_CA_FILE (#1403) 2024-03-27 08:54:56 +00:00
KuJoe
8d7dae6063
Updated the migrating.md document (#1390)
* Updated the migrating.md document
Included new guidance to update the mastodon database user password, instructions to copy over the Redis database, added new flag to improve pg_restore performance, a suggestion to copy the SSL certificates over, and added the commands needed to complete the migration along with an optional command for Elasticsearch.
* Update content/en/admin/migrating.md
* Update migrating.md
Fixed wording and order of starting services.
* Updated the migration guide for Redis and services
Added more details for migrating the Redis database and where/when to stop the services.

Co-authored-by: Michael Stanclift <mx@vmstan.com>
2024-03-27 08:54:18 +00:00