dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-06 01:45:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11454 from supabase/docs/init-default-values

Browse Source 
Update initializing supabase-js ref docs
This commit is contained in:
dng authored and GitHub committed 2023-01-04 17:14:49 -08:00
2 parents 3c31aa39f2 7389cd32e7
commit d0794528f4
10 files changed
+8826 -7751
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

spec/api_v0_openapi.json
+386 -304
View File
@@ -338,165 +338,6 @@
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/secrets": {
"get": {
"operationId": "getSecrets",
"summary": "List all secrets",
"description": "Returns all secrets you've previously added to the specified project.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SecretResponse" }
}
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's secrets" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
},
"post": {
"operationId": "createSecrets",
"summary": "Bulk create secrets",
"description": "Creates multiple secrets and adds them to the specified project.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/CreateSecretBody" }
}
}
}
},
"responses": {
"201": { "description": "" },
"403": { "description": "" },
"500": { "description": "Failed to create project's secrets" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
},
"delete": {
"operationId": "deleteSecrets",
"summary": "Bulk delete secrets",
"description": "Deletes all secrets with the given names from the specified project",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
}
},
"responses": {
"200": {
"description": "",
"content": { "application/json": { "schema": { "type": "object" } } }
},
"403": { "description": "" },
"500": { "description": "Failed to delete secrets with given names" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/postgrest": {
"get": {
"operationId": "getPostgRESTConfig",
"summary": "Gets project's postgrest config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgrestConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's postgrest config" }
},
"tags": ["services"],
"security": [{ "bearer": [] }]
},
"patch": {
"operationId": "updatePostgRESTConfig",
"summary": "Updates project's postgrest config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdatePostgrestConfigBody" }
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgrestConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project's postgrest config" }
},
"tags": ["services"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/custom-hostname": {
"get": {
"operationId": "getCustomHostnameConfig",
@@ -641,106 +482,6 @@
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/pgsodium": {
"get": {
"operationId": "getConfig",
"summary": "Gets project's pgsodium config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PgsodiumConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's pgsodium config" }
},
"tags": ["pgsodium (beta)"],
"security": [{ "bearer": [] }]
},
"put": {
"operationId": "updateConfig",
"summary": "Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdatePgsodiumConfigBody" }
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PgsodiumConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project's pgsodium config" }
},
"tags": ["pgsodium (beta)"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/types/typescript": {
"get": {
"operationId": "getTypescriptTypes",
"summary": "Generate TypeScript types",
"description": "Returns the TypeScript types of your schema for use with supabase-js.",
"parameters": [
{
"name": "included_schemas",
"required": false,
"in": "query",
"schema": { "default": "public", "type": "string" }
},
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TypescriptResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to generate TypeScript types" }
},
"tags": ["projects"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/network-bans/retrieve": {
"post": {
"operationId": "getNetworkBans",
@@ -866,6 +607,329 @@
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/pgsodium": {
"get": {
"operationId": "getConfig",
"summary": "Gets project's pgsodium config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PgsodiumConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's pgsodium config" }
},
"tags": ["pgsodium (beta)"],
"security": [{ "bearer": [] }]
},
"put": {
"operationId": "updateConfig",
"summary": "Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdatePgsodiumConfigBody" }
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PgsodiumConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project's pgsodium config" }
},
"tags": ["pgsodium (beta)"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/postgrest": {
"get": {
"operationId": "getPostgRESTConfig",
"summary": "Gets project's postgrest config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgrestConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's postgrest config" }
},
"tags": ["services"],
"security": [{ "bearer": [] }]
},
"patch": {
"operationId": "updatePostgRESTConfig",
"summary": "Updates project's postgrest config",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdatePostgrestConfigBody" }
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/PostgrestConfigResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project's postgrest config" }
},
"tags": ["services"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/secrets": {
"get": {
"operationId": "getSecrets",
"summary": "List all secrets",
"description": "Returns all secrets you've previously added to the specified project.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/SecretResponse" }
}
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's secrets" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
},
"post": {
"operationId": "createSecrets",
"summary": "Bulk create secrets",
"description": "Creates multiple secrets and adds them to the specified project.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/CreateSecretBody" }
}
}
}
},
"responses": {
"201": { "description": "" },
"403": { "description": "" },
"500": { "description": "Failed to create project's secrets" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
},
"delete": {
"operationId": "deleteSecrets",
"summary": "Bulk delete secrets",
"description": "Deletes all secrets with the given names from the specified project",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
}
},
"responses": {
"200": {
"description": "",
"content": { "application/json": { "schema": { "type": "object" } } }
},
"403": { "description": "" },
"500": { "description": "Failed to delete secrets with given names" }
},
"tags": ["secrets"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/ssl-enforcement": {
"get": {
"operationId": "getSslEnforcementConfig",
"summary": "Get project's SSL enforcement configuration.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SslEnforcementResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's SSL enforcement config" }
},
"tags": ["ssl enforcement (beta)"],
"security": [{ "bearer": [] }]
},
"put": {
"operationId": "updateSslEnforcementConfig",
"summary": "Update project's SSL enforcement configuration.",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SslEnforcementRequest" }
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/SslEnforcementResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project's SSL enforcement configuration." }
},
"tags": ["ssl enforcement (beta)"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/types/typescript": {
"get": {
"operationId": "getTypescriptTypes",
"summary": "Generate TypeScript types",
"description": "Returns the TypeScript types of your schema for use with supabase-js.",
"parameters": [
{
"name": "included_schemas",
"required": false,
"in": "query",
"schema": { "default": "public", "type": "string" }
},
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/TypescriptResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to generate TypeScript types" }
},
"tags": ["projects"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/vanity-subdomain": {
"get": {
"operationId": "getVanitySubdomainConfig",
@@ -1100,36 +1164,6 @@
"verify_jwt": { "type": "boolean" }
}
},
"SecretResponse": {
"type": "object",
"properties": { "name": { "type": "string" }, "value": { "type": "string" } },
"required": ["name", "value"]
},
"CreateSecretBody": {
"type": "object",
"properties": {
"name": { "type": "string" },
"value": { "type": "string", "pattern": "/^(?!SUPABASE_).*/" }
},
"required": ["name", "value"]
},
"PostgrestConfigResponse": {
"type": "object",
"properties": {
"max_rows": { "type": "integer" },
"db_schema": { "type": "string" },
"db_extra_search_path": { "type": "string" }
},
"required": ["max_rows", "db_schema", "db_extra_search_path"]
},
"UpdatePostgrestConfigBody": {
"type": "object",
"properties": {
"max_rows": { "type": "integer", "minimum": 0, "maximum": 1000000 },
"db_extra_search_path": { "type": "string" },
"db_schema": { "type": "string" }
}
},
"UpdateCustomHostnameResponse": {
"type": "object",
"properties": {
@@ -1153,21 +1187,6 @@
"properties": { "custom_hostname": { "type": "string" } },
"required": ["custom_hostname"]
},
"PgsodiumConfigResponse": {
"type": "object",
"properties": { "root_key": { "type": "string" } },
"required": ["root_key"]
},
"UpdatePgsodiumConfigBody": {
"type": "object",
"properties": { "root_key": { "type": "string" } },
"required": ["root_key"]
},
"TypescriptResponse": {
"type": "object",
"properties": { "types": { "type": "string" } },
"required": ["types"]
},
"NetworkBanResponse": {
"type": "object",
"properties": {
@@ -1194,6 +1213,69 @@
},
"required": ["entitlement", "config", "status"]
},
"PgsodiumConfigResponse": {
"type": "object",
"properties": { "root_key": { "type": "string" } },
"required": ["root_key"]
},
"UpdatePgsodiumConfigBody": {
"type": "object",
"properties": { "root_key": { "type": "string" } },
"required": ["root_key"]
},
"PostgrestConfigResponse": {
"type": "object",
"properties": {
"max_rows": { "type": "integer" },
"db_schema": { "type": "string" },
"db_extra_search_path": { "type": "string" }
},
"required": ["max_rows", "db_schema", "db_extra_search_path"]
},
"UpdatePostgrestConfigBody": {
"type": "object",
"properties": {
"max_rows": { "type": "integer", "minimum": 0, "maximum": 1000000 },
"db_extra_search_path": { "type": "string" },
"db_schema": { "type": "string" }
}
},
"SecretResponse": {
"type": "object",
"properties": { "name": { "type": "string" }, "value": { "type": "string" } },
"required": ["name", "value"]
},
"CreateSecretBody": {
"type": "object",
"properties": {
"name": { "type": "string" },
"value": { "type": "string", "pattern": "/^(?!SUPABASE_).*/" }
},
"required": ["name", "value"]
},
"SslEnforcements": {
"type": "object",
"properties": { "database": { "type": "boolean" } },
"required": ["database"]
},
"SslEnforcementResponse": {
"type": "object",
"properties": {
"currentConfig": { "$ref": "#/components/schemas/SslEnforcements" },
"appliedSuccessfully": { "type": "boolean" }
},
"required": ["currentConfig", "appliedSuccessfully"]
},
"SslEnforcementRequest": {
"type": "object",
"properties": { "requestedConfig": { "$ref": "#/components/schemas/SslEnforcements" } },
"required": ["requestedConfig"]
},
"TypescriptResponse": {
"type": "object",
"properties": { "types": { "type": "string" } },
"required": ["types"]
},
"VanitySubdomainConfigResponse": {
"type": "object",
"properties": {
spec/enrichments/tsdoc_v2/combined.json
+2863 -2546
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/gotrue.json
+1914 -1757
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/gotrue_dereferenced.json
+2590 -2405
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/realtime.json
+45 -21
View File
@@ -809,7 +809,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 315,
"line": 327,
"character": 2
}
],
@@ -821,7 +821,7 @@
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Listen to messages."
"shortText": "Creates an event handler that listens to changes"
},
"parameters": [
{
@@ -830,6 +830,9 @@
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Realtime feature (broadcast, presence, or postgres_changes)"
},
"type": {
"type": "literal",
"value": "broadcast"
@@ -841,6 +844,9 @@
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Pre-defined and custom values specific to the Realtime feature"
},
"type": {
"type": "reflection",
"declaration": {
@@ -856,10 +862,13 @@
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "Event to listen to. If listening to postgres_changes type\nthen this value is one of INSERT, UPDATE, DELETE, *"
},
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 317,
"line": 329,
"character": 14
}
],
@@ -885,6 +894,9 @@
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Function to be invoked when event handler is triggered\n"
},
"type": {
"type": "reflection",
"declaration": {
@@ -925,7 +937,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 320,
"line": 332,
"character": 6
}
],
@@ -943,7 +955,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 319,
"line": 331,
"character": 6
}
],
@@ -1045,7 +1057,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 326,
"line": 338,
"character": 14
}
],
@@ -1144,7 +1156,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 331,
"line": 343,
"character": 14
}
],
@@ -1257,7 +1269,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 336,
"line": 348,
"character": 14
}
],
@@ -1911,7 +1923,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 367,
"line": 379,
"character": 2
}
],
@@ -1947,7 +1959,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 368,
"line": 380,
"character": 15
}
],
@@ -2298,7 +2310,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 407,
"line": 419,
"character": 2
}
],
@@ -2443,7 +2455,7 @@
"sources": [
{
"fileName": "RealtimeChannel.ts",
"line": 394,
"line": 406,
"character": 2
}
],
@@ -3246,7 +3258,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 218,
"line": 228,
"character": 2
}
],
@@ -3330,7 +3342,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 198,
"line": 208,
"character": 2
}
],
@@ -3424,7 +3436,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 162,
"line": 165,
"character": 2
}
],
@@ -3435,6 +3447,9 @@
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns all created channels"
},
"type": {
"type": "array",
"elementType": {
@@ -3455,7 +3470,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 214,
"line": 224,
"character": 2
}
],
@@ -3485,7 +3500,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 191,
"line": 201,
"character": 2
}
],
@@ -3553,7 +3568,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 236,
"line": 246,
"character": 2
}
],
@@ -3607,7 +3622,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 177,
"line": 187,
"character": 2
}
],
@@ -3618,6 +3633,9 @@
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Unsubscribes and removes all channels"
},
"type": {
"type": "reference",
"typeArguments": [
@@ -3646,7 +3664,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 166,
"line": 173,
"character": 2
}
],
@@ -3657,6 +3675,9 @@
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Unsubscribes and removes a single channel"
},
"parameters": [
{
"id": 354,
@@ -3664,6 +3685,9 @@
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A RealtimeChannel instance\n"
},
"type": {
"type": "reference",
"id": 55,
@@ -3696,7 +3720,7 @@
"sources": [
{
"fileName": "RealtimeClient.ts",
"line": 263,
"line": 273,
"character": 2
}
],
spec/enrichments/tsdoc_v2/realtime_dereferenced.json
+243 -111
View File
File diff suppressed because it is too large. Load diff
spec/enrichments/tsdoc_v2/supabase.json
+6 -6
View File
@@ -3594,7 +3594,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -3617,7 +3617,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -3640,7 +3640,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -3663,7 +3663,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -3694,7 +3694,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -3735,7 +3735,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
spec/enrichments/tsdoc_v2/supabase_dereferenced.json
+30 -30
View File
@@ -283,7 +283,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -306,7 +306,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -329,7 +329,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -352,7 +352,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -383,7 +383,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -424,7 +424,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
@@ -2598,7 +2598,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -2621,7 +2621,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -2644,7 +2644,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -2667,7 +2667,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -2698,7 +2698,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -2739,7 +2739,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
@@ -3702,7 +3702,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -3725,7 +3725,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -3748,7 +3748,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -3771,7 +3771,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -3802,7 +3802,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -3843,7 +3843,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
@@ -4151,7 +4151,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -4174,7 +4174,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -4197,7 +4197,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -4220,7 +4220,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -4251,7 +4251,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -4292,7 +4292,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
@@ -5531,7 +5531,7 @@
"isOptional": true
},
"comment": {
"shortText": "Automatically refreshes the token for logged in users."
"shortText": "Automatically refreshes the token for logged-in users. Defaults to true."
},
"sources": [
{
@@ -5554,7 +5554,7 @@
"isOptional": true
},
"comment": {
"shortText": "Detect a session from the URL. Used for OAuth login callbacks."
"shortText": "Detect a session from the URL. Used for OAuth login callbacks. Defaults to true."
},
"sources": [
{
@@ -5577,7 +5577,7 @@
"isOptional": true
},
"comment": {
"shortText": "Whether to persist a logged in session to storage."
"shortText": "Whether to persist a logged-in session to storage. Defaults to true."
},
"sources": [
{
@@ -5600,7 +5600,7 @@
"isOptional": true
},
"comment": {
"shortText": "A storage provider. Used to store the logged in session."
"shortText": "A storage provider. Used to store the logged-in session."
},
"sources": [
{
@@ -5631,7 +5631,7 @@
"isOptional": true
},
"comment": {
"shortText": "Optional key name used for storing tokens in local storage"
"shortText": "Optional key name used for storing tokens in local storage."
},
"sources": [
{
@@ -5672,7 +5672,7 @@
"isOptional": true
},
"comment": {
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to 'public'."
"shortText": "The Postgres schema which your tables belong to. Must be on the list of exposed schemas in Supabase. Defaults to `public`."
},
"sources": [
{
spec/supabase_js_v2.yml
+1 -1
View File
@@ -1062,7 +1062,7 @@ functions:
If you're in a situation where your tables are **NOT** directly
related, but instead are joined by a _join table_, you can still use
the `select()` method to query the related data. The join table needs
to have the foreign keys as part of its composite primary key.
to have the foreign keys as part of its composite primary key.
hideCodeBlock: true
- id: query-the-same-foreign-table-multiple-times
name: Query the same foreign table multiple times
spec/transforms/api_v0_openapi_deparsed.json
+748 -570
View File
File diff suppressed because it is too large. Load diff