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.
mastodon · Jan 11, 2024 · bc16b89 · bc16b89
1 parent 09ac075
commit bc16b89
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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