Skip to content

docs(service-role): describe RLS bypass; fix copy script for i18n docs.json - #206

Merged
wixysam merged 2 commits into
mainfrom
service-role-rls-bypass
Jun 28, 2026
Merged

docs(service-role): describe RLS bypass; fix copy script for i18n docs.json#206
wixysam merged 2 commits into
mainfrom
service-role-rls-bypass

Conversation

@wixysam

@wixysam wixysam commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Update JSDoc to describe the new asServiceRole behavior: bypasses entity RLS and field-level security entirely (rolled out via service-role-bypass-rls flag, on for all users as of 2026-06-22). Drops the obsolete "admin role" framing.
  • Reword agents/integrations/functions module descriptions: they weren't actually changed by the backend PR, but the prior "admin-level permissions" wording was based on the synthetic-admin-user model that no longer exists. Trimmed to neutral "elevated permissions, no user session" framing.
  • Fix copy-to-local-docs.js to work with mintlify-docs's i18n navigation.languages[].tabs layout. The previous version crashed at the docs.json update step because it assumed the legacy top-level tabs. The new version walks every locale, locates the SDK Reference group structurally (by /sdk/docs/ page paths), preserves each locale's translated group and subgroup labels, and points all locales at the same English mdx files.

Backend PR that motivated the change: base44/apper#12161.

Paired docs PR: base44-dev/mintlify-docs#service-role-rls-bypass

Test plan

  • npm run create-docs-local runs cleanly against paired mintlify-docs worktree
  • All 7 locales (en, pt-BR, es, he, ja, de, fr) get their SDK Reference paths updated
  • Translated group labels preserved (Cliente, Módulos, etc.)
  • Preview the regenerated reference pages locally with mintlify dev

🤖 Generated with Claude Code

…docs.json

`asServiceRole` now bypasses entity RLS and field-level security entirely
(backend rolled out via the `service-role-bypass-rls` flag). Reword JSDoc on
the client and entities module to describe this directly, drop the obsolete
"admin role" framing from agents/integrations/functions where the PR did not
change behavior, and replace the User-list example comment with one that
reflects the new semantics.

Also fix `copy-to-local-docs.js` so it works with mintlify-docs's i18n
`navigation.languages[].tabs` layout. The previous version crashed at the
docs.json update step because it assumed the legacy top-level `tabs`. The new
version walks every locale, locates the SDK Reference group by content
(pages referencing `/sdk/docs/`), preserves each locale's translated group
and subgroup labels, and points every locale at the same English mdx files
(matching what the docs site shows in practice).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude

claude Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error —— View job


I'll analyze this and get back to you.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/sdk@0.8.34-pr.206.82a825e

Prefer not to change any import paths? Install using npm alias so your code still imports @base44/sdk:

npm i "@base44/sdk@npm:@base44-preview/sdk@0.8.34-pr.206.82a825e"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "@base44/sdk": "npm:@base44-preview/sdk@0.8.34-pr.206.82a825e"
  }
}

Preview published to npm registry — try new features instantly!

@cowchimp cowchimp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

looks good. see comments inline

Comment thread src/modules/agents.types.ts Outdated
Comment thread src/modules/functions.types.ts Outdated
…ions/functions

A synthetic user is still used to process service-role requests; the PR only
adds RLS bypass on top, and only for entity CRUD. Reframe these three module
descriptions as "service role for backend code that needs elevated
permissions" rather than implying there's no user context.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude

claude Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Claude encountered an error —— View job


I'll analyze this and get back to you.

@wixysam
wixysam merged commit 236c07a into main Jun 28, 2026
3 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants