From 937c2b3918826260e15ef112a25b21974f073a4d Mon Sep 17 00:00:00 2001 From: Claire Date: Thu, 27 Mar 2025 11:36:12 +0100 Subject: [PATCH] Add keeping up with deprecations to API user guidelines (#1625) See https://github.com/mastodon/mastodon/pull/34262#event-16973822851 --- content/en/api/guidelines.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/en/api/guidelines.md b/content/en/api/guidelines.md index f981e2bf..f5872b63 100644 --- a/content/en/api/guidelines.md +++ b/content/en/api/guidelines.md @@ -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: