From 7b6cb7bcf2e07818bcb1ab6ef2c405d24ebede4c Mon Sep 17 00:00:00 2001 From: Hank Grabowski Date: Thu, 23 Feb 2023 06:46:43 -0500 Subject: [PATCH] Add Mastodon Instance::V2 Friendica extension documentation --- doc/API-Mastodon.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/API-Mastodon.md b/doc/API-Mastodon.md index 17c6ea8fe3..4fa41e36ca 100644 --- a/doc/API-Mastodon.md +++ b/doc/API-Mastodon.md @@ -31,6 +31,28 @@ For supported apps please have a look at the [FAQ](help/FAQ#clients) These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/). With some additional extensions listed below. +### Instance (Version 2) Entities +Extensions to the [Mastodon Instance::V2 Entities](https://docs.joinmastodon.org/entities/Instance/) +* `friendica`: Friendica specific properties of the V2 Instance including: + * `version`: The Friendica version string + * `codename`: The Friendica version code name + * `db_version`: The database schema version number + +Example: +```json +{ + "domain": "friendicadevtest1.myportal.social", + "title": "Friendica Social Network", + "version": "2.8.0 (compatible; Friendica 2023.03-dev)", + ... + "friendica": { + "version": "2023.03-dev", + "codename": "Giant Rhubarb", + "db_version": 1516 + } +} +``` + ### Notification Entities Extensions to the [Mastodon Notification Entities](https://docs.joinmastodon.org/entities/Notification/) * `dismissed`: whether the object has been dismissed or not -- 2.39.5