Add clarification for domain/uri in API Instance response
#1388
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since
LOCAL_DOMAINandWEB_DOMAINcan be separate, as an API user I needed to be aware of the distinction when using this property.