From bd0514553c627db8f1e8d0b3ae440ccb6759d228 Mon Sep 17 00:00:00 2001 From: Jonathan Summers-Muir Date: Sun, 11 Dec 2022 15:00:22 +0800 Subject: [PATCH] changed yaml files --- .../NavigationMenu/NavigationMenu.tsx | 8 +- .../NavigationMenu/NavigationMenuCliList.tsx | 24 +- apps/docs/package.json | 8 +- apps/docs/pages/reference/cli/[...slug].tsx | 2 +- apps/docs/pages/reference/dart/[...slug].tsx | 2 +- .../pages/reference/dart/v0/[...slug].tsx | 2 +- .../pages/reference/javascript/[...slug].tsx | 2 +- .../javascript/crawlers/[...slug].tsx | 2 +- .../reference/javascript/v1/[...slug].tsx | 2 +- apps/docs/public/sitemap.xml | 336 ++++---- ...w_shape.yaml => cli_v1_commands--old.yaml} | 771 ++++++++++------- spec/cli_v1_commands.yaml | 771 +++++++---------- spec/common-client-libs-sections-old.json | 793 ------------------ ...emp_new_shape.yml => supabase_dart_v0.yml} | 0 ...emp_new_shape.yml => supabase_dart_v1.yml} | 0 ..._temp_new_shape.yml => supabase_js_v1.yml} | 0 ..._temp_new_shape.yml => supabase_js_v2.yml} | 0 17 files changed, 967 insertions(+), 1756 deletions(-) rename spec/{cli_v1_commands_new_shape.yaml => cli_v1_commands--old.yaml} (53%) delete mode 100644 spec/common-client-libs-sections-old.json rename spec/{supabase_dart_v0_temp_new_shape.yml => supabase_dart_v0.yml} (100%) rename spec/{supabase_dart_v1_temp_new_shape.yml => supabase_dart_v1.yml} (100%) rename spec/{supabase_js_v1_temp_new_shape.yml => supabase_js_v1.yml} (100%) rename spec/{supabase_js_v2_temp_new_shape.yml => supabase_js_v2.yml} (100%) diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx index 4083ead9bdd..83cbefda303 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx @@ -7,13 +7,13 @@ import NavigationMenuGuideList from './NavigationMenuGuideList' import NavigationMenuRefList from './NavigationMenuRefList' // @ts-expect-error -import spec_js_v2 from '~/../../spec/supabase_js_v2_temp_new_shape.yml' assert { type: 'yml' } +import spec_js_v2 from '~/../../spec/supabase_js_v2.yml' assert { type: 'yml' } // @ts-expect-error -import spec_js_v1 from '~/../../spec/supabase_js_v1_temp_new_shape.yml' assert { type: 'yml' } +import spec_js_v1 from '~/../../spec/supabase_js_v1.yml' assert { type: 'yml' } // @ts-expect-error -import spec_dart_v1 from '~/../../spec/supabase_dart_v1_temp_new_shape.yml' assert { type: 'yml' } +import spec_dart_v1 from '~/../../spec/supabase_dart_v1.yml' assert { type: 'yml' } // @ts-expect-error -import spec_dart_v0 from '~/../../spec/supabase_dart_v0_temp_new_shape.yml' assert { type: 'yml' } +import spec_dart_v0 from '~/../../spec/supabase_dart_v0.yml' assert { type: 'yml' } // import { gen_v3 } from '~/lib/refGenerator/helpers' import libCommonSections from '~/../../spec/common-client-libs-sections.json' diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx index cc32ca920a2..a0b4c10dc6d 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuCliList.tsx @@ -2,8 +2,7 @@ import Link from 'next/link' import { useRouter } from 'next/router' import { IconChevronLeft } from 'ui' import * as NavItems from './NavigationMenu.constants' -// @ts-expect-error -import jsSpec from '~/../../spec/supabase_js_v2_temp_new_shape.yml' assert { type: 'yml' } + // @ts-expect-error import clientLibsCommon from '~/../../spec/common-cli.yml' assert { type: 'yml' } @@ -11,20 +10,6 @@ const NavigationMenuCliList = ({ currentLevel, setLevel, id }) => { const router = useRouter() const menu = NavItems[id] - let functions = jsSpec.functions - - functions = functions.map((func) => { - let data = { - ...func, - } - data = { - ...data, - ...clientLibsCommon.commands.filter((x) => { - return x.id === func.id - })[0], - } - return data - }) const FunctionLink = ({ title, @@ -148,12 +133,7 @@ const NavigationMenuCliList = ({ currentLevel, setLevel, id }) => { {clientLibsCommon.commands .filter((x) => x.product === section.key) .map((x, index) => { - // console.log(functions) - return ( - <> - - - ) + return })} ) diff --git a/apps/docs/package.json b/apps/docs/package.json index d68fd425282..8a398781fe3 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -22,13 +22,13 @@ "gen:storage:api": "ts-node ./generator/index.ts gen --type api --input ../../spec/transforms/storage_v0_openapi_deparsed.json --output ./docs/reference/storage/generated/usage.mdx", "gen:storage:config": "ts-node ./generator/index.ts gen --type config --input ../../spec/storage_v0_config.yaml --output ./docs/reference/storage/generated/config.mdx", "gen:supabase-dart:v0": "npm-run-all gen:supabase-dart:v0:ref", - "gen:supabase-dart:v0:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_dart_v0_temp_new_shape.yml --output ./docs/reference/dart/v0/generated", + "gen:supabase-dart:v0:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_dart_v0.yml --output ./docs/reference/dart/v0/generated", "gen:supabase-dart:v1": "npm-run-all gen:supabase-dart:v1:ref", - "gen:supabase-dart:v1:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_dart_v1_temp_new_shape.yml --output ./docs/reference/dart/generated", + "gen:supabase-dart:v1:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_dart_v1.yml --output ./docs/reference/dart/generated", "gen:supabase-js:v1": "npm-run-all gen:supabase-js:v1:ref", - "gen:supabase-js:v1:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_js_v1_temp_new_shape.yml --output ./docs/reference/javascript/v1/generated", + "gen:supabase-js:v1:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_js_v1.yml --output ./docs/reference/javascript/v1/generated", "gen:supabase-js:v2": "npm-run-all gen:supabase-js:v2:ref", - "gen:supabase-js:v2:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_js_v2_temp_new_shape.yml --output ./docs/reference/javascript/generated", + "gen:supabase-js:v2:ref": "ts-node ./generator/index.ts gen --type legacy --input ../../spec/supabase_js_v2.yml --output ./docs/reference/javascript/generated", "gen:realtime": "npm-run-all gen:realtime:config", "gen:realtime:config": "ts-node ./generator/index.ts gen --type config --input ../../spec/realtime_v0_config.yaml --output ./docs/reference/realtime/generated/config.mdx" }, diff --git a/apps/docs/pages/reference/cli/[...slug].tsx b/apps/docs/pages/reference/cli/[...slug].tsx index 8da57ec4930..2e4a2218b3e 100644 --- a/apps/docs/pages/reference/cli/[...slug].tsx +++ b/apps/docs/pages/reference/cli/[...slug].tsx @@ -1,5 +1,5 @@ // @ts-expect-error -import spec from '~/../../spec/cli_v1_commands_new_shape.yaml' assert { type: 'yml' } +import spec from '~/../../spec/cli_v1_commands.yaml' assert { type: 'yml' } import { flattenSections } from '~/lib/helpers' diff --git a/apps/docs/pages/reference/dart/[...slug].tsx b/apps/docs/pages/reference/dart/[...slug].tsx index 2b12d53331c..4fecc97170d 100644 --- a/apps/docs/pages/reference/dart/[...slug].tsx +++ b/apps/docs/pages/reference/dart/[...slug].tsx @@ -1,6 +1,6 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' // @ts-expect-error -import spec from '~/../../spec/supabase_dart_v1_temp_new_shape.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_dart_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/dart/v0/[...slug].tsx b/apps/docs/pages/reference/dart/v0/[...slug].tsx index d9dc776d0d2..f0daf4e9d6e 100644 --- a/apps/docs/pages/reference/dart/v0/[...slug].tsx +++ b/apps/docs/pages/reference/dart/v0/[...slug].tsx @@ -1,6 +1,6 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' // @ts-expect-error -import spec from '~/../../spec/supabase_dart_v0_temp_new_shape.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_dart_v0.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/javascript/[...slug].tsx b/apps/docs/pages/reference/javascript/[...slug].tsx index ac31d75a6fe..cab58348221 100644 --- a/apps/docs/pages/reference/javascript/[...slug].tsx +++ b/apps/docs/pages/reference/javascript/[...slug].tsx @@ -1,7 +1,7 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' import typeSpec from '~/../../spec/enrichments/tsdoc_v2/combined.json' // @ts-expect-error -import spec from '~/../../spec/supabase_js_v2_temp_new_shape.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_js_v2.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/javascript/crawlers/[...slug].tsx b/apps/docs/pages/reference/javascript/crawlers/[...slug].tsx index 7def5e4ae4a..ca8e6de684e 100644 --- a/apps/docs/pages/reference/javascript/crawlers/[...slug].tsx +++ b/apps/docs/pages/reference/javascript/crawlers/[...slug].tsx @@ -15,7 +15,7 @@ import jsTypeSpec from '~/../../spec/enrichments/tsdoc_v2/combined.json' // @ts-ignore import examples from '~/../../spec/examples/examples.yml' assert { type: 'yml' } // @ts-expect-error -import jsSpec from '~/../../spec/supabase_js_v2_temp_new_shape.yml' assert { type: 'yml' } +import jsSpec from '~/../../spec/supabase_js_v2.yml' assert { type: 'yml' } // @ts-expect-error import commonLibSpec from '~/../../spec/common-client-libs.yml' assert { type: 'yml' } diff --git a/apps/docs/pages/reference/javascript/v1/[...slug].tsx b/apps/docs/pages/reference/javascript/v1/[...slug].tsx index 277a0c71f79..d54c9df6d94 100644 --- a/apps/docs/pages/reference/javascript/v1/[...slug].tsx +++ b/apps/docs/pages/reference/javascript/v1/[...slug].tsx @@ -1,7 +1,7 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' import typeSpec from '~/../../spec/enrichments/tsdoc_v1/combined.json' // @ts-expect-error -import spec from '~/../../spec/supabase_js_v1_temp_new_shape.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_js_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/public/sitemap.xml b/apps/docs/public/sitemap.xml index 40c31b65054..c8980f7e838 100644 --- a/apps/docs/public/sitemap.xml +++ b/apps/docs/public/sitemap.xml @@ -60,6 +60,30 @@ 0.5 + + https://supabase.com/docs/company/aup + weekly + 0.5 + + + + https://supabase.com/docs/company/privacy + weekly + 0.5 + + + + https://supabase.com/docs/company/sla + weekly + 0.5 + + + + https://supabase.com/docs/company/terms + weekly + 0.5 + + https://supabase.com/docs/handbook/contributing weekly @@ -78,24 +102,6 @@ 0.5 - - https://supabase.com/docs/new/auth - weekly - 0.5 - - - - https://supabase.com/docs/new/index - weekly - 0.5 - - - - https://supabase.com/docs/tutorials/nextjs - weekly - 0.5 - - https://supabase.com/docs/guides/api weekly @@ -246,6 +252,18 @@ 0.5 + + https://supabase.com/docs/new/auth + weekly + 0.5 + + + + https://supabase.com/docs/new/index + weekly + 0.5 + + https://supabase.com/docs/reference/index weekly @@ -253,19 +271,7 @@ - https://supabase.com/docs/getting-started/quickstarts/nextjs - weekly - 0.5 - - - - https://supabase.com/docs/getting-started/quickstarts/nuxtjs - weekly - 0.5 - - - - https://supabase.com/docs/getting-started/quickstarts/reactjs + https://supabase.com/docs/tutorials/nextjs weekly 0.5 @@ -301,7 +307,19 @@ - https://supabase.com/docs/new/auth/auth-login + https://supabase.com/docs/getting-started/quickstarts/nextjs + weekly + 0.5 + + + + https://supabase.com/docs/getting-started/quickstarts/nuxtjs + weekly + 0.5 + + + + https://supabase.com/docs/getting-started/quickstarts/reactjs weekly 0.5 @@ -510,30 +528,6 @@ 0.5 - - https://supabase.com/docs/guides/functions/auth - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/best-practices - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/cicd-workflow - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/quickstart - weekly - 0.5 - - https://supabase.com/docs/guides/database/arrays weekly @@ -624,6 +618,30 @@ 0.5 + + https://supabase.com/docs/guides/functions/auth + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/best-practices + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/cicd-workflow + weekly + 0.5 + + + + https://supabase.com/docs/guides/functions/quickstart + weekly + 0.5 + + https://supabase.com/docs/guides/hosting/docker weekly @@ -780,30 +798,6 @@ 0.5 - - https://supabase.com/docs/guides/migrations/firebase-auth - weekly - 0.5 - - - - https://supabase.com/docs/guides/migrations/firebase-storage - weekly - 0.5 - - - - https://supabase.com/docs/guides/migrations/firestore-data - weekly - 0.5 - - - - https://supabase.com/docs/guides/migrations/heroku - weekly - 0.5 - - https://supabase.com/docs/guides/platform/compute-add-ons weekly @@ -906,6 +900,30 @@ 0.5 + + https://supabase.com/docs/guides/migrations/firebase-auth + weekly + 0.5 + + + + https://supabase.com/docs/guides/migrations/firebase-storage + weekly + 0.5 + + + + https://supabase.com/docs/guides/migrations/firestore-data + weekly + 0.5 + + + + https://supabase.com/docs/guides/migrations/heroku + weekly + 0.5 + + https://supabase.com/docs/guides/storage/access-control weekly @@ -1014,6 +1032,36 @@ 0.5 + + https://supabase.com/docs/new/auth/auth-login + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/passwordless-login/email-otp-magic-link + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-messagebird + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-twilio + weekly + 0.5 + + + + https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-vonage + weekly + 0.5 + + https://supabase.com/docs/guides/auth/auth-helpers/auth-ui weekly @@ -1045,25 +1093,73 @@ - https://supabase.com/docs/guides/auth/passwordless-login/email-otp-magic-link + https://supabase.com/docs/guides/functions/examples/index weekly 0.5 - https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-messagebird + https://supabase.com/docs/guides/functions/examples/og-image weekly 0.5 - https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-twilio + https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-auth weekly 0.5 - https://supabase.com/docs/guides/auth/passwordless-login/phone-sms-otp-vonage + https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-data + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-storage + weekly + 0.5 + + + + https://supabase.com/docs/guides/resources/migrating-to-supabase/heroku + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/http + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/pgcron + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/pgnet + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/pgtap + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/plv8 + weekly + 0.5 + + + + https://supabase.com/docs/guides/database/extensions/uuid-ossp weekly 0.5 @@ -1176,84 +1272,12 @@ 0.5 - - https://supabase.com/docs/guides/functions/examples/index - weekly - 0.5 - - - - https://supabase.com/docs/guides/functions/examples/og-image - weekly - 0.5 - - https://supabase.com/docs/guides/resources/self-hosting/docker weekly 0.5 - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-auth - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-data - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/firebase-storage - weekly - 0.5 - - - - https://supabase.com/docs/guides/resources/migrating-to-supabase/heroku - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/http - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/pgcron - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/pgnet - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/pgtap - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/plv8 - weekly - 0.5 - - - - https://supabase.com/docs/guides/database/extensions/uuid-ossp - weekly - 0.5 - - https://supabase.com/docs/guides/resources/supabase-cli/local-development weekly diff --git a/spec/cli_v1_commands_new_shape.yaml b/spec/cli_v1_commands--old.yaml similarity index 53% rename from spec/cli_v1_commands_new_shape.yaml rename to spec/cli_v1_commands--old.yaml index f3eab57370e..d7af310d127 100644 --- a/spec/cli_v1_commands_new_shape.yaml +++ b/spec/cli_v1_commands--old.yaml @@ -1,7 +1,7 @@ clispec: '001' info: id: cli - version: 1.14.3 + version: 1.11.3 title: Supabase CLI language: sh source: https://github.com/supabase/cli @@ -9,6 +9,13 @@ info: spec: https://github.com/supabase/supabase.tools/cli_spec/lib.yaml description: | Supabase CLI provides you with tools to develop your application locally, and deploy your application to the Supabase platform. + options: |- + ```sh + --debug output debug logs to stderr + --experimental enable experimental features + -h, --help help for supabase + --workdir string path to a Supabase project directory + ``` tags: - id: local-dev title: Local Development @@ -16,23 +23,6 @@ info: title: Management APIs - id: other-commands title: Additional Commands -flags: - - id: debug - name: --debug - description: output debug logs to stderr - default_value: 'false' - - id: experimental - name: --experimental - description: enable experimental features - default_value: 'false' - - id: help - name: -h, --help - description: help for supabase - default_value: 'false' - - id: workdir - name: --workdir - description: path to a Supabase project directory - default_value: '' commands: - id: supabase-test title: supabase test @@ -42,70 +32,70 @@ commands: links: [] subcommands: - supabase-test-db - flags: [] + options: |- + ```sh + -h, --help help for test + ``` - id: supabase-test-db title: supabase test db summary: Tests local database with pgTAP tags: [] links: [] - usage: supabase test db + usage: |- + ```sh + supabase test db [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for db + ``` - id: supabase-stop title: supabase stop summary: Stop all local Supabase containers tags: - local-dev links: [] - usage: supabase stop [flags] + usage: |- + ```sh + supabase stop [flags] + ``` subcommands: [] - flags: - - id: backup - name: --backup - description: Backs up the current database before stopping. - default_value: 'false' + options: |- + ```sh + --backup Backs up the current database before stopping. + -h, --help help for stop + ``` - id: supabase-status title: supabase status summary: Show status of local Supabase containers tags: - local-dev links: [] - usage: supabase status [flags] + usage: |- + ```sh + supabase status [flags] + ``` subcommands: [] - flags: - - id: output - name: -o, --output - description: Output format of status variables. - default_value: pretty - accepted_values: - - id: env - name: env - type: string - - id: json - name: json - type: string - - id: pretty - name: pretty - type: string - - id: toml - name: toml - type: string - - id: yaml - name: yaml - type: string - - id: override-name - name: --override-name - description: Override specific variable names. - default_value: '[]' + options: |- + ```sh + -h, --help help for status + ``` - id: supabase-start title: supabase start summary: Start containers for Supabase local development tags: - local-dev links: [] - usage: supabase start + usage: |- + ```sh + supabase start [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for start + ``` - id: supabase-secrets title: supabase secrets summary: Manage Supabase secrets @@ -116,38 +106,56 @@ commands: - supabase-secrets-list - supabase-secrets-set - supabase-secrets-unset - flags: [] + options: |- + ```sh + -h, --help help for secrets + ``` - id: supabase-secrets-unset title: supabase secrets unset summary: Unset a secret(s) on Supabase description: Unset a secret(s) from the linked Supabase project. tags: [] links: [] - usage: supabase secrets unset ... + usage: |- + ```sh + supabase secrets unset ... [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for unset + ``` - id: supabase-secrets-set title: supabase secrets set summary: Set a secret(s) on Supabase description: Set a secret(s) to the linked Supabase project. tags: [] links: [] - usage: supabase secrets set [flags] ... + usage: |- + ```sh + supabase secrets set [flags] ... + ``` subcommands: [] - flags: - - id: env-file - name: --env-file - description: Read secrets from a .env file. - default_value: '' + options: |- + ```sh + --env-file string Read secrets from a .env file. + -h, --help help for set + ``` - id: supabase-secrets-list title: supabase secrets list summary: List all secrets on Supabase description: List all secrets in the linked project. tags: [] links: [] - usage: supabase secrets list + usage: |- + ```sh + supabase secrets list [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for list + ``` - id: supabase-projects title: supabase projects summary: Manage Supabase projects @@ -157,88 +165,44 @@ commands: subcommands: - supabase-projects-create - supabase-projects-list - flags: [] + options: |- + ```sh + -h, --help help for projects + ``` - id: supabase-projects-list title: supabase projects list summary: List all Supabase projects description: List all Supabase projects the logged-in user can access. tags: [] links: [] - usage: supabase projects list + usage: |- + ```sh + supabase projects list [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for list + ``` - id: supabase-projects-create title: supabase projects create summary: Create a project on Supabase tags: [] links: [] - usage: supabase projects create [flags] + usage: |- + ```sh + supabase projects create [flags] + ``` subcommands: [] - flags: - - id: db-password - name: --db-password - description: Database password of the project. - default_value: '' - - id: interactive - name: -i, --interactive - description: Enables interactive mode. - default_value: 'false' - - id: org-id - name: --org-id - description: Organization ID to create the project in. - default_value: '' - - id: plan - name: --plan - description: Select a plan that suits your needs. - default_value: free - accepted_values: - - id: free - name: free - type: string - - id: pro - name: pro - type: string - - id: region - name: --region - description: Select a region close to you for the best performance. - default_value: '' - accepted_values: - - id: ca-central-1 - name: ca-central-1 - type: string - - id: eu-west-2 - name: eu-west-2 - type: string - - id: us-east-1 - name: us-east-1 - type: string - - id: ap-south-1 - name: ap-south-1 - type: string - - id: ap-southeast-1 - name: ap-southeast-1 - type: string - - id: ap-southeast-2 - name: ap-southeast-2 - type: string - - id: eu-west-1 - name: eu-west-1 - type: string - - id: sa-east-1 - name: sa-east-1 - type: string - - id: us-west-1 - name: us-west-1 - type: string - - id: ap-northeast-1 - name: ap-northeast-1 - type: string - - id: ap-northeast-2 - name: ap-northeast-2 - type: string - - id: eu-central-1 - name: eu-central-1 - type: string + options: |- + ```sh + --db-password string Database password of the project. + -h, --help help for create + -i, --interactive Enables interactive mode. + --org-id string Organization ID to create the project in. + --plan string Select a plan that suits your needs. (default "free") + --region string Select a region close to you for the best performance. + ``` - id: supabase-orgs title: supabase orgs summary: Manage Supabase organizations @@ -247,16 +211,25 @@ commands: links: [] subcommands: - supabase-orgs-list - flags: [] + options: |- + ```sh + -h, --help help for orgs + ``` - id: supabase-orgs-list title: supabase orgs list summary: List all organizations description: List all organizations the logged-in user belongs. tags: [] links: [] - usage: supabase orgs list + usage: |- + ```sh + supabase orgs list [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for list + ``` - id: supabase-migration title: supabase migration summary: Manage database migration scripts @@ -266,63 +239,86 @@ commands: subcommands: - supabase-migration-list - supabase-migration-new - flags: [] + options: |- + ```sh + -h, --help help for migration + ``` - id: supabase-migration-new title: supabase migration new summary: Create an empty migration script tags: [] links: [] - usage: supabase migration new + usage: |- + ```sh + supabase migration new [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for new + ``` - id: supabase-migration-list title: supabase migration list summary: List local and remote migrations tags: [] links: [] - usage: supabase migration list [flags] + usage: |- + ```sh + supabase migration list [flags] + ``` subcommands: [] - flags: - - id: password - name: -p, --password - description: Password to your remote Postgres database. - default_value: '' + options: |- + ```sh + -h, --help help for list + -p, --password string Password to your remote Postgres database. + ``` - id: supabase-login title: supabase login summary: Authenticate using an access token tags: - local-dev links: [] - usage: supabase login + usage: |- + ```sh + supabase login [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for login + ``` - id: supabase-link title: supabase link summary: Link to a Supabase project tags: - local-dev links: [] - usage: supabase link [flags] + usage: |- + ```sh + supabase link [flags] + ``` subcommands: [] - flags: - - id: password - name: -p, --password - description: Password to your remote Postgres database. - default_value: '' - - id: project-ref - name: --project-ref - description: Project ref of the Supabase project. - required: true - default_value: '' + options: |- + ```sh + -h, --help help for link + -p, --password string Password to your remote Postgres database. + --project-ref string Project ref of the Supabase project. + ``` - id: supabase-init title: supabase init summary: Initialize a local project tags: - local-dev links: [] - usage: supabase init + usage: |- + ```sh + supabase init [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for init + ``` - id: supabase-gen title: supabase gen summary: Run code generation tools @@ -331,7 +327,10 @@ commands: links: [] subcommands: - supabase-gen-types - flags: [] + options: |- + ```sh + -h, --help help for gen + ``` - id: supabase-gen-types title: supabase gen types summary: Generate types from Postgres schema @@ -339,7 +338,10 @@ commands: links: [] subcommands: - supabase-gen-types-typescript - flags: [] + options: |- + ```sh + -h, --help help for types + ``` - id: supabase-gen-types-typescript title: supabase gen types typescript summary: Generate types for TypeScript @@ -347,29 +349,20 @@ commands: Generate types for TypeScript. Must specify one of --local, --linked, --project-id, or --db-url tags: [] links: [] - usage: supabase gen types typescript [flags] + usage: |- + ```sh + supabase gen types typescript [flags] + ``` subcommands: [] - flags: - - id: db-url - name: --db-url - description: Generate types from a database url. - default_value: '' - - id: linked - name: --linked - description: Generate types from the linked project. - default_value: 'false' - - id: local - name: --local - description: Generate types from the local dev database. - default_value: 'false' - - id: project-id - name: --project-id - description: Generate types from a project ID. - default_value: '' - - id: schema - name: --schema - description: Schemas to generate types for. - default_value: '[]' + options: |- + ```sh + --db-url string Generate types from a database url. + -h, --help help for typescript + --linked Generate types from the linked project. + --local Generate types from the local dev database. + --project-id string Generate types from a project ID. + --schema stringArray Schemas to generate types for. + ``` - id: supabase-functions title: supabase functions summary: Manage Supabase Edge functions @@ -381,53 +374,57 @@ commands: - supabase-functions-deploy - supabase-functions-new - supabase-functions-serve - flags: [] + options: |- + ```sh + -h, --help help for functions + ``` - id: supabase-functions-serve title: supabase functions serve summary: Serve a Function locally tags: [] links: [] - usage: supabase functions serve [flags] + usage: |- + ```sh + supabase functions serve [flags] + ``` subcommands: [] - flags: - - id: env-file - name: --env-file - description: | - Path to an env file to be populated to the Function environment. - default_value: '' - - id: no-verify-jwt - name: --no-verify-jwt - description: Disable JWT verification for the Function. - default_value: 'false' + options: |- + ```sh + --env-file string Path to an env file to be populated to the Function environment. + -h, --help help for serve + --no-verify-jwt Disable JWT verification for the Function. + ``` - id: supabase-functions-new title: supabase functions new summary: Create a new Function locally tags: [] links: [] - usage: supabase functions new + usage: |- + ```sh + supabase functions new [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for new + ``` - id: supabase-functions-deploy title: supabase functions deploy summary: Deploy a Function to Supabase description: Deploy a Function to the linked Supabase project. tags: [] links: [] - usage: supabase functions deploy [flags] + usage: |- + ```sh + supabase functions deploy [flags] + ``` subcommands: [] - flags: - - id: legacy-bundle - name: --legacy-bundle - description: Use legacy bundling mechanism. - default_value: 'false' - - id: no-verify-jwt - name: --no-verify-jwt - description: Disable JWT verification for the Function. - default_value: 'false' - - id: project-ref - name: --project-ref - description: Project ref of the Supabase project. - default_value: '' + options: |- + ```sh + -h, --help help for deploy + --no-verify-jwt Disable JWT verification for the Function. + --project-ref string Project ref of the Supabase project. + ``` - id: supabase-functions-delete title: supabase functions delete summary: Delete a Function from Supabase @@ -435,13 +432,16 @@ commands: Delete a Function from the linked Supabase project. This does NOT remove the Function locally. tags: [] links: [] - usage: supabase functions delete [flags] + usage: |- + ```sh + supabase functions delete [flags] + ``` subcommands: [] - flags: - - id: project-ref - name: --project-ref - description: Project ref of the Supabase project. - default_value: '' + options: |- + ```sh + -h, --help help for delete + --project-ref string Project ref of the Supabase project. + ``` - id: supabase-domains title: supabase domains summary: Manage custom domain names for Supabase projects @@ -454,23 +454,26 @@ commands: - supabase-domains-delete - supabase-domains-get - supabase-domains-reverify - flags: - - id: include-raw-output - name: --include-raw-output - description: Include raw output (useful for debugging). - default_value: 'false' - - id: project-ref - name: --project-ref - description: Project ref of the Supabase project. - default_value: '' + options: |- + ```sh + -h, --help help for domains + --include-raw-output Include raw output (useful for debugging). + --project-ref string Project ref of the Supabase project. + ``` - id: supabase-domains-reverify title: supabase domains reverify summary: Re-verify the custom hostname config for your project. tags: [] links: [] - usage: supabase domains reverify + usage: |- + ```sh + supabase domains reverify [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for reverify + ``` - id: supabase-domains-get title: supabase domains get summary: Get the current custom hostname config. @@ -478,17 +481,29 @@ commands: Retrieve the custom hostname config for your project, as stored in the Supabase platform. tags: [] links: [] - usage: supabase domains get + usage: |- + ```sh + supabase domains get [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for get + ``` - id: supabase-domains-delete title: supabase domains delete summary: Deletes the custom hostname config for your project. tags: [] links: [] - usage: supabase domains delete + usage: |- + ```sh + supabase domains delete [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for delete + ``` - id: supabase-domains-create title: supabase domains create summary: Create a custom hostname. @@ -498,13 +513,16 @@ commands: Expects your custom hostname to have a CNAME record to your Supabase project's subdomain. tags: [] links: [] - usage: supabase domains create [flags] + usage: |- + ```sh + supabase domains create [flags] + ``` subcommands: [] - flags: - - id: custom-hostname - name: --custom-hostname - description: The custom hostname to use for your Supabase project. - default_value: '' + options: |- + ```sh + --custom-hostname string The custom hostname to use for your Supabase project. + -h, --help help for create + ``` - id: supabase-domains-activate title: supabase domains activate summary: Activate the custom hostname for a project. @@ -515,9 +533,15 @@ commands: After the custom hostname is activated, your project's auth services will no longer function on the Supabase-provisioned subdomain. tags: [] links: [] - usage: supabase domains activate + usage: |- + ```sh + supabase domains activate [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for activate + ``` - id: supabase-db title: supabase db summary: Manage local Postgres databases @@ -525,20 +549,30 @@ commands: - local-dev links: [] subcommands: + - supabase-db-branch - supabase-db-diff - supabase-db-lint - supabase-db-push - supabase-db-remote - supabase-db-reset - flags: [] + options: |- + ```sh + -h, --help help for db + ``` - id: supabase-db-reset title: supabase db reset summary: Resets the local database to current migrations tags: [] links: [] - usage: supabase db reset + usage: |- + ```sh + supabase db reset [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for reset + ``` - id: supabase-db-remote title: supabase db remote summary: Manage remote databases @@ -547,92 +581,162 @@ commands: subcommands: - supabase-db-remote-changes - supabase-db-remote-commit - flags: - - id: password - name: -p, --password - description: Password to your remote Postgres database. - default_value: '' + options: |- + ```sh + -h, --help help for remote + -p, --password string Password to your remote Postgres database. + ``` - id: supabase-db-remote-commit title: supabase db remote commit summary: Commit remote changes as a new migration tags: [] links: [] - usage: supabase db remote commit + usage: |- + ```sh + supabase db remote commit [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for commit + ``` - id: supabase-db-remote-changes title: supabase db remote changes summary: Show changes on the remote database description: Show changes on the remote database since last migration. tags: [] links: [] - usage: supabase db remote changes + usage: |- + ```sh + supabase db remote changes [flags] + ``` subcommands: [] - flags: [] + options: |- + ```sh + -h, --help help for changes + ``` - id: supabase-db-push title: supabase db push summary: Push new migrations to the remote database tags: [] links: [] - usage: supabase db push [flags] + usage: |- + ```sh + supabase db push [flags] + ``` subcommands: [] - flags: - - id: dry-run - name: --dry-run - description: | - Print the migrations that would be applied, but don't actually apply them. - default_value: 'false' - - id: password - name: -p, --password - description: Password to your remote Postgres database. - default_value: '' + options: |- + ```sh + --dry-run Print the migrations that would be applied, but don't actually apply them. + -h, --help help for push + -p, --password string Password to your remote Postgres database. + ``` - id: supabase-db-lint title: supabase db lint summary: Checks local database for typing error tags: [] links: [] - usage: supabase db lint [flags] + usage: |- + ```sh + supabase db lint [flags] + ``` subcommands: [] - flags: - - id: level - name: --level - description: Error level to emit. - default_value: warning - accepted_values: - - id: warning - name: warning - type: string - - id: error - name: error - type: string - - id: schema - name: -s, --schema - description: List of schema to include. - default_value: '[public]' + options: |- + ```sh + -h, --help help for lint + --level string Error level to emit. (default "warning") + -s, --schema strings List of schema to include. (default [public]) + ``` - id: supabase-db-diff title: supabase db diff summary: Diffs the local database for schema changes tags: [] links: [] - usage: supabase db diff [flags] + usage: |- + ```sh + supabase db diff [flags] + ``` subcommands: [] - flags: - - id: file - name: -f, --file - description: Saves schema diff to a file. - default_value: '' - - id: linked - name: --linked - description: Diffs local schema against linked project. - default_value: 'false' - - id: schema - name: -s, --schema - description: List of schema to include. - default_value: '[public]' - - id: use-migra - name: --use-migra - description: Use migra to generate schema diff. - default_value: 'false' + options: |- + ```sh + -f, --file string Saves schema diff to a file. + -h, --help help for diff + --linked Diffs local schema against linked project. + -s, --schema strings List of schema to include. (default [public]) + --use-migra Use migra to generate schema diff. + ``` + - id: supabase-db-branch + title: supabase db branch + summary: Manage local database branches + description: | + Manage local database branches. Each branch is associated with a separate local database. Forking remote databases is NOT supported. + tags: [] + links: [] + subcommands: + - supabase-db-branch-create + - supabase-db-branch-delete + - supabase-db-branch-list + - supabase-db-branch-switch + options: |- + ```sh + -h, --help help for branch + ``` + - id: supabase-db-branch-switch + title: supabase db branch switch + summary: Switch the active branch + tags: [] + links: [] + usage: |- + ```sh + supabase db branch switch [flags] + ``` + subcommands: [] + options: |- + ```sh + -h, --help help for switch + ``` + - id: supabase-db-branch-list + title: supabase db branch list + summary: List branches + tags: [] + links: [] + usage: |- + ```sh + supabase db branch list [flags] + ``` + subcommands: [] + options: |- + ```sh + -h, --help help for list + ``` + - id: supabase-db-branch-delete + title: supabase db branch delete + summary: Delete a branch + tags: [] + links: [] + usage: |- + ```sh + supabase db branch delete [flags] + ``` + subcommands: [] + options: |- + ```sh + -h, --help help for delete + ``` + - id: supabase-db-branch-create + title: supabase db branch create + summary: Create a branch + tags: [] + links: [] + usage: |- + ```sh + supabase db branch create [flags] + ``` + subcommands: [] + options: |- + ```sh + -h, --help help for create + ``` - id: supabase-completion title: supabase completion summary: Generate the autocompletion script for the specified shell @@ -647,7 +751,10 @@ commands: - supabase-completion-fish - supabase-completion-powershell - supabase-completion-zsh - flags: [] + options: |- + ```sh + -h, --help help for completion + ``` - id: supabase-completion-zsh title: supabase completion zsh summary: Generate the autocompletion script for zsh @@ -676,13 +783,16 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: supabase completion zsh [flags] + usage: |- + ```sh + supabase completion zsh [flags] + ``` subcommands: [] - flags: - - id: no-descriptions - name: --no-descriptions - description: disable completion descriptions - default_value: 'false' + options: |- + ```sh + -h, --help help for zsh + --no-descriptions disable completion descriptions + ``` - id: supabase-completion-powershell title: supabase completion powershell summary: Generate the autocompletion script for powershell @@ -697,13 +807,16 @@ commands: to your powershell profile. tags: [] links: [] - usage: supabase completion powershell [flags] + usage: |- + ```sh + supabase completion powershell [flags] + ``` subcommands: [] - flags: - - id: no-descriptions - name: --no-descriptions - description: disable completion descriptions - default_value: 'false' + options: |- + ```sh + -h, --help help for powershell + --no-descriptions disable completion descriptions + ``` - id: supabase-completion-fish title: supabase completion fish summary: Generate the autocompletion script for fish @@ -721,13 +834,16 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: supabase completion fish [flags] + usage: |- + ```sh + supabase completion fish [flags] + ``` subcommands: [] - flags: - - id: no-descriptions - name: --no-descriptions - description: disable completion descriptions - default_value: 'false' + options: |- + ```sh + -h, --help help for fish + --no-descriptions disable completion descriptions + ``` - id: supabase-completion-bash title: supabase completion bash summary: Generate the autocompletion script for bash @@ -754,10 +870,13 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: supabase completion bash + usage: |- + ```sh + supabase completion bash + ``` subcommands: [] - flags: - - id: no-descriptions - name: --no-descriptions - description: disable completion descriptions - default_value: 'false' + options: |- + ```sh + -h, --help help for bash + --no-descriptions disable completion descriptions + ``` diff --git a/spec/cli_v1_commands.yaml b/spec/cli_v1_commands.yaml index d7af310d127..f3eab57370e 100644 --- a/spec/cli_v1_commands.yaml +++ b/spec/cli_v1_commands.yaml @@ -1,7 +1,7 @@ clispec: '001' info: id: cli - version: 1.11.3 + version: 1.14.3 title: Supabase CLI language: sh source: https://github.com/supabase/cli @@ -9,13 +9,6 @@ info: spec: https://github.com/supabase/supabase.tools/cli_spec/lib.yaml description: | Supabase CLI provides you with tools to develop your application locally, and deploy your application to the Supabase platform. - options: |- - ```sh - --debug output debug logs to stderr - --experimental enable experimental features - -h, --help help for supabase - --workdir string path to a Supabase project directory - ``` tags: - id: local-dev title: Local Development @@ -23,6 +16,23 @@ info: title: Management APIs - id: other-commands title: Additional Commands +flags: + - id: debug + name: --debug + description: output debug logs to stderr + default_value: 'false' + - id: experimental + name: --experimental + description: enable experimental features + default_value: 'false' + - id: help + name: -h, --help + description: help for supabase + default_value: 'false' + - id: workdir + name: --workdir + description: path to a Supabase project directory + default_value: '' commands: - id: supabase-test title: supabase test @@ -32,70 +42,70 @@ commands: links: [] subcommands: - supabase-test-db - options: |- - ```sh - -h, --help help for test - ``` + flags: [] - id: supabase-test-db title: supabase test db summary: Tests local database with pgTAP tags: [] links: [] - usage: |- - ```sh - supabase test db [flags] - ``` + usage: supabase test db subcommands: [] - options: |- - ```sh - -h, --help help for db - ``` + flags: [] - id: supabase-stop title: supabase stop summary: Stop all local Supabase containers tags: - local-dev links: [] - usage: |- - ```sh - supabase stop [flags] - ``` + usage: supabase stop [flags] subcommands: [] - options: |- - ```sh - --backup Backs up the current database before stopping. - -h, --help help for stop - ``` + flags: + - id: backup + name: --backup + description: Backs up the current database before stopping. + default_value: 'false' - id: supabase-status title: supabase status summary: Show status of local Supabase containers tags: - local-dev links: [] - usage: |- - ```sh - supabase status [flags] - ``` + usage: supabase status [flags] subcommands: [] - options: |- - ```sh - -h, --help help for status - ``` + flags: + - id: output + name: -o, --output + description: Output format of status variables. + default_value: pretty + accepted_values: + - id: env + name: env + type: string + - id: json + name: json + type: string + - id: pretty + name: pretty + type: string + - id: toml + name: toml + type: string + - id: yaml + name: yaml + type: string + - id: override-name + name: --override-name + description: Override specific variable names. + default_value: '[]' - id: supabase-start title: supabase start summary: Start containers for Supabase local development tags: - local-dev links: [] - usage: |- - ```sh - supabase start [flags] - ``` + usage: supabase start subcommands: [] - options: |- - ```sh - -h, --help help for start - ``` + flags: [] - id: supabase-secrets title: supabase secrets summary: Manage Supabase secrets @@ -106,56 +116,38 @@ commands: - supabase-secrets-list - supabase-secrets-set - supabase-secrets-unset - options: |- - ```sh - -h, --help help for secrets - ``` + flags: [] - id: supabase-secrets-unset title: supabase secrets unset summary: Unset a secret(s) on Supabase description: Unset a secret(s) from the linked Supabase project. tags: [] links: [] - usage: |- - ```sh - supabase secrets unset ... [flags] - ``` + usage: supabase secrets unset ... subcommands: [] - options: |- - ```sh - -h, --help help for unset - ``` + flags: [] - id: supabase-secrets-set title: supabase secrets set summary: Set a secret(s) on Supabase description: Set a secret(s) to the linked Supabase project. tags: [] links: [] - usage: |- - ```sh - supabase secrets set [flags] ... - ``` + usage: supabase secrets set [flags] ... subcommands: [] - options: |- - ```sh - --env-file string Read secrets from a .env file. - -h, --help help for set - ``` + flags: + - id: env-file + name: --env-file + description: Read secrets from a .env file. + default_value: '' - id: supabase-secrets-list title: supabase secrets list summary: List all secrets on Supabase description: List all secrets in the linked project. tags: [] links: [] - usage: |- - ```sh - supabase secrets list [flags] - ``` + usage: supabase secrets list subcommands: [] - options: |- - ```sh - -h, --help help for list - ``` + flags: [] - id: supabase-projects title: supabase projects summary: Manage Supabase projects @@ -165,44 +157,88 @@ commands: subcommands: - supabase-projects-create - supabase-projects-list - options: |- - ```sh - -h, --help help for projects - ``` + flags: [] - id: supabase-projects-list title: supabase projects list summary: List all Supabase projects description: List all Supabase projects the logged-in user can access. tags: [] links: [] - usage: |- - ```sh - supabase projects list [flags] - ``` + usage: supabase projects list subcommands: [] - options: |- - ```sh - -h, --help help for list - ``` + flags: [] - id: supabase-projects-create title: supabase projects create summary: Create a project on Supabase tags: [] links: [] - usage: |- - ```sh - supabase projects create [flags] - ``` + usage: supabase projects create [flags] subcommands: [] - options: |- - ```sh - --db-password string Database password of the project. - -h, --help help for create - -i, --interactive Enables interactive mode. - --org-id string Organization ID to create the project in. - --plan string Select a plan that suits your needs. (default "free") - --region string Select a region close to you for the best performance. - ``` + flags: + - id: db-password + name: --db-password + description: Database password of the project. + default_value: '' + - id: interactive + name: -i, --interactive + description: Enables interactive mode. + default_value: 'false' + - id: org-id + name: --org-id + description: Organization ID to create the project in. + default_value: '' + - id: plan + name: --plan + description: Select a plan that suits your needs. + default_value: free + accepted_values: + - id: free + name: free + type: string + - id: pro + name: pro + type: string + - id: region + name: --region + description: Select a region close to you for the best performance. + default_value: '' + accepted_values: + - id: ca-central-1 + name: ca-central-1 + type: string + - id: eu-west-2 + name: eu-west-2 + type: string + - id: us-east-1 + name: us-east-1 + type: string + - id: ap-south-1 + name: ap-south-1 + type: string + - id: ap-southeast-1 + name: ap-southeast-1 + type: string + - id: ap-southeast-2 + name: ap-southeast-2 + type: string + - id: eu-west-1 + name: eu-west-1 + type: string + - id: sa-east-1 + name: sa-east-1 + type: string + - id: us-west-1 + name: us-west-1 + type: string + - id: ap-northeast-1 + name: ap-northeast-1 + type: string + - id: ap-northeast-2 + name: ap-northeast-2 + type: string + - id: eu-central-1 + name: eu-central-1 + type: string - id: supabase-orgs title: supabase orgs summary: Manage Supabase organizations @@ -211,25 +247,16 @@ commands: links: [] subcommands: - supabase-orgs-list - options: |- - ```sh - -h, --help help for orgs - ``` + flags: [] - id: supabase-orgs-list title: supabase orgs list summary: List all organizations description: List all organizations the logged-in user belongs. tags: [] links: [] - usage: |- - ```sh - supabase orgs list [flags] - ``` + usage: supabase orgs list subcommands: [] - options: |- - ```sh - -h, --help help for list - ``` + flags: [] - id: supabase-migration title: supabase migration summary: Manage database migration scripts @@ -239,86 +266,63 @@ commands: subcommands: - supabase-migration-list - supabase-migration-new - options: |- - ```sh - -h, --help help for migration - ``` + flags: [] - id: supabase-migration-new title: supabase migration new summary: Create an empty migration script tags: [] links: [] - usage: |- - ```sh - supabase migration new [flags] - ``` + usage: supabase migration new subcommands: [] - options: |- - ```sh - -h, --help help for new - ``` + flags: [] - id: supabase-migration-list title: supabase migration list summary: List local and remote migrations tags: [] links: [] - usage: |- - ```sh - supabase migration list [flags] - ``` + usage: supabase migration list [flags] subcommands: [] - options: |- - ```sh - -h, --help help for list - -p, --password string Password to your remote Postgres database. - ``` + flags: + - id: password + name: -p, --password + description: Password to your remote Postgres database. + default_value: '' - id: supabase-login title: supabase login summary: Authenticate using an access token tags: - local-dev links: [] - usage: |- - ```sh - supabase login [flags] - ``` + usage: supabase login subcommands: [] - options: |- - ```sh - -h, --help help for login - ``` + flags: [] - id: supabase-link title: supabase link summary: Link to a Supabase project tags: - local-dev links: [] - usage: |- - ```sh - supabase link [flags] - ``` + usage: supabase link [flags] subcommands: [] - options: |- - ```sh - -h, --help help for link - -p, --password string Password to your remote Postgres database. - --project-ref string Project ref of the Supabase project. - ``` + flags: + - id: password + name: -p, --password + description: Password to your remote Postgres database. + default_value: '' + - id: project-ref + name: --project-ref + description: Project ref of the Supabase project. + required: true + default_value: '' - id: supabase-init title: supabase init summary: Initialize a local project tags: - local-dev links: [] - usage: |- - ```sh - supabase init [flags] - ``` + usage: supabase init subcommands: [] - options: |- - ```sh - -h, --help help for init - ``` + flags: [] - id: supabase-gen title: supabase gen summary: Run code generation tools @@ -327,10 +331,7 @@ commands: links: [] subcommands: - supabase-gen-types - options: |- - ```sh - -h, --help help for gen - ``` + flags: [] - id: supabase-gen-types title: supabase gen types summary: Generate types from Postgres schema @@ -338,10 +339,7 @@ commands: links: [] subcommands: - supabase-gen-types-typescript - options: |- - ```sh - -h, --help help for types - ``` + flags: [] - id: supabase-gen-types-typescript title: supabase gen types typescript summary: Generate types for TypeScript @@ -349,20 +347,29 @@ commands: Generate types for TypeScript. Must specify one of --local, --linked, --project-id, or --db-url tags: [] links: [] - usage: |- - ```sh - supabase gen types typescript [flags] - ``` + usage: supabase gen types typescript [flags] subcommands: [] - options: |- - ```sh - --db-url string Generate types from a database url. - -h, --help help for typescript - --linked Generate types from the linked project. - --local Generate types from the local dev database. - --project-id string Generate types from a project ID. - --schema stringArray Schemas to generate types for. - ``` + flags: + - id: db-url + name: --db-url + description: Generate types from a database url. + default_value: '' + - id: linked + name: --linked + description: Generate types from the linked project. + default_value: 'false' + - id: local + name: --local + description: Generate types from the local dev database. + default_value: 'false' + - id: project-id + name: --project-id + description: Generate types from a project ID. + default_value: '' + - id: schema + name: --schema + description: Schemas to generate types for. + default_value: '[]' - id: supabase-functions title: supabase functions summary: Manage Supabase Edge functions @@ -374,57 +381,53 @@ commands: - supabase-functions-deploy - supabase-functions-new - supabase-functions-serve - options: |- - ```sh - -h, --help help for functions - ``` + flags: [] - id: supabase-functions-serve title: supabase functions serve summary: Serve a Function locally tags: [] links: [] - usage: |- - ```sh - supabase functions serve [flags] - ``` + usage: supabase functions serve [flags] subcommands: [] - options: |- - ```sh - --env-file string Path to an env file to be populated to the Function environment. - -h, --help help for serve - --no-verify-jwt Disable JWT verification for the Function. - ``` + flags: + - id: env-file + name: --env-file + description: | + Path to an env file to be populated to the Function environment. + default_value: '' + - id: no-verify-jwt + name: --no-verify-jwt + description: Disable JWT verification for the Function. + default_value: 'false' - id: supabase-functions-new title: supabase functions new summary: Create a new Function locally tags: [] links: [] - usage: |- - ```sh - supabase functions new [flags] - ``` + usage: supabase functions new subcommands: [] - options: |- - ```sh - -h, --help help for new - ``` + flags: [] - id: supabase-functions-deploy title: supabase functions deploy summary: Deploy a Function to Supabase description: Deploy a Function to the linked Supabase project. tags: [] links: [] - usage: |- - ```sh - supabase functions deploy [flags] - ``` + usage: supabase functions deploy [flags] subcommands: [] - options: |- - ```sh - -h, --help help for deploy - --no-verify-jwt Disable JWT verification for the Function. - --project-ref string Project ref of the Supabase project. - ``` + flags: + - id: legacy-bundle + name: --legacy-bundle + description: Use legacy bundling mechanism. + default_value: 'false' + - id: no-verify-jwt + name: --no-verify-jwt + description: Disable JWT verification for the Function. + default_value: 'false' + - id: project-ref + name: --project-ref + description: Project ref of the Supabase project. + default_value: '' - id: supabase-functions-delete title: supabase functions delete summary: Delete a Function from Supabase @@ -432,16 +435,13 @@ commands: Delete a Function from the linked Supabase project. This does NOT remove the Function locally. tags: [] links: [] - usage: |- - ```sh - supabase functions delete [flags] - ``` + usage: supabase functions delete [flags] subcommands: [] - options: |- - ```sh - -h, --help help for delete - --project-ref string Project ref of the Supabase project. - ``` + flags: + - id: project-ref + name: --project-ref + description: Project ref of the Supabase project. + default_value: '' - id: supabase-domains title: supabase domains summary: Manage custom domain names for Supabase projects @@ -454,26 +454,23 @@ commands: - supabase-domains-delete - supabase-domains-get - supabase-domains-reverify - options: |- - ```sh - -h, --help help for domains - --include-raw-output Include raw output (useful for debugging). - --project-ref string Project ref of the Supabase project. - ``` + flags: + - id: include-raw-output + name: --include-raw-output + description: Include raw output (useful for debugging). + default_value: 'false' + - id: project-ref + name: --project-ref + description: Project ref of the Supabase project. + default_value: '' - id: supabase-domains-reverify title: supabase domains reverify summary: Re-verify the custom hostname config for your project. tags: [] links: [] - usage: |- - ```sh - supabase domains reverify [flags] - ``` + usage: supabase domains reverify subcommands: [] - options: |- - ```sh - -h, --help help for reverify - ``` + flags: [] - id: supabase-domains-get title: supabase domains get summary: Get the current custom hostname config. @@ -481,29 +478,17 @@ commands: Retrieve the custom hostname config for your project, as stored in the Supabase platform. tags: [] links: [] - usage: |- - ```sh - supabase domains get [flags] - ``` + usage: supabase domains get subcommands: [] - options: |- - ```sh - -h, --help help for get - ``` + flags: [] - id: supabase-domains-delete title: supabase domains delete summary: Deletes the custom hostname config for your project. tags: [] links: [] - usage: |- - ```sh - supabase domains delete [flags] - ``` + usage: supabase domains delete subcommands: [] - options: |- - ```sh - -h, --help help for delete - ``` + flags: [] - id: supabase-domains-create title: supabase domains create summary: Create a custom hostname. @@ -513,16 +498,13 @@ commands: Expects your custom hostname to have a CNAME record to your Supabase project's subdomain. tags: [] links: [] - usage: |- - ```sh - supabase domains create [flags] - ``` + usage: supabase domains create [flags] subcommands: [] - options: |- - ```sh - --custom-hostname string The custom hostname to use for your Supabase project. - -h, --help help for create - ``` + flags: + - id: custom-hostname + name: --custom-hostname + description: The custom hostname to use for your Supabase project. + default_value: '' - id: supabase-domains-activate title: supabase domains activate summary: Activate the custom hostname for a project. @@ -533,15 +515,9 @@ commands: After the custom hostname is activated, your project's auth services will no longer function on the Supabase-provisioned subdomain. tags: [] links: [] - usage: |- - ```sh - supabase domains activate [flags] - ``` + usage: supabase domains activate subcommands: [] - options: |- - ```sh - -h, --help help for activate - ``` + flags: [] - id: supabase-db title: supabase db summary: Manage local Postgres databases @@ -549,30 +525,20 @@ commands: - local-dev links: [] subcommands: - - supabase-db-branch - supabase-db-diff - supabase-db-lint - supabase-db-push - supabase-db-remote - supabase-db-reset - options: |- - ```sh - -h, --help help for db - ``` + flags: [] - id: supabase-db-reset title: supabase db reset summary: Resets the local database to current migrations tags: [] links: [] - usage: |- - ```sh - supabase db reset [flags] - ``` + usage: supabase db reset subcommands: [] - options: |- - ```sh - -h, --help help for reset - ``` + flags: [] - id: supabase-db-remote title: supabase db remote summary: Manage remote databases @@ -581,162 +547,92 @@ commands: subcommands: - supabase-db-remote-changes - supabase-db-remote-commit - options: |- - ```sh - -h, --help help for remote - -p, --password string Password to your remote Postgres database. - ``` + flags: + - id: password + name: -p, --password + description: Password to your remote Postgres database. + default_value: '' - id: supabase-db-remote-commit title: supabase db remote commit summary: Commit remote changes as a new migration tags: [] links: [] - usage: |- - ```sh - supabase db remote commit [flags] - ``` + usage: supabase db remote commit subcommands: [] - options: |- - ```sh - -h, --help help for commit - ``` + flags: [] - id: supabase-db-remote-changes title: supabase db remote changes summary: Show changes on the remote database description: Show changes on the remote database since last migration. tags: [] links: [] - usage: |- - ```sh - supabase db remote changes [flags] - ``` + usage: supabase db remote changes subcommands: [] - options: |- - ```sh - -h, --help help for changes - ``` + flags: [] - id: supabase-db-push title: supabase db push summary: Push new migrations to the remote database tags: [] links: [] - usage: |- - ```sh - supabase db push [flags] - ``` + usage: supabase db push [flags] subcommands: [] - options: |- - ```sh - --dry-run Print the migrations that would be applied, but don't actually apply them. - -h, --help help for push - -p, --password string Password to your remote Postgres database. - ``` + flags: + - id: dry-run + name: --dry-run + description: | + Print the migrations that would be applied, but don't actually apply them. + default_value: 'false' + - id: password + name: -p, --password + description: Password to your remote Postgres database. + default_value: '' - id: supabase-db-lint title: supabase db lint summary: Checks local database for typing error tags: [] links: [] - usage: |- - ```sh - supabase db lint [flags] - ``` + usage: supabase db lint [flags] subcommands: [] - options: |- - ```sh - -h, --help help for lint - --level string Error level to emit. (default "warning") - -s, --schema strings List of schema to include. (default [public]) - ``` + flags: + - id: level + name: --level + description: Error level to emit. + default_value: warning + accepted_values: + - id: warning + name: warning + type: string + - id: error + name: error + type: string + - id: schema + name: -s, --schema + description: List of schema to include. + default_value: '[public]' - id: supabase-db-diff title: supabase db diff summary: Diffs the local database for schema changes tags: [] links: [] - usage: |- - ```sh - supabase db diff [flags] - ``` + usage: supabase db diff [flags] subcommands: [] - options: |- - ```sh - -f, --file string Saves schema diff to a file. - -h, --help help for diff - --linked Diffs local schema against linked project. - -s, --schema strings List of schema to include. (default [public]) - --use-migra Use migra to generate schema diff. - ``` - - id: supabase-db-branch - title: supabase db branch - summary: Manage local database branches - description: | - Manage local database branches. Each branch is associated with a separate local database. Forking remote databases is NOT supported. - tags: [] - links: [] - subcommands: - - supabase-db-branch-create - - supabase-db-branch-delete - - supabase-db-branch-list - - supabase-db-branch-switch - options: |- - ```sh - -h, --help help for branch - ``` - - id: supabase-db-branch-switch - title: supabase db branch switch - summary: Switch the active branch - tags: [] - links: [] - usage: |- - ```sh - supabase db branch switch [flags] - ``` - subcommands: [] - options: |- - ```sh - -h, --help help for switch - ``` - - id: supabase-db-branch-list - title: supabase db branch list - summary: List branches - tags: [] - links: [] - usage: |- - ```sh - supabase db branch list [flags] - ``` - subcommands: [] - options: |- - ```sh - -h, --help help for list - ``` - - id: supabase-db-branch-delete - title: supabase db branch delete - summary: Delete a branch - tags: [] - links: [] - usage: |- - ```sh - supabase db branch delete [flags] - ``` - subcommands: [] - options: |- - ```sh - -h, --help help for delete - ``` - - id: supabase-db-branch-create - title: supabase db branch create - summary: Create a branch - tags: [] - links: [] - usage: |- - ```sh - supabase db branch create [flags] - ``` - subcommands: [] - options: |- - ```sh - -h, --help help for create - ``` + flags: + - id: file + name: -f, --file + description: Saves schema diff to a file. + default_value: '' + - id: linked + name: --linked + description: Diffs local schema against linked project. + default_value: 'false' + - id: schema + name: -s, --schema + description: List of schema to include. + default_value: '[public]' + - id: use-migra + name: --use-migra + description: Use migra to generate schema diff. + default_value: 'false' - id: supabase-completion title: supabase completion summary: Generate the autocompletion script for the specified shell @@ -751,10 +647,7 @@ commands: - supabase-completion-fish - supabase-completion-powershell - supabase-completion-zsh - options: |- - ```sh - -h, --help help for completion - ``` + flags: [] - id: supabase-completion-zsh title: supabase completion zsh summary: Generate the autocompletion script for zsh @@ -783,16 +676,13 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: |- - ```sh - supabase completion zsh [flags] - ``` + usage: supabase completion zsh [flags] subcommands: [] - options: |- - ```sh - -h, --help help for zsh - --no-descriptions disable completion descriptions - ``` + flags: + - id: no-descriptions + name: --no-descriptions + description: disable completion descriptions + default_value: 'false' - id: supabase-completion-powershell title: supabase completion powershell summary: Generate the autocompletion script for powershell @@ -807,16 +697,13 @@ commands: to your powershell profile. tags: [] links: [] - usage: |- - ```sh - supabase completion powershell [flags] - ``` + usage: supabase completion powershell [flags] subcommands: [] - options: |- - ```sh - -h, --help help for powershell - --no-descriptions disable completion descriptions - ``` + flags: + - id: no-descriptions + name: --no-descriptions + description: disable completion descriptions + default_value: 'false' - id: supabase-completion-fish title: supabase completion fish summary: Generate the autocompletion script for fish @@ -834,16 +721,13 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: |- - ```sh - supabase completion fish [flags] - ``` + usage: supabase completion fish [flags] subcommands: [] - options: |- - ```sh - -h, --help help for fish - --no-descriptions disable completion descriptions - ``` + flags: + - id: no-descriptions + name: --no-descriptions + description: disable completion descriptions + default_value: 'false' - id: supabase-completion-bash title: supabase completion bash summary: Generate the autocompletion script for bash @@ -870,13 +754,10 @@ commands: You will need to start a new shell for this setup to take effect. tags: [] links: [] - usage: |- - ```sh - supabase completion bash - ``` + usage: supabase completion bash subcommands: [] - options: |- - ```sh - -h, --help help for bash - --no-descriptions disable completion descriptions - ``` + flags: + - id: no-descriptions + name: --no-descriptions + description: disable completion descriptions + default_value: 'false' diff --git a/spec/common-client-libs-sections-old.json b/spec/common-client-libs-sections-old.json deleted file mode 100644 index e4f7544e944..00000000000 --- a/spec/common-client-libs-sections-old.json +++ /dev/null @@ -1,793 +0,0 @@ -{ - "sections": { - "intro": { - "js": { - "title": "Getting Started", - "items": [ - { - "id": "typescript-support", - "title": "Typescript Support", - "slug": "typescript-support" - }, - { - "id": "release-notes", - "title": "Release Notes", - "slug": "release-notes" - } - ] - }, - "js_v1": { - "title": "Getting Started", - "items": [ - { - "id": "release-notes", - "title": "Release Notes", - "slug": "release-notes" - } - ] - }, - "dart": { - "title": "Getting Started", - "items": [ - { - "id": "release-notes", - "title": "Release Notes", - "slug": "release-notes" - } - ] - }, - "dart_v0": { - "title": "Getting Started", - "items": [ - { - "id": "release-notes", - "title": "Release Notes", - "slug": "release-notes" - } - ] - } - }, - "functions": [ - { - "title": "Database", - "items": [ - { - "id": "select", - "title": "Fetch data", - "slug": "select", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "insert", - "title": "Insert data", - "slug": "insert", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "update", - "title": "Update data", - "slug": "update", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "upsert", - "title": "Upsert data", - "slug": "upsert", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "delete", - "title": "Delete data", - "slug": "delete", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "rpc", - "title": "Call a Postgres function", - "slug": "rpc", - "product": "database", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "using-filters", - "title": "Using filters", - "slug": "using-filters", - "product": "database", - "libs": ["js", "js_v4", "dart", "dart_v0"], - "items": [ - { - "id": "eq", - "title": "Column is equal to a value", - "slug": "eq", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "neq", - "title": "Column is not equal to a value", - "slug": "neq", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "gt", - "title": "Column is greater than a value", - "slug": "gt", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "gte", - "title": "Column is greater than or equal to a value", - "slug": "gte", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "lt", - "title": "Column is less than a value", - "slug": "lt", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "lte", - "title": "Column is less than or equal to a value", - "slug": "lte", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "like", - "title": "Column matches a pattern", - "slug": "like", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "ilike", - "title": "Column matches a case-insensitive pattern", - "slug": "ilike", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "is", - "title": "Column is a value", - "slug": "is", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "in", - "title": "Column is in an array", - "slug": "in", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "contains", - "title": "Column contains every element in a value", - "slug": "contains", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "contained-by", - "title": "Contained by value", - "slug": "containedby", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range-gt", - "title": "Greater than a range", - "slug": "rangegt", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range-gte", - "title": "Greater than or equal to a range", - "slug": "rangegte", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range-lt", - "title": "Less than a range", - "slug": "rangelt", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range-lte", - "title": "Less than or equal to a range", - "slug": "rangelte", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range-adjacent", - "title": "Mutually exclusive to a range", - "slug": "rangeadjacent", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "overlaps", - "title": "With a common element", - "slug": "overlaps", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "text-search", - "title": "Match a string", - "slug": "textsearch", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "match", - "title": "Match an associated value", - "slug": "match", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "not", - "title": "Don't match the filter", - "slug": "not", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "or", - "title": "Match at least one filter", - "slug": "or", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "filter", - "title": "Match the filter", - "slug": "filter", - "product": "database", - "parent": "filters", - "libs": ["js", "js_v4", "dart", "dart_v0"] - } - ] - }, - { - "id": "using-modifiers", - "title": "Using Modifiers", - "slug": "using-modifiers", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4", "dart", "dart_v0"], - "items": [ - { - "id": "db-modifiers-select", - "title": "Select the query", - "slug": "db-modifiers-select", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4"] - }, - { - "id": "order", - "title": "Order the query", - "slug": "order", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "limit", - "title": "Limit the query", - "slug": "limit", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "range", - "title": "Limit the query to a range", - "slug": "range", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "abort-signal", - "title": "Set an abort signal", - "slug": "db-abortsignal", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4"] - }, - { - "id": "single", - "title": "Retrieve the query as one row", - "slug": "single", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4", "dart", "dart_v0"] - }, - { - "id": "maybe-single", - "title": "Retrieve the query as 0-1 rows", - "slug": "maybesingle", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4"] - }, - { - "id": "csv", - "title": "Retrieve the query as a CSV string", - "slug": "db-csv", - "product": "database", - "parent": "modifiers", - "libs": ["js", "js_v4"] - } - ] - } - ] - }, - { - "title": "Auth", - "items": [ - { - "id": "sign-up", - "title": "Create a new user", - "slug": "auth-signup", - "product": "auth", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "sign-in", - "title": "Sign in a user", - "slug": "auth-signin", - "product": "auth", - "libs": ["js_v1", "dart_v0"] - }, - { - "id": "sign-in-with-provider", - "title": "Sign in a user through OAuth", - "slug": "auth-signinwithprovider", - "product": "auth", - "libs": ["js_v4", "dart_v0"] - }, - { - "id": "send-mobile-otp", - "title": "Send a one-time passcode", - "slug": "auth-api-sendmobileotp", - "product": "auth", - "libs": ["js_v1"] - }, - { - "id": "sign-in-with-password", - "title": "Sign in a user", - "slug": "auth-signinwithpassword", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "sign-in-with-otp", - "title": "Sign in a user through OTP", - "slug": "auth-signinwithotp", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "sign-in-with-oauth", - "title": "Sign in a user through OAuth", - "slug": "auth-signinwithoauth", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "sign-out", - "title": "Sign out a user", - "slug": "auth-signout", - "product": "auth", - "libs": ["js", "js_v1"] - }, - { - "id": "session", - "title": "Retrieve a session", - "slug": "auth-session", - "product": "auth", - "libs": ["js_v4"] - }, - { - "id": "auth-update", - "title": "Update a user", - "slug": "auth-update", - "product": "auth", - "libs": ["js_v1"] - }, - { - "id": "set-auth", - "title": "Update the access token", - "slug": "auth-setauth", - "product": "auth", - "libs": ["js_v1"] - }, - { - "id": "user", - "title": "Retrieve a user", - "slug": "auth-user", - "product": "auth", - "libs": ["js_v1"] - }, - { - "id": "session", - "title": "Retrieve a session", - "slug": "auth-session", - "product": "auth", - "libs": ["js_v1"] - }, - { - "id": "verify-otp", - "title": "Verify and log in through OTP", - "slug": "auth-verifyotp", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "current-session", - "title": "Retrieve a session", - "slug": "auth-currentsession", - "product": "auth", - "libs": ["dart_v8"] - }, - { - "id": "current-user", - "title": "Retrieve a user", - "slug": "auth-currentuser", - "product": "auth", - "libs": ["dart_v8"] - }, - { - "id": "get-session", - "title": "Retrieve a session", - "slug": "auth-getsession", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "refresh-session", - "title": "Retrieve a new session", - "slug": "auth-refreshsession", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "get-user", - "title": "Retrieve a user", - "slug": "auth-getuser", - "product": "auth", - "libs": ["js", "js_v1"] - }, - { - "id": "update-user", - "title": "Update a user", - "slug": "auth-updateuser", - "product": "auth", - "libs": ["js", "js_v4"] - }, - { - "id": "set-session", - "title": "Set the session data", - "slug": "auth-setsession", - "product": "auth", - "libs": ["js", "js_v4"] - }, - - { - "id": "on-auth-state-change", - "title": "Listen to auth events", - "slug": "auth-onauthstatechange", - "product": "auth", - "libs": ["js", "js_v1", "dart_v0"] - }, - { - "id": "reset-password-for-email", - "title": "Send a password reset request", - "slug": "auth-resetpasswordforemail", - "product": "auth", - "libs": ["js", "js_v1", "dart_v0"] - } - ] - }, - { - "title": "Auth (server-only)", - "items": [ - { - "id": "admin-api", - "title": "Overview", - "slug": "supabase-auth-admin-api", - "product": "auth-admin", - "libs": ["js", "js_v4"] - }, - { - "id": "get-user-by-id", - "title": "Retrieve a user", - "slug": "auth-admin-getuserbyid", - "product": "auth-admin", - "libs": ["js", "js_v4"] - }, - { - "id": "list-users", - "title": "List all users", - "slug": "auth-admin-listusers", - "product": "auth-admin", - "libs": ["js", "js_v1"] - }, - { - "id": "create-user", - "title": "Create a user", - "slug": "auth-admin-createuser", - "product": "auth-admin", - "libs": ["js", "js_v1"] - }, - { - "id": "delete-user", - "title": "Delete a user", - "slug": "auth-admin-deleteuser", - "product": "auth-admin", - "libs": ["js", "js_v1"] - }, - { - "id": "invite-user-by-email", - "title": "Send an email invite link", - "slug": "auth-admin-inviteuserbyemail", - "product": "auth-admin", - "libs": ["js", "js_v1"] - }, - { - "id": "reset-password-for-email", - "title": "Send a password reset request", - "slug": "auth-admin-resetpasswordforemail", - "product": "auth-admin", - "libs": ["js", "js_v4"] - }, - { - "id": "generate-link", - "title": "Generate an email link", - "slug": "auth-admin-generatelink", - "product": "auth-admin", - "libs": ["js", "js_v4"] - }, - { - "id": "update-user-by-id", - "title": "Update a user", - "slug": "auth-admin-updateuserbyid", - "product": "auth-admin", - "libs": ["js", "js_v1"] - } - ] - }, - { - "title": "Functions", - "items": [ - { - "id": "invoke", - "title": "Invoke a function", - "slug": "auth-admin-invoke", - "product": "functions", - "libs": ["js", "js_v1", "dart", "dart_v0"] - } - ] - }, - { - "title": "Realtime", - "items": [ - { - "id": "stream", - "title": "Listen to database changes", - "slug": "stream", - "product": "realtime", - "libs": ["dart", "dart_v0"] - }, - { - "id": "subscribe", - "title": "Subscribe to database changes", - "slug": "subscribe", - "product": "realtime", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "remove-subscription", - "title": "Remove a subscription", - "slug": "removesubscription", - "product": "realtime", - "libs": ["dart_v0", "js_v1"] - }, - { - "id": "remove-all-subscriptions", - "title": "Remove all subscriptions", - "slug": "removeallsubscriptions", - "product": "realtime", - "libs": ["js_v1"] - }, - { - "id": "get-subscriptions", - "title": "Retrieve subscriptions", - "slug": "getsubscriptions", - "product": "realtime", - "libs": ["js_v1"] - }, - - { - "id": "remove-channel", - "title": "Unsubscribe from a channel", - "slug": "removechannel", - "product": "realtime", - "libs": ["js", "js_v4", "dart"] - }, - { - "id": "remove-all-channels", - "title": "Unsubscribe from all channels", - "slug": "removeallchannels", - "product": "realtime", - "libs": ["js", "js_v4", "dart"] - }, - { - "id": "get-channels", - "title": "Retrieve all channels", - "slug": "getchannels", - "product": "realtime", - "libs": ["js2", "js_v4", "dart"] - } - ] - }, - { - "title": "Storage", - "items": [ - { - "id": "create-bucket", - "title": "Create a bucket", - "slug": "storage-createbucket", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "get-bucket", - "title": "Retrieve a bucket", - "slug": "storage-getbucket", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "list-buckets", - "title": "List all buckets", - "slug": "storage-listbuckets", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "update-bucket", - "title": "Update a bucket", - "slug": "storage-updatebucket", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "delete-bucket", - "title": "Delete a bucket", - "slug": "storage-deletebucket", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "empty-bucket", - "title": "Empty a bucket", - "slug": "storage-emptybucket", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-upload", - "title": "Upload a file", - "slug": "storage-from-upload", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-download", - "title": "Download a file", - "slug": "storage-from-download", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-list", - "title": "List all files in a bucket", - "slug": "storage-from-list", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-update", - "title": "Replace an existing file", - "slug": "storage-from-update", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-move", - "title": "Move an existing file", - "slug": "storage-from-move", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-copy", - "title": "Copy an existing file", - "slug": "storage-from-copy", - "product": "storage", - "libs": ["js", "js_v1"] - }, - { - "id": "from-remove", - "title": "Delete files in a bucket", - "slug": "storage-from-remove", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-create-signed-url", - "title": "Create a signed URL", - "slug": "storage-from-createsignedurl", - "product": "storage", - "libs": ["js", "js_v1", "dart", "dart_v0"] - }, - { - "id": "from-create-signed-urls", - "title": "Create signed URLs", - "slug": "storage-from-createsignedurls", - "product": "storage", - "libs": ["js", "js_v1"] - }, - { - "id": "from-get-public-url", - "title": "Retrieve an asset's URL", - "slug": "storage-from-getpublicurl", - "product": "storage", - "libs": ["js2", "js_v1", "dart", "dart_v0"] - } - ] - } - ] - } -} diff --git a/spec/supabase_dart_v0_temp_new_shape.yml b/spec/supabase_dart_v0.yml similarity index 100% rename from spec/supabase_dart_v0_temp_new_shape.yml rename to spec/supabase_dart_v0.yml diff --git a/spec/supabase_dart_v1_temp_new_shape.yml b/spec/supabase_dart_v1.yml similarity index 100% rename from spec/supabase_dart_v1_temp_new_shape.yml rename to spec/supabase_dart_v1.yml diff --git a/spec/supabase_js_v1_temp_new_shape.yml b/spec/supabase_js_v1.yml similarity index 100% rename from spec/supabase_js_v1_temp_new_shape.yml rename to spec/supabase_js_v1.yml diff --git a/spec/supabase_js_v2_temp_new_shape.yml b/spec/supabase_js_v2.yml similarity index 100% rename from spec/supabase_js_v2_temp_new_shape.yml rename to spec/supabase_js_v2.yml