diff --git a/apps/reference/_api/usage.mdx b/apps/reference/_api/usage.mdx index 26e64d10479..09584d7a96b 100644 --- a/apps/reference/_api/usage.mdx +++ b/apps/reference/_api/usage.mdx @@ -5,17 +5,25 @@ title: Usage toc_max_heading_level: 3 --- -import Tabs from '@theme/Tabs' -import TabItem from '@theme/TabItem' +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + + ## Organizations {#organizations} Organization endpoints + + ### List all organizations {#list-all-organizations} @@ -26,8 +34,15 @@ GET https://api.supabase.com/v1/organizations + + + + + + + #### Responses @@ -36,8 +51,11 @@ GET https://api.supabase.com/v1/organizations + + + ```json { "schema": { @@ -52,12 +70,16 @@ GET https://api.supabase.com/v1/organizations "type": "string" } }, - "required": ["id", "name"] + "required": [ + "id", + "name" + ] } } } ``` + @@ -68,6 +90,8 @@ Unexpected error listing organizations + + @@ -76,6 +100,7 @@ Unexpected error listing organizations
+ ### Create an organization {#create-an-organization} @@ -86,8 +111,14 @@ POST https://api.supabase.com/v1/organizations + + + + + + #### Body Parameters ```json @@ -99,11 +130,14 @@ POST https://api.supabase.com/v1/organizations "type": "string" } }, - "required": ["name"] + "required": [ + "name" + ] } } ``` + #### Responses @@ -112,8 +146,11 @@ POST https://api.supabase.com/v1/organizations + + + ```json { "schema": { @@ -126,11 +163,15 @@ POST https://api.supabase.com/v1/organizations "type": "string" } }, - "required": ["id", "name"] + "required": [ + "id", + "name" + ] } } ``` + @@ -141,6 +182,8 @@ Unexpected error creating an organization + + @@ -149,10 +192,14 @@ Unexpected error creating an organization
+ + ## Projects {#projects} Project endpoints + + ### List all projects {#list-all-projects} @@ -163,8 +210,15 @@ GET https://api.supabase.com/v1/projects + + + + + + + #### Responses @@ -173,8 +227,11 @@ GET https://api.supabase.com/v1/projects + + + ```json { "schema": { @@ -198,12 +255,19 @@ GET https://api.supabase.com/v1/projects "type": "string" } }, - "required": ["id", "organization_id", "name", "region", "created_at"] + "required": [ + "id", + "organization_id", + "name", + "region", + "created_at" + ] } } } ``` + @@ -212,6 +276,7 @@ GET https://api.supabase.com/v1/projects
+ ### Create a project {#create-a-project} @@ -222,8 +287,14 @@ POST https://api.supabase.com/v1/projects + + + + + + #### Body Parameters ```json @@ -242,7 +313,10 @@ POST https://api.supabase.com/v1/projects }, "plan": { "type": "string", - "enum": ["free", "pro"] + "enum": [ + "free", + "pro" + ] }, "region": { "type": "string", @@ -265,11 +339,18 @@ POST https://api.supabase.com/v1/projects "type": "boolean" } }, - "required": ["db_pass", "name", "organization_id", "plan", "region"] + "required": [ + "db_pass", + "name", + "organization_id", + "plan", + "region" + ] } } ``` + #### Responses @@ -278,8 +359,11 @@ POST https://api.supabase.com/v1/projects + + + ```json { "schema": { @@ -301,11 +385,18 @@ POST https://api.supabase.com/v1/projects "type": "string" } }, - "required": ["id", "organization_id", "name", "region", "created_at"] + "required": [ + "id", + "organization_id", + "name", + "region", + "created_at" + ] } } ``` + @@ -314,6 +405,7 @@ POST https://api.supabase.com/v1/projects
+ ### List all functions {#list-all-functions} @@ -324,24 +416,39 @@ GET https://api.supabase.com/v1/projects/{ref}/functions + #### Path Parameters + + + + + + #### Responses @@ -350,8 +457,11 @@ GET https://api.supabase.com/v1/projects/{ref}/functions + + + ```json { "schema": { @@ -369,7 +479,11 @@ GET https://api.supabase.com/v1/projects/{ref}/functions "type": "string" }, "status": { - "enum": ["ACTIVE", "REMOVED", "THROTTLED"], + "enum": [ + "ACTIVE", + "REMOVED", + "THROTTLED" + ], "type": "string" }, "version": { @@ -399,14 +513,19 @@ GET https://api.supabase.com/v1/projects/{ref}/functions } ``` + + + + + @@ -417,6 +536,8 @@ Failed to retrieve project's functions + + @@ -425,6 +546,7 @@ Failed to retrieve project's functions
+ ### Create a function {#create-a-function} @@ -435,24 +557,38 @@ POST https://api.supabase.com/v1/projects/{ref}/functions + #### Path Parameters + + + + + #### Body Parameters ```json @@ -474,11 +610,16 @@ POST https://api.supabase.com/v1/projects/{ref}/functions "type": "boolean" } }, - "required": ["slug", "name", "body"] + "required": [ + "slug", + "name", + "body" + ] } } ``` + #### Responses @@ -487,8 +628,11 @@ POST https://api.supabase.com/v1/projects/{ref}/functions + + + ```json { "schema": { @@ -504,7 +648,11 @@ POST https://api.supabase.com/v1/projects/{ref}/functions "type": "string" }, "status": { - "enum": ["ACTIVE", "REMOVED", "THROTTLED"], + "enum": [ + "ACTIVE", + "REMOVED", + "THROTTLED" + ], "type": "string" }, "version": { @@ -533,14 +681,19 @@ POST https://api.supabase.com/v1/projects/{ref}/functions } ``` + + + + + @@ -551,6 +704,8 @@ Failed to create project's function + + @@ -559,6 +714,7 @@ Failed to create project's function
+ ### Retrieve a function {#retrieve-a-function} @@ -569,34 +725,57 @@ GET https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + #### Path Parameters + + + + + + #### Responses @@ -605,8 +784,11 @@ GET https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + + + ```json { "schema": { @@ -622,7 +804,11 @@ GET https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} "type": "string" }, "status": { - "enum": ["ACTIVE", "REMOVED", "THROTTLED"], + "enum": [ + "ACTIVE", + "REMOVED", + "THROTTLED" + ], "type": "string" }, "version": { @@ -654,14 +840,19 @@ GET https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} } ``` + + + + + @@ -672,6 +863,8 @@ Failed to retrieve function with given slug + + @@ -680,6 +873,7 @@ Failed to retrieve function with given slug
+ ### Update a function {#update-a-function} @@ -690,34 +884,56 @@ PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + #### Path Parameters + + + + + #### Body Parameters ```json @@ -739,6 +955,7 @@ PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} } ``` + #### Responses @@ -747,8 +964,11 @@ PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + + + ```json { "schema": { @@ -764,7 +984,11 @@ PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} "type": "string" }, "status": { - "enum": ["ACTIVE", "REMOVED", "THROTTLED"], + "enum": [ + "ACTIVE", + "REMOVED", + "THROTTLED" + ], "type": "string" }, "version": { @@ -793,14 +1017,19 @@ PATCH https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} } ``` + + + + + @@ -811,6 +1040,8 @@ Failed to update function with given slug + + @@ -819,6 +1050,7 @@ Failed to update function with given slug
+ ### Delete a function {#delete-a-function} @@ -829,34 +1061,57 @@ DELETE https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + #### Path Parameters + + + + + + #### Responses @@ -865,16 +1120,24 @@ DELETE https://api.supabase.com/v1/projects/{ref}/functions/{function_slug} + + + + + + + + @@ -885,6 +1148,8 @@ Failed to delete function with given slug + + @@ -893,6 +1158,7 @@ Failed to delete function with given slug
+ ### List all secrets {#list-all-secrets} @@ -903,24 +1169,39 @@ GET https://api.supabase.com/v1/projects/{ref}/secrets + #### Path Parameters + + + + + + #### Responses @@ -929,8 +1210,11 @@ GET https://api.supabase.com/v1/projects/{ref}/secrets + + + ```json { "schema": { @@ -945,20 +1229,28 @@ GET https://api.supabase.com/v1/projects/{ref}/secrets "type": "string" } }, - "required": ["name", "value"] + "required": [ + "name", + "value" + ] } } } ``` + + + + + @@ -969,6 +1261,8 @@ Failed to retrieve project's secrets + + @@ -977,6 +1271,7 @@ Failed to retrieve project's secrets
+ ### Bulk create secrets {#bulk-create-secrets} @@ -987,24 +1282,38 @@ POST https://api.supabase.com/v1/projects/{ref}/secrets + #### Path Parameters + + + + + #### Body Parameters ```json @@ -1022,12 +1331,16 @@ POST https://api.supabase.com/v1/projects/{ref}/secrets "pattern": "/^(?!SUPABASE_).*/" } }, - "required": ["name", "value"] + "required": [ + "name", + "value" + ] } } } ``` + #### Responses @@ -1036,16 +1349,24 @@ POST https://api.supabase.com/v1/projects/{ref}/secrets + + + + + + + + @@ -1056,6 +1377,8 @@ Failed to create project's secrets + + @@ -1064,6 +1387,7 @@ Failed to create project's secrets
+ ### Bulk delete secrets {#bulk-delete-secrets} @@ -1074,24 +1398,38 @@ DELETE https://api.supabase.com/v1/projects/{ref}/secrets + #### Path Parameters + + + + + #### Body Parameters ```json @@ -1105,6 +1443,7 @@ DELETE https://api.supabase.com/v1/projects/{ref}/secrets } ``` + #### Responses @@ -1113,8 +1452,11 @@ DELETE https://api.supabase.com/v1/projects/{ref}/secrets + + + ```json { "schema": { @@ -1123,14 +1465,19 @@ DELETE https://api.supabase.com/v1/projects/{ref}/secrets } ``` + + + + + @@ -1141,6 +1488,8 @@ Failed to delete secrets with given names + + @@ -1148,3 +1497,4 @@ Failed to delete secrets with given names
+ diff --git a/apps/reference/_gotrue/config.mdx b/apps/reference/_gotrue/config.mdx index 391c9378400..9a00a5a380e 100644 --- a/apps/reference/_gotrue/config.mdx +++ b/apps/reference/_gotrue/config.mdx @@ -11,21 +11,25 @@ A `config.toml` file is generated after running `supabase init`. This file is located in the `supabase` folder under `supabase/config.toml`. + + + ## General {#general} + + ### `project_id` {#project_id} A string used to distinguish different Supabase projects on the same host. Defaults to the working directory name when running `supabase init`. +
+ + diff --git a/apps/reference/_gotrue/usage.mdx b/apps/reference/_gotrue/usage.mdx index 3a4a64e2d2f..64eed5538f0 100644 --- a/apps/reference/_gotrue/usage.mdx +++ b/apps/reference/_gotrue/usage.mdx @@ -5,11 +5,14 @@ title: Usage toc_max_heading_level: 3 --- -import Tabs from '@theme/Tabs' -import TabItem from '@theme/TabItem' +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + Documentation of the gotrue API. + +