From 9b6dbb491ed41cb47bbddbd2ecfb8dbd0bee9cdc Mon Sep 17 00:00:00 2001 From: Renaud Chaput Date: Thu, 22 Aug 2024 17:52:50 +0200 Subject: [PATCH] Add documentation for the new `icons` attribute in `/api/v2/instances` (#1510) --- content/en/entities/Instance.md | 40 +++++++++++++++++++++++++++++++++ content/en/methods/instance.md | 20 ++++++++++++++++- 2 files changed, 59 insertions(+), 1 deletion(-) diff --git a/content/en/entities/Instance.md b/content/en/entities/Instance.md index ef60da2..eab861a 100644 --- a/content/en/entities/Instance.md +++ b/content/en/entities/Instance.md @@ -34,6 +34,24 @@ aliases: [ "@2x": "https://files.mastodon.social/site_uploads/files/000/000/001/@2x/57c12f441d083cde.png" } }, + "icon": [ + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/36/accf17b0104f18e5.png", + "size": "36x36" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/72/accf17b0104f18e5.png", + "size": "72x72" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/192/accf17b0104f18e5.png", + "size": "192x192" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/512/accf17b0104f18e5.png", + "size": "512x512" + } + ], "languages": [ "en" ], @@ -266,6 +284,13 @@ aliases: [ **Version history:**\ 4.0.0 - added +### `icon` {#icon} + +**Description:** The list of available size variants for this instance configured icon.\ +**Type:** Array of [InstanceIcon](#InstanceIcon)\ +**Version history:**\ +4.3.0 - added + ### `languages` {#languages} **Description:** Primary languages of the website and its staff.\ @@ -503,6 +528,21 @@ aliases: [ **Version history:**\ 4.0.0 - added +## InstanceIcon attributes {#InstanceIcon} + +### `src` {#src} + +**Description:** The URL of this icon.\ +**Type:** String\ +4.3.0 - added + +### `size` {#size} + +**Description:** The size of this icon.\ +**Type:** String (in the form of `12x34`, where `12` is the width and `34` is the height of the icon)\ +**Version history:**\ +4.3.0 - added + ## See also {{< page-relref ref="methods/instance#v2" caption="GET /api/v2/instance" >}} diff --git a/content/en/methods/instance.md b/content/en/methods/instance.md index ee78daa..aa6a834 100644 --- a/content/en/methods/instance.md +++ b/content/en/methods/instance.md @@ -54,6 +54,24 @@ Obtain general information about the server. "@2x": "https://files.mastodon.social/site_uploads/files/000/000/001/@2x/57c12f441d083cde.png" } }, + "icon": [ + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/36/accf17b0104f18e5.png", + "size": "36x36" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/72/accf17b0104f18e5.png", + "size": "72x72" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/192/accf17b0104f18e5.png", + "size": "192x192" + }, + { + "src": "https://files.mastodon.social/site_uploads/files/000/000/003/512/accf17b0104f18e5.png", + "size": "512x512" + } + ], "languages": [ "en" ], @@ -635,7 +653,7 @@ Obtain general information about the server. "statuses_count":72309, "last_status_at":"2022-08-24", "emojis":[ - + ], "fields":[ {