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

58 Commits

Author SHA1 Message Date
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
Claire
7974696ed0
Mention followed hashtags in /api/v1/timelines/home (#1282)
* Mention followed hashtags in /api/v1/timelines/home

* Update timelines.md
2023-08-31 18:18:04 +02:00
trwnh
5377ff0edf
Clarify since_id vs min_id (#1209)
* Clarify since_id vs min_id

* forgot to update the template
2023-08-21 15:40:12 +01:00
Cassidy James Blaede
fa0d546592
Update Status method docs to include unauthenticated limits (#1258)
* Update Status method docs to include unauthenticated limits

Not sure if this follows the correct style or is precisely where these limits should be noted, but the intent is to save others time by documenting these hardcoded limits:

99be47f8b9/app/controllers/api/v1/statuses_controller.rb (L21-L24)

Related: https://github.com/mastodon/mastodon/issues/25892

* statuses: mention limits in version history
2023-07-11 15:19:33 +02:00
josephrocca
f1de8ba240
More explicit wording for pinned param default (#1259)
* More explicit wording for `pinned` param default

* Clarify pinned status ordering in returned results
2023-07-11 10:11:40 +02:00
nightpool
d9f99fa667
Clarify WebPush documentation and it's relationship to proprietry services (#1257)
based on conversation in https://github.com/mastodon/mastodon/issues/25729
2023-07-10 18:31:13 +02:00
Shadowfacts
3630f2de3b
Fix instance entity links (#1205)
The v2 endpoint incorrectly said it returned a v1 instance (though it linked to the correct entity) and the v1 endpoint incorrectly linked to the v2 entity (the text correctly said v1)
2023-04-26 14:20:05 +02:00
Tuur Martens
f7f21c8726
whole_word is a boolean, not a string (#1177) 2023-04-11 10:02:30 +02:00
Chee Aun
4ee33a54b5
Fix typo s/statuses/accounts (#1196) 2023-04-07 09:01:21 +02:00
Vyr Cossont
5e82c71542
Remove references to nonexistent Mastodon 3.6 in filter docs (#1167) 2023-03-08 17:39:05 +01:00
trwnh
b458498d25
Miscellaneous fixes (#1110)
* Fix typos in method examples

* Fix broken link to sanitize_config (#1115)

* Add SIDEKIQ_CONCURRENCY

* Fix relref to FilterResult (#1114)

* Fix status_ids and rule_ids description (#1126)

* fix typo (#1129)

* clarify confusing example (mastodon/mastodon#22854)

* fix formatting on linked headings (#1139)

* fix placeholder entity names (#1157)

* better wording

* fix scheduledstatus#params.visibility

* fix missing: tootctl accounts modify --remove-role

* add: status/translate

* add deprecation/removal warning to microformats page

* clarify further how link verification works

* clarify mastodon requirements for webfinger

* fix: push param policy -> data[policy]
2023-02-07 02:14:07 +01:00
trwnh
ffbe66a389
Update content for 4.0, part 2 (#1060)
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
2022-12-14 22:55:30 +01:00
trwnh
3628b6d434
Update content for 4.0 (part 1) (#991)
* add rules

* join date on profiles

* deprecate follow scope

* deprecate identity proofs

* familiar followers

* use definition lists instead of tables for defining activitypub properties

* reformat notifications page into markdown

* fix broken links to publicKey header

* Application website is now nullable

* update environment variables added and removed

* fix typo

* fix heading level

* min_id and max_id can be used at the same time (3.3)

* fix typo

* new tootctl options

* reformat tootctl page to use definition lists for params

* add rules and configuration to Instance

* fix typo

* refactor instance api page

* 3.3.0 duration on mutes

* 3.3.0 mute_expires_at

* improve section headings

* 3.4.0 resend email confirmation api

* 3.4.0 policy on push subscriptions

* 3.4.0 add details to account registration error

* refactor accounts api page and start adding relrefs to entity pages

* 3.4.0 accounts/lookup api

* add see also to accounts methods

* add more see-also links

* 3.5.0 appeal mod decisions

* 3.5.0 reformat reports and add category/rule_ids params

* document report entity and missing responses

* fix typos

* fix relrefs and url schema, add aliases to old urls

* add archetypes for new methods/entities

* update archetypes with see-also stubs

* clearer presentation of rate limits

* announcements api methods

* refactor apps methods

* refactor bookmarks methods + some anchors

* refactor conversations methods

* custom_emojis methods refactor

* anchors

* refactor directory methods

* refactor domain_blocks methods

* add see also to emails methods

* fix page relref shortcodes to specific methods + refactor endorsements methods

* min_id max_id

* refactor favourites methods

* refactor featured_tags methods

* refactor filters methods, make path params consistent, i18n required shortcode

* follow_requests methods

* lists methods

* markers methods

* forgot to add entity links

* media methods, also fix formatting of some json errors

* mutes methods, add more see-also links

* oembed methods

* preferences methods

* proofs methods

* push methods

* suggestions methods

* 3.5.0 add new trend types, fix formatting

* refactor streaming methods

* refactor oauth methods

* note that streaming api casts payload to string

* refactor search methods

* refactor polls methods

* remove unnecessary link

* reformat scheduled_statuses methods

* reformat timelines methods

* reformat statuses methods

* 3.5.0 editing statuses

* consistent use of array brackets in form data parameters

* update dev setup guide, add vagrant and clean up text

* add admin/accounts methods

* 3.6 role entity

* admin/accounts methods v2

* minor fix

* stub admin/reports methods

* document admin reports

* add 403 example to methods archetype

* cleanup entities for admin reports and add new attrs

* 3.6.0 domain allows methods + normalize admin entity namespace

* fix search-and-replace error

* add aliases for admin entities

* 3.6.0 canonical email blocks entity

* 3.5.0 admin/retention api

* 3.5.0 add admin::ip doc

* 3.5.0 admin/reports

* 3.6.0 admin/domain_allows

* 3.5.0 admin/dimensions

* 3.6.0 permissions and roles

* minor formatting fix

* add anchor link to headings

* checkpoint

* add update commands to dev env setup guide

* change mentions of v3.6 to v4.0

* tootctl now uses custom roles

* fix formatting

* v2 instance api

* update frontmatter, add better titles to pages

* minor wording change

* consistency

* add more aliases

* add placeholders and WIP notices

* explain link pagination and stub out todos

* switch baseURL to https

* 422 on reports with rules but category!=violation

* document bug fixes

* fix typo

* remove duplicate API method definition

* s/tootsuite/mastodon for github links

* remove unnecessary escaping

* s/tootsuite/mastodon in Entity archetype

* add missing nullable shortcode

* clarify oauth scope when requesting a user token

* api/v2/media now synchronous for images

* DISALLOW_UNAUTHENTICATED_API_ACCESS

* add undocumented env variables

* add instance domain blocks and extended description api

* add SMTP_ENABLE_STARTTLS

* add description to SMTP_ENABLE_STARTTLS

* take suggestions from open PRs

* normalize links and flavour language

* Fully document streaming API based on source code

* Add mention of MIME types

* bump to ruby 3.0.4

* clarify how to check on async media processing

* validation of replies_policy

* remove TODOs on admin account action

* EmailDomainBlocks

* IpBlocks

* Admin::DomainBlock

* remove TODOs

* following hashtags

* followed_tags

* remove reference to unused parameter

* add new oauth scopes for admin blocks and allows

* fix command signature for i18n-tasks normalize

* reformat code structure page

* document fixes for following tags (assume 4.0.3)

* Add warning about pre-4.0 hardcoded roles

* add note about case sensitivity

* remove use of 'simply' from docs

* remove reference to silencing

* add reference to IDN normalization for verified links

* add lang parameter
2022-11-20 07:34:38 +01:00
mcclure
71e3ba0b1e
Clarify axis info on media "focus" parameter (#953)
Today I read the media/ api endpoint document and was confused about the axis orientation (IE is y up or down). I initially implemented an endpoint call with the wrong Y orientation.

There is a helpful diagram but I did not see it because I foolishly scrolled down, saw the return codes section, assumed that was the end of the document, and didn't scroll further.

Edit adds a reference from the arguments section at the top to the detailed explanation of "focus" at the bottom of the page, so the next fool doesn't make the mistake I did.
2022-07-16 14:02:20 +02:00
Leon Kowalski
0dc4745593
Fix force_login type & more (#894)
* Fix `force_login` type & more

Makes `force_login` of type `bool` & moves optional parameters to bottom of table for consistency.

* Fix `limit` type & provide descriptions

* Fix typo
2021-09-13 17:55:48 +02:00
Justin Mazzocchi
62711e29d4
Add metatext-apns to list of push relay services (#864) 2021-03-18 05:48:58 +01:00
trwnh
bcf77cb795
3.3.0rc2 (#834)
* add identifier for troubleshooting pages

* mention mutes can be temporary now

* bell for notifications

* convert images to jpg and rename them

* suspensions now reversible

* unread notifications

* suspended: true

* mutes expiry

* replies_policy, type of notification

* notify

* featuredTags AP representation

* new env vars

* accounts merge

* maintenance cli

* list replies

* suspended flag

* follower sync

* minor formatting

* add note about idempotency of follow action

* account featured tags, min_id and max_id, plus normalization

* follow marcin and nightpool's suggestion

* bearcaps

* replies_policy update

* featuredtags now have a url
2020-12-27 07:03:55 +01:00
Justin Mazzocchi
f3bc8f5699
Fix filter expiry parameter type documentation (#806) 2020-08-30 02:40:46 +02:00