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

91 Commits

Author SHA1 Message Date
Claire
937c2b3918
Add keeping up with deprecations to API user guidelines (#1625)
See https://github.com/mastodon/mastodon/pull/34262#event-16973822851
2025-03-27 11:36:12 +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
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
Frigyes
8d26904e04
Added a lot of spelling fixes in the English documentation (#1350)
* Added many spelling fixes
* Apply suggestions from code review

Co-authored-by: Michael Stanclift <mx@vmstan.com>
2023-12-07 19:46:29 +00: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
Isa S
59aa5f047a
Correct links to the main mastodon repo (master --> main) (#1173)
* Fix links to mastodon repo

* Use preferred language
2023-03-08 17:40:02 +01:00
Renaud Chaput
d356c6caac
Switch hosting to Vercel (#1113)
* Fix URLs to work when `baseURL` is in a sub-directory

* Use `RelPermalink` to not have assets loaded from `baseUrl`

* Add `.vercel` to gitignore

* Remove deploy Github Action, we are now using Vercel
2022-12-21 06:26:37 +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
Eugen Rochko
59055006c9 Add information about rate limits 2020-03-05 22:33:10 +01:00
trwnh
7ceae9fe36 Update anchors, line breaks, tootctl options (#745)
* update anchors

* remove extraneous anchors

* fix line breaks

* wrap tootctl tokens in code blocks

* change anchors to hugo format

* fix mistaken search-and-replace

* fix mistaken search-and-replace
2020-01-12 14:11:56 +01:00
Eugen Rochko
33cb69ad07 Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00
Daniel Nitsikopoulos
9c543075e0 Update entities.md with poll notification type 2019-07-26 07:47:03 +02:00
Eugen Rochko
eeadacaadd Merge branch 'master' into 'master'
Add documentation about the state parameter

See merge request mastodon/docs!46
2019-07-08 21:24:22 +02:00
Eugen Rochko
38f8e77a91 Update content/en/api/rest/notifications.md 2019-07-08 21:22:31 +02:00
fluffy
07d8e93d9b Add documentation about the state parameter 2019-07-08 11:09:12 -07:00
Eugen Rochko
09004146f5 Update content/en/api/entities.md 2019-06-14 15:32:36 +02:00
Eugen Rochko
2fe355ce83 Merge branch 'patch-1' into 'master'
Update notifications.md to include `from_account`

See merge request mastodon/docs!41
2019-06-11 16:45:37 +02:00
Eugen Rochko
bcff8d180d Update notifications.md 2019-06-11 16:45:23 +02:00
Eugen Rochko
74699dd151 Merge branch 'patch-3' into 'master'
Update notifications.md to mention polls in push subscriptions

See merge request mastodon/docs!42
2019-06-11 16:44:02 +02:00
kjwon15
54e99c894d Add description about "streaming health" endpoint 2019-06-03 16:20:36 +09:00
Nolan Lawson
7576c4122f Update notifications.md to mention polls in push subscriptions 2019-05-28 04:51:48 +02:00
Paul Woolcock
04768e73ee Change parameter name to account_id 2019-05-21 09:12:08 -04:00
Paul
7cf6355ba7 Update notifications.md to include from_account
This PR is dependent on another PR getting merged: https://github.com/tootsuite/mastodon/pull/10796 . If that PR is not accepted, this can also be closed
2019-05-20 17:52:31 +02:00
tastytea
8cb8028763 Update entities.md 2019-05-12 17:25:25 +02:00
Eugen Rochko
7929127a70 Merge branch 'masto-js' into 'master'
Add yet another JS API library

See merge request mastodon/docs!34
2019-05-09 23:10:23 +02:00
Nolan Lawson
b28ead041e Update search.md to add limit/offset/following 2019-05-07 04:45:09 +02:00
lain
f9deb0f2a2 Conversation is not a sub-entity of Tag. 2019-04-08 14:08:22 +02:00
Neetshin
abaecb8a16 Add link to masto.js 2019-03-31 08:56:47 +09:00
Eugen Rochko
e77709b7fe Update content/en/api/rest/statuses.md 2019-03-05 00:44:59 +01:00
Eugen Rochko
0d86782b09 Update content/en/api/rest/polls.md 2019-03-04 20:14:23 +01:00
Eugen Rochko
1a205e1142 Update content/en/api/entities.md 2019-03-04 19:38:29 +01:00
Eugen Rochko
7ebec1eb4b Add poll entity 2019-03-04 19:36:37 +01:00
Nolan Lawson
dd22311204 Update reports.md to include "forward" parameter 2019-02-19 00:52:05 +01:00
Eugen Rochko
134124c290 Merge branch 'patch-1' into 'master'
languages in /api/v1/instance should allow all parts of ISO 639

See merge request mastodon/docs!6
2019-01-30 22:40:41 +01:00
nightpool
e086d478af More precise ID definition (no need to tie to any specific ID size) 2019-01-27 19:36:24 +01:00
Eugen Rochko
0de0210683 Merge branch 'revert-4a6697a6' into 'master'
Revert "Merge branch 'add-id-definition' into 'master'"

See merge request mastodon/docs!19
2019-01-27 18:01:46 +01:00
noellabo
243fc1d5e1 Add REST API for scheduled statuses 2019-01-27 14:01:33 +01:00
Eugen Rochko
ade0451d45 Merge branch 'add-implement-version-info' into 'master'
Add implement version info for some APIs

See merge request mastodon/docs!14
2019-01-27 14:01:12 +01:00
Eugen Rochko
42aee895f5 Merge branch 'master' into 'master'
account statuses API: document exclude_reblogs

See merge request mastodon/docs!17
2019-01-27 14:00:21 +01:00
Eugen Rochko
5e03e5d59e Revert "Merge branch 'add-id-definition' into 'master'"
This reverts merge request !18
2019-01-27 13:48:35 +01:00
tateisu
1afe325f5f add id definition 2019-01-27 11:20:27 +09:00
Vyr Cossont
821a77830e account statuses API: document exclude_reblogs 2019-01-26 11:43:03 -08:00
Eugen Rochko
28bb5236ef Update content/en/api/authentication.md 2019-01-26 00:40:55 +01:00
Eugen Rochko
2975a56641 Update content/en/api/authentication.md 2019-01-26 00:35:29 +01:00
rinsuki
688eca6667 Add implement version info for some APIs 2019-01-20 17:41:37 +09:00
noellabo
c5d230251b Add REST API for creating an account 2019-01-08 14:23:00 +01:00
Eugen Rochko
5328ddf701 Merge branch 'master' into 'master'
Add entity Conversation for new direct timeline

See merge request mastodon/docs!8
2018-11-25 20:52:35 +01:00
Thomas
fe35907b71 Update entities.md 2018-11-23 17:30:40 +01:00
Thomas
a62810380e Add conversation timeline. Please check parameters as there is no information concerning default values. 2018-11-21 08:22:13 +01:00