Add clarification for domain/uri in API Instance response
#1388
Conversation
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.
|
@daprice is attempting to deploy a commit to the Mastodon Team on Vercel. A member of the Team first needs to authorize it. |
| @@ -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.\ | |||
There was a problem hiding this comment.
I was going to suggest adding:
If `LOCAL_DOMAIN` is not set, then this will be the host portion of `WEB_DOMAIN`
But I'm not sure that's actually true from what I can see in the code?
There was a problem hiding this comment.
I don't understand what you mean here, but there is not necessarily any relation between LOCAL_DOMAIN and WEB_DOMAIN
There was a problem hiding this comment.
LOCAL_DOMAIN becomes WEB_DOMAIN if it's not set: https://github.com/mastodon/mastodon/blob/main/config/initializers/1_hosts.rb#L4-L5
There was a problem hiding this comment.
So I perhaps got this the wrong way around.
There was a problem hiding this comment.
You did get it the wrong way around. (Though there is a fallback to localhost:$PORT, I guess… I wonder if we should maybe only have it explicitly supported in the development mode)
|
This pull request has merge conflicts that must be resolved before it can be merged. |
Since
LOCAL_DOMAINandWEB_DOMAINcan be separate, as an API user I needed to be aware of the distinction when using this property.