zelo72/documentation
1
0
Fork 0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Code Issues 6 Releases Wiki Activity

Add keeping up with deprecations to API user guidelines (#1625)

Browse Source 
See https://github.com/mastodon/mastodon/pull/34262#event-16973822851
This commit is contained in:
Claire 2025-03-27 11:36:12 +01:00 committed by GitHub
parent a0310e97ad
commit 937c2b3918
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/en/api/guidelines.md
View File

@ -78,6 +78,12 @@ In this case, you may retrieve the `Link` header and parse it for links to the o
Following the `next` link should show you older results. Following the `prev` link should show you newer results.
## Deprecations {#deprecations}
Mastodon rarely removes APIs, but that can still happen from time to time. Therefore, it is recommended to keep up with Mastodon releases and keep an eye out for deprecated APIs.
Furthermore, to help implementers with spotting use of deprecated APIs, Mastodon 4.4.0 makes use of the `Deprecation` header defined in [RFC9745](https://datatracker.ietf.org/doc/html/rfc9745). It is recommended that library and application developers look for this header and display warnings in their development environments so they can spot these deprecated APIs before they get retired.
## Formatting {#formatting}
Plain text is not available for content from remote servers, and plain text syntax rules may vary wildly between Mastodon and other fediverse applications. For certain attributes, such as the content of statuses, **Mastodon provides sanitized HTML**. See [HTML Sanitization]({{< relref "spec/activitypub#sanitization" >}}) for more details. You may expect these tags to appear in the content: