Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

docs: Adds allowed plans to endpoint specs (#46335)

David Camacho Cateura91556c8cf9c3
diff --git a/apps/docs/features/docs/Reference.api.utils.ts b/apps/docs/features/docs/Reference.api.utils.ts
index 7461d79a9ce..480da7d88d4 100644
--- a/apps/docs/features/docs/Reference.api.utils.ts
+++ b/apps/docs/features/docs/Reference.api.utils.ts
@@ -25,6 +25,7 @@ export interface IApiEndPoint {
tags?: Array<string>
security?: Array<ISecurityOption>
'x-oauth-scope'?: string
+ 'x-allowed-plans'?: string[]
}
export type ISchema =
diff --git a/apps/docs/features/docs/Reference.sections.tsx b/apps/docs/features/docs/Reference.sections.tsx
index 382fdcfb2fb..40cfdcc126c 100644
--- a/apps/docs/features/docs/Reference.sections.tsx
+++ b/apps/docs/features/docs/Reference.sections.tsx
@@ -358,6 +358,20 @@ async function ApiEndpointSection({ link, section, servicePath }: ApiEndpointSec
</ul>
</section>
)}
+ {endpointDetails['x-allowed-plans'] && (
+ <section>
+ <h3 className="mb-3 text-base text-foreground">
+ This endpoint is only available on the following plans:
+ </h3>
+ <ul>
+ {endpointDetails['x-allowed-plans'].map((plan) => (
+ <li key={plan} className="list-['-'] ml-2 pl-2">
+ <span className="font-mono text-sm font-medium text-foreground">{plan}</span>
+ </li>
+ ))}
+ </ul>
+ </section>
+ )}
{endpointFgaPermissionGroups.length > 0 && (
<section>
<h3 className="mb-3 text-base text-foreground">