Fix regional endpoints: account-scoped regions + correct 403 wording#380
Open
kabraham13 wants to merge 2 commits into
Open
Fix regional endpoints: account-scoped regions + correct 403 wording#380kabraham13 wants to merge 2 commits into
kabraham13 wants to merge 2 commits into
Conversation
The Access requirements section stated "any API key can be used with any regional endpoint." This is incorrect: API keys are not region-specific, but each account is restricted to a single region, so a key only works with the regional endpoint its account is assigned to.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…ion) The Warning and Access requirements sections described the regional access error as a "403 authentication error." A request to a regional endpoint the account isn't assigned to actually returns a 403 with message "Your account is denied access" (an authorization error, not authentication). Updated both references and switched to present tense per the style guide.
kabraham13
changed the title
kabraham13
requested review from
BriannaDelgado,
jason-gardella-deepl and
leoncheng57
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes two inaccuracies in Regional API Endpoints that were reported as out of date.
1. Region applies to accounts, not keys
The Access requirements section said:
This is the inverse of how regional endpoints work, and undercuts the data-residency guarantee they exist to provide. Corrected to:
2. The regional access error is a 403, not an "authentication" error
The Warning and Access requirements both called it a "403 authentication error." A request to a regional endpoint an account isn't assigned to actually returns:
That's an authorization error, not authentication. Updated both references to "403 error (
Your account is denied access)" and switched to present tense per the style guide.Reviewed with the repo's
docs-reviewworkflow (editorial + Diataxis); both changes pass.Reported by Mathias Hauser.