docs: add Data API access requirements to guides and SDK docs#1163
Closed
everettbu wants to merge 7 commits into
Closed
docs: add Data API access requirements to guides and SDK docs#1163everettbu wants to merge 7 commits into
everettbu wants to merge 7 commits into
Conversation
Update API quickstart and creating-routes guides to include steps for granting Data API permissions via SQL GRANT statements and the table editor toggle. Add a new "Enable Data API access" section to all SDK installing docs explaining the permission requirements. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Update the shared quickstart_db_setup partial to include the grant statement for enabling Data API access, and mention the toggle when using the Table Editor. This update affects all framework quickstart guides (Next.js, React, Flutter, etc). Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Clarify that each client library uses the Data API to query and mutate Postgres data, and fix toggle label to "Data API Access". Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Include grant execute on function alongside table grants in the Data API access section. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Author
|
Upstream PR was closed or merged. Code is synced via branch mirror. |
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
2 participants
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.
Mirror of supabase/supabase#42473
Original author: SaxonF
I have read the CONTRIBUTING.md file.
YES
What kind of change does this PR introduce?
Documentation update
What is the current behavior?
The API quickstart, creating routes guide, and SDK installing documentation do not mention that tables need Data API permissions granted before they can be accessed via the API.
What is the new behavior?
Updated the Data API quickstart and creating-routes guides to include steps for granting permissions via SQL GRANT statements and the table editor "Enable Data API Access" toggle. Added a new "Enable Data API access" section to all SDK installing documentation that explains the permission requirements.
Additional context
These changes support the rollout of updated Data API permission handling. The documentation wording is neutral to support both users with and without the default grant experiment enabled.