Skip to content

Commit

Permalink
Restore modifier helper text
Browse files Browse the repository at this point in the history
  • Loading branch information
saltcod committed Nov 9, 2022
1 parent bb88b4c commit f4731b3
Show file tree
Hide file tree
Showing 8 changed files with 5,796 additions and 14,224 deletions.
134 changes: 103 additions & 31 deletions spec/api_v0_openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,21 @@
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
},
{
"name": "slug",
"required": false,
"in": "query",
"schema": { "pattern": "/^[A-Za-z0-9_-]+$/", "type": "string" }
},
{ "name": "name", "required": false, "in": "query", "schema": { "type": "string" } },
{
"name": "verify_jwt",
"required": false,
"in": "query",
"schema": { "type": "boolean" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/CreateFunctionBody" } }
}
},
"responses": {
"201": {
"description": "",
Expand Down Expand Up @@ -230,14 +237,21 @@
"in": "path",
"description": "Function slug",
"schema": { "pattern": "/^[A-Za-z0-9_-]+$/", "type": "string" }
},
{
"name": "slug",
"required": false,
"in": "query",
"schema": { "pattern": "/^[A-Za-z0-9_-]+$/", "type": "string" }
},
{ "name": "name", "required": false, "in": "query", "schema": { "type": "string" } },
{
"name": "verify_jwt",
"required": false,
"in": "query",
"schema": { "type": "boolean" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/UpdateFunctionBody" } }
}
},
"responses": {
"200": {
"description": "",
Expand Down Expand Up @@ -302,13 +316,14 @@
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's custom hostname config" }
},
"tags": ["custom hostname (beta)"],
"security": [{ "bearer": [] }]
},
"delete": {
"operationId": "remove",
"operationId": "removeCustomHostnameConfig",
"summary": "Deletes a project's custom hostname configuration",
"parameters": [
{
Expand All @@ -321,6 +336,7 @@
],
"responses": {
"200": { "description": "" },
"403": { "description": "" },
"500": { "description": "Failed to delete project custom hostname configuration" }
},
"tags": ["custom hostname (beta)"],
Expand Down Expand Up @@ -357,6 +373,7 @@
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to update project custom hostname configuration" }
},
"tags": ["custom hostname (beta)"],
Expand Down Expand Up @@ -385,6 +402,7 @@
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to verify project custom hostname configuration" }
},
"tags": ["custom hostname (beta)"],
Expand Down Expand Up @@ -413,6 +431,7 @@
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to activate project custom hostname configuration" }
},
"tags": ["custom hostname (beta)"],
Expand Down Expand Up @@ -605,6 +624,65 @@
"tags": ["projects"],
"security": [{ "apiKeyHeader": [], "apiKeyParam": [] }, { "bearer": [] }]
}
},
"/v1/projects/{ref}/network-bans/retrieve": {
"post": {
"operationId": "getNetworkBans",
"summary": "Gets project's network bans",
"parameters": [
{
"name": "ref",
"required": true,
"in": "path",
"description": "Project ref",
"schema": { "minLength": 20, "maxLength": 20, "type": "string" }
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/NetworkBanResponse" }
}
}
},
"403": { "description": "" },
"500": { "description": "Failed to retrieve project's network bans" }
},
"tags": ["network bans (beta)"],
"security": [{ "bearer": [] }]
}
},
"/v1/projects/{ref}/network-bans": {
"delete": {
"operationId": "removeNetworkBan",
"summary": "Remove network bans.",
"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/RemoveNetworkBanRequest" }
}
}
},
"responses": {
"200": { "description": "" },
"403": { "description": "" },
"500": { "description": "Failed to remove network bans." }
},
"tags": ["network bans (beta)"],
"security": [{ "bearer": [] }]
}
}
},
"info": { "title": "Supabase API (v1)", "description": "", "version": "1.0.0", "contact": {} },
Expand Down Expand Up @@ -665,16 +743,6 @@
"properties": { "name": { "type": "string" } },
"required": ["name"]
},
"CreateFunctionBody": {
"type": "object",
"properties": {
"slug": { "type": "string", "pattern": "/^[A-Za-z0-9_-]+$/" },
"name": { "type": "string" },
"body": { "type": "string" },
"verify_jwt": { "type": "boolean" }
},
"required": ["slug", "name", "body"]
},
"FunctionResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -704,14 +772,6 @@
},
"required": ["id", "slug", "name", "status", "version", "created_at", "updated_at"]
},
"UpdateFunctionBody": {
"type": "object",
"properties": {
"name": { "type": "string" },
"body": { "type": "string" },
"verify_jwt": { "type": "boolean" }
}
},
"UpdateCustomHostnameResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -757,6 +817,18 @@
"type": "object",
"properties": { "types": { "type": "string" } },
"required": ["types"]
},
"NetworkBanResponse": {
"type": "object",
"properties": {
"banned_ipv4_addresses": { "type": "array", "items": { "type": "string" } }
},
"required": ["banned_ipv4_addresses"]
},
"RemoveNetworkBanRequest": {
"type": "object",
"properties": { "ipv4_addresses": { "type": "array", "items": { "type": "string" } } },
"required": ["ipv4_addresses"]
}
}
}
Expand Down
Loading

0 comments on commit f4731b3

Please sign in to comment.