Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add clarification for domain/uri in API Instance response #1388

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Add clarification for domain/uri in API Instance response #1388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/entities/Instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what you mean here, but there is not necessarily any relation between LOCAL_DOMAIN and WEB_DOMAIN

**Type:** String\
**Version history:**\
4.0.0 - added
Expand Down
2 changes: 1 addition & 1 deletion content/en/entities/V1_Instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down