docs(api): clarify per-stack API portals and warn about token scope#377
Merged
Conversation
Add an info callout above the API table explaining the links go to the AWS US portal and that using the wrong portal causes Invalid Token errors. Add an "API Documentation Portals" subsection under Stacks and Endpoints with direct links to each stack's portal (api.*), making it easy to land on the correct portal before trying out API calls with your token. Rename "If you are using another stack..." paragraph heading to "Service Endpoints" to separate it visually from the portal table. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the API overview documentation to make the per-stack nature of the API portal explicit, helping users avoid “Invalid Token” errors caused by using the wrong stack’s portal.
Changes:
- Adds an info note above the “List of Keboola APIs” table warning that the service links target the US Virginia AWS portal and linking to the per-stack portal list.
- Introduces an “API Documentation Portals” subsection with direct
api.*links per stack. - Refactors the stack/endpoints narrative into clearer subsections (“API Documentation Portals” + “Service Endpoints”).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… stack name
- Replace kramdown {: .alert} with explicit HTML <div class="alert">
to match the pattern used by the existing warning alert on the same page
- Scope the note to "api.keboola.com links" — Storage API and Developer
Portal API link to Apiary, not the per-stack portal
- Rename "AWS US" → "US Virginia AWS" to match the terminology used in
the Stacks and Endpoints section
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
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.
Summary
api.keboola.com) and that using the wrong stack's portal causesInvalid Tokenerrorsapi.*), so users can easily navigate to the right one before testing API callsContext
Addresses the root cause behind api-service#84: users arriving at the docs from
developers.keboola.comhad no clear way to find the API portal for their stack, and the existing table links all pointed to AWS US (api.keboola.com) without explanation. Rather than adding a cross-stack selector inside the portal app (which breaks auth), this makes the static docs the authoritative entry point — each stack gets a direct link.Test plan
api.*portal links resolve correctly#api-documentation-portalsworks from the info callout link