Commit Graph
8 Commits
Author SHA1 Message Date
David Camacho CateuraandChris Chinchilla 91556c8cf9 docs: Adds allowed plans to endpoint specs (#46335)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Updates the management API docs to correctly display what plans can
access specific endpoints, if they are restricted.

## What is the current behavior?

We don't show what plans can access what endpoints.

## What is the new behavior?

Updates the management API docs to correctly display what plans can
access specific endpoints, if they are restricted. No message is shown
if they are no restricted.

<img width="1304" height="703" alt="image"
src="https://github.com/user-attachments/assets/06849d04-babd-4acb-b8ef-b89f8247852e"
/>

## Additional context

Needs https://github.com/supabase/platform/pull/33185, but they are not
coupled and nothing will be broken if the attributes don't exist.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

## Release Notes

* **New Features**
* API reference documentation now displays which pricing plans support
each endpoint, helping users identify plan availability at a glance.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46335?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

<!-- review_stack_entry_end -->

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-05-27 15:17:39 +02:00
HieuandChris Chinchilla e96efe695f feat: show required permissions in mgmt api docs (#41151)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Show required FGA permissions for each route in the management API docs.

Permissions are pulled from the `fga_permissions` security field in the
OpenAPI spec.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* API reference docs now extract and display fine-grained access-control
permissions per endpoint. When present, a dedicated block lists required
permissions with a clear header explaining the token requirements.
* The permissions block appears alongside existing OAuth scope
information and only shows for endpoints that declare such permissions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-03 20:56:45 +00:00
6d9176187e docs: update js client libraries (2.78.0) (#40013)
* docs: update js client libraries (2.78.0)

* fix(docs): add fallback for unhandled schema types in API reference

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2025-10-31 13:22:10 +02:00
Kamil Ogórek 564ebfc274 feat(docs): Add required oauth scope to API endpoints (#39723) 2025-10-22 15:19:23 +02:00
Kamil Ogórek 9b7884f50c docs: Add deprecated label to mgmt api docs (#33734) 2025-02-21 09:46:35 +00:00
a67fcb1809 docs: Regenerate specs for all API docs references (#33265)
* docs: Regenerate specs for all API docs references

* Fix the reference docs parsing.

* Update snapshots of docs tests.

* fix(ui): hide details panel for file params

* fix(ui): fix array display when inner type is not given

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-02-04 14:57:17 +01:00
Charis 11e19ff29f refactor(docs): convert self-hosting to app router (#29268)
* chore(docs,refs): prebuild self-hosted ref data

Pregenerate self-hosted ref data files, in the style of the client lib,
Management API, and CLI references. Preparatory step for migrating the
self-hosted references to App Router.

* refactor(docs): convert self-hosting to app router

Convert self-hosting reference pages to App Router.

* fix(docs,sitemap)
2024-09-13 09:45:55 -04:00
Charis 33ede6f893 refactor(docs): convert management api reference to app router (#29146)
* chore(docs): preprocess management api specs

In preparation for App Router migration of Management API reference,
preprocess the Management API spec (both OpenAPI spec and common
sections), and write the processed data to file, in the style of the
other pregenerated reference data.

Details:

- Split reference section generation into separate functions for SDK, CLI, and API
- Add new function to generate API reference sections from OpenAPI spec
- Introduce mapEndpointsById function to create a map of API endpoints
- Update run function to execute all reference generation tasks in parallel
- Import necessary new dependencies and types

* refactor(docs): migrate management api reference to app router

* fix(docs): statically build management api reference page

* fix(docs): minor styling issues
2024-09-11 13:53:45 -04:00