From bc16b89221042f7e9308802d99bfeb28dca6e326 Mon Sep 17 00:00:00 2001 From: Dale Price Date: Thu, 11 Jan 2024 15:46:47 -0600 Subject: [PATCH] Add clarification for `domain`/`uri` in API Instance response Since `LOCAL_DOMAIN` and `WEB_DOMAIN` can be separate, as an API user I needed to be aware of the distinction when using this property. --- content/en/entities/Instance.md | 2 +- content/en/entities/V1_Instance.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/entities/Instance.md b/content/en/entities/Instance.md index b822dabd..adc5c305 100644 --- a/content/en/entities/Instance.md +++ b/content/en/entities/Instance.md @@ -169,7 +169,7 @@ aliases: [ ### `domain` {#domain} -**Description:** The domain name of the instance.\ +**Description:** The domain name of the instance. Corresponds to the configured `LOCAL_DOMAIN`, which is used for account handles, and is not necessarily the same as `WEB_DOMAIN` where the Mastodon API and web interface are hosted.\ **Type:** String\ **Version history:**\ 4.0.0 - added diff --git a/content/en/entities/V1_Instance.md b/content/en/entities/V1_Instance.md index 276afc85..31d67ff6 100644 --- a/content/en/entities/V1_Instance.md +++ b/content/en/entities/V1_Instance.md @@ -148,7 +148,7 @@ aliases: [ ### `uri` {#uri} -**Description:** The domain name of the instance.\ +**Description:** The domain name of the instance. Corresponds to the configured `LOCAL_DOMAIN`, which is used for account handles, and is not necessarily the same as `WEB_DOMAIN` where the Mastodon API and web interface are hosted.\ **Type:** String\ **Version history:**\ 1.1.0 - added