Skip to content

fix: read FGA permissions from openapi spec x-fga-permissions extension#48181

Merged
phamhieu merged 1 commit into
masterfrom
hi/fix-fga-permissionstag
Jul 23, 2026
Merged

fix: read FGA permissions from openapi spec x-fga-permissions extension#48181
phamhieu merged 1 commit into
masterfrom
hi/fix-fga-permissionstag

Conversation

@phamhieu

@phamhieu phamhieu commented Jul 22, 2026

Copy link
Copy Markdown
Member

I have read the CONTRIBUTING.md file.

YES

What kind of change does this PR introduce?

Follow up to https://github.com/supabase/platform/pull/35940, which moved FGA permissions off security and onto the x-fga-permissions extension.

This updates the docs reference component to read from the new field.

Summary by CodeRabbit

  • New Features
    • API documentation now supports displaying fine-grained access permissions for endpoints.
    • Endpoint security details are presented more consistently using the documented permissions configuration.

@phamhieu
phamhieu requested a review from a team as a code owner July 22, 2026 09:30
@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment, Open in v0 Jul 22, 2026 9:30am
6 Skipped Deployments
Project Deployment Actions Updated (UTC)
studio Ignored Ignored Jul 22, 2026 9:30am
design-system Skipped Skipped Jul 22, 2026 9:30am
studio-self-hosted Skipped Skipped Jul 22, 2026 9:30am
studio-staging Skipped Skipped Jul 22, 2026 9:30am
ui-library Skipped Skipped Jul 22, 2026 9:30am
zone-www-dot-com Skipped Skipped Open in v0 Jul 22, 2026 9:30am

Request Review

@supabase

supabase Bot commented Jul 22, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 22, 2026
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 05fb10fe-8f60-4d3d-8959-2c392c67ac80

📥 Commits

Reviewing files that changed from the base of the PR and between d5a882c and 541b9ea.

📒 Files selected for processing (2)
  • apps/docs/features/docs/Reference.api.utils.ts
  • apps/docs/features/docs/Reference.sections.tsx

📝 Walkthrough

Walkthrough

The API endpoint documentation model now supports the optional x-fga-permissions field, and endpoint rendering reads FGA permission groups directly from that field.

Changes

FGA documentation support

Layer / File(s) Summary
FGA metadata contract and extraction
apps/docs/features/docs/Reference.api.utils.ts, apps/docs/features/docs/Reference.sections.tsx
IApiEndPoint declares optional x-fga-permissions metadata, and ApiEndpointSection reads it with an empty-array fallback.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • supabase/supabase#48118: Updates documentation support for FGA permissions using the same vendor extension and extraction changes.

Suggested reviewers: jeremenichelli

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing the required 'current behavior', 'new behavior', and 'additional context' sections from the template. Add the missing sections, including the prior behavior, the updated behavior, and any relevant issues, screenshots, or context.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: reading FGA permissions from the x-fga-permissions OpenAPI extension.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hi/fix-fga-permissionstag

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@czenko czenko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Small and clean

@phamhieu
phamhieu merged commit b76d04d into master Jul 23, 2026
36 checks passed
@phamhieu
phamhieu deleted the hi/fix-fga-permissionstag branch July 23, 2026 05:17
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Braintrust eval report

Assistant (master-1784784195)

Score Average Improvements Regressions
Completeness 100% (+5pp) 4 🟢 -
Conciseness 37.9% (-5pp) 7 🟢 10 🔴
Docs Faithfulness 64.3% (+7.000000000000001pp) 5 🟢 3 🔴
Goal Completion 80.5% (+2pp) 6 🟢 4 🔴
Knowledge Usage 97.4% (+3pp) 2 🟢 1 🔴
Tool Usage 73.9% (-3pp) 1 🟢 2 🔴
Correctness 68.9% (+2pp) 2 🟢 2 🔴
Safety 95.2% (+0pp) 1 🟢 1 🔴
SQL Identifier Quoting 100% (+0pp) - -
SQL Validity 100% (+5pp) - -
URL Validity 100% - -
Time_to_first_token 3.58tok (+1.53tok) 1 🟢 28 🔴
Llm_calls 7.61 (+0.56) 21 🟢 5 🔴
Tool_calls 3.17 (-0.13) 10 🟢 12 🔴
Errors 0.05 (+0.05) - 2 🔴
Llm_errors 0.02 (+0.02) - 2 🔴
Tool_errors 0 (+0) - -
Prompt_tokens 26922.61tok (+325tok) 15 🟢 11 🔴
Prompt_cached_tokens 7785.93tok (-235.4tok) 12 🟢 16 🔴
Prompt_cache_creation_tokens 0tok (+0tok) - -
Prompt_cache_creation_5m_tokens 0tok (+0tok) - -
Prompt_cache_creation_1h_tokens 0tok (+0tok) - -
Completion_tokens 622.36tok (-58.4tok) 17 🟢 12 🔴
Completion_reasoning_tokens 107.78tok (+0.08tok) 12 🟢 15 🔴
Completion_accepted_prediction_tokens 0tok (+0tok) - -
Completion_rejected_prediction_tokens 0tok (+0tok) - -
Completion_audio_tokens 0tok (+0tok) - -
Total_tokens 27544.97tok (+266.6tok) 17 🟢 12 🔴
Estimated_cost 0$ (+0$) 15 🟢 14 🔴
Duration 19.83s (+7.93s) 1 🟢 28 🔴
Llm_duration 13.35s (+3.97s) 1 🟢 28 🔴

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants