docs: add read-only access skill for SDK users#1139
Open
pyramation wants to merge 2 commits into
Open
Conversation
…nd read-only API keys
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
…rences (SPRT, AuthzNotReadOnly, pgSettings)
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
Adds a new
.agents/skills/read-only-access/SKILL.mddocumenting both read-only access mechanisms for SDK consumers:isReadOnlyon entity-scoped memberships) — per-entity, per-member restriction via restrictive RLS policiesaccessLevel: 'read_only') — transaction-level enforcement that blocks all writesIncludes SDK/CLI examples, GraphQL mutations, behavior tables, scope details, and a comparison of when to use each mechanism.
This documents features implemented in constructive-db PR #814 (read-only memberships module) and the existing
graphile.tsenforcement for read-only API keys.Updates since last revision
AuthzNotReadOnly,pgSettings) per "no private things" requirement — docs now describe behavior without exposing implementationisReadOnlyat invite time; members must be updated after joiningupdateOrgMembershipGraphQL example as the primary workfloworg-membership createis admin/owner only and bypasses the invite flowReview & Testing Checklist for Human
updateOrgMembershipGraphQL mutation shape (input: { id, patch: { isReadOnly } }) matches the actual generated schema — PostGraphile update mutations sometimes usenodeIdor different patch patternscreateApiKeyGraphQL mutation field names and return fields (apiKey,accessLevel) match the actual schema--isReadOnlyor--is-read-only? Generated reference shows--isReadOnlybut verify against actual CLI behaviorNotes
references/create-api-key.md) already exposes--input.accessLevel <String>but with no explanation — this skill provides the missing conceptual documentation.node-type-registrybuild errors visible in CI are pre-existing on main (missing@babel/typesdependency) and unrelated to this docs-only change.Link to Devin session: https://app.devin.ai/sessions/5b846ad23d754cbe903fa86b27c109b4
Requested by: @pyramation