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

Merge pull request #8523 from supabase/update-storage-docs-2

Browse Source 
update doc specs
This commit is contained in:
Copple authored and GitHub committed 2022-08-19 10:55:35 +02:00
2 parents c45b6c0631 97a056fe9e
commit ebcecf4ef8
5 files changed
+375 -157
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/reference/_storage/generated/usage.mdx
+67 -34
View File
@@ -113,7 +113,7 @@ DELETE /object/{bucketName}/{wildcard}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -121,6 +121,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -139,7 +140,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -147,6 +148,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -268,7 +270,7 @@ PUT /object/{bucketName}/{wildcard}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -276,6 +278,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -297,7 +300,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -305,6 +308,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -426,7 +430,7 @@ POST /object/{bucketName}/{wildcard}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -434,6 +438,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -455,7 +460,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -463,6 +468,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -593,7 +599,7 @@ DELETE /object/{bucketName}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -601,6 +607,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -730,7 +737,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -738,6 +745,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -859,7 +867,7 @@ GET /object/authenticated/{bucketName}/{wildcard}
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -867,6 +875,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1008,7 +1017,7 @@ POST /object/sign/{bucketName}/{wildcard}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1016,6 +1025,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"signedURL": {
@@ -1037,7 +1047,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1045,6 +1055,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1144,7 +1155,7 @@ GET /object/sign/{bucketName}/{wildcard}
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1152,6 +1163,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1288,7 +1300,7 @@ POST /object/sign/{bucketName}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1296,6 +1308,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -1336,7 +1349,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1344,6 +1357,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1454,7 +1468,7 @@ POST /object/move
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1462,6 +1476,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -1483,7 +1498,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1491,6 +1506,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1651,7 +1667,7 @@ POST /object/list/{bucketName}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1659,6 +1675,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -1787,7 +1804,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1795,6 +1812,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1905,7 +1923,7 @@ POST /object/copy
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1913,6 +1931,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -1934,7 +1953,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -1942,6 +1961,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2041,7 +2061,7 @@ GET /object/public/{bucketName}/{wildcard}
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2049,6 +2069,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2164,7 +2185,7 @@ POST /bucket/
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2172,6 +2193,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"name": {
@@ -2193,7 +2215,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2201,6 +2223,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2282,7 +2305,7 @@ GET /bucket/
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2290,6 +2313,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -2356,7 +2380,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2364,6 +2388,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2468,7 +2493,7 @@ POST /bucket/{bucketId}/empty
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2476,6 +2501,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -2494,7 +2520,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2502,6 +2528,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2606,7 +2633,7 @@ GET /bucket/{bucketId}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2614,6 +2641,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"id": {
@@ -2665,7 +2693,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2673,6 +2701,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2770,7 +2799,7 @@ PUT /bucket/{bucketId}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2778,6 +2807,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -2799,7 +2829,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2807,6 +2837,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2911,7 +2942,7 @@ DELETE /bucket/{bucketId}
<TabItem value="200">
Default Response
Successful response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2919,6 +2950,7 @@ Default Response
```json
{
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -2937,7 +2969,7 @@ Default Response
<TabItem value="4XX">
Default Response
Error response
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
@@ -2945,6 +2977,7 @@ Default Response
```json
{
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -2986,7 +3019,7 @@ Deprecated end-points
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Get object (deprecated) {#get-object-deprecated}
### Get object {#get-object}
```
GET /object/{bucketName}/{wildcard}
spec/api_v0_openapi.json
+61
View File
@@ -356,6 +356,62 @@
"tags": ["projects"],
"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": { "type": "object" } } }
},
"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": { "type": "object" } } }
},
"403": { "description": "" },
"500": { "description": "Failed to update project's pgsodium config" }
},
"tags": ["pgsodium (beta)"],
"security": [{ "bearer": [] }]
}
}
},
"info": { "title": "Supabase API (v1)", "description": "", "version": "1.0.0", "contact": {} },
@@ -474,6 +530,11 @@
"value": { "type": "string", "pattern": {} }
},
"required": ["name", "value"]
},
"UpdatePgsodiumConfigBody": {
"type": "object",
"properties": { "root_key": { "type": "string" } },
"required": ["root_key"]
}
}
}
spec/cli_v1_commands.yaml
+1 -1
View File
@@ -1,4 +1,4 @@
clispec: "001"
clispec: '001'
info:
id: cli
version: 1.0.0
spec/storage_v0_openapi.json
+143 -70
View File
@@ -9,7 +9,12 @@
"schemas": {
"def-0": {
"type": "object",
"properties": { "authorization": { "type": "string" } },
"properties": {
"authorization": {
"type": "string",
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
},
"required": ["authorization"],
"title": "authSchema"
},
@@ -51,15 +56,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": { "name": { "type": "string", "example": "avatars" } },
"required": ["name"]
@@ -68,9 +75,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -83,15 +92,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -137,9 +148,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -161,15 +174,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": { "type": "string", "example": "Successfully emptied" }
@@ -179,9 +194,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -203,15 +220,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"id": { "type": "string" },
@@ -242,9 +261,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -267,15 +288,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": { "type": "string", "example": "Successfully updated" }
@@ -286,9 +309,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -308,15 +333,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": { "type": "string", "example": "Successfully deleted" }
@@ -326,9 +353,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -357,15 +386,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": { "type": "string", "example": "Successfully deleted" }
@@ -375,15 +406,17 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
},
"get": {
"summary": "Get object (deprecated)",
"summary": "Get object",
"tags": ["deprecated"],
"description": "use GET /object/authenticated/{bucketName} instead",
"parameters": [
@@ -405,7 +438,8 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
@@ -439,15 +473,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": { "type": "string", "example": "projectref/avatars/folder/cat.png" }
@@ -458,9 +494,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -487,15 +525,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": { "type": "string", "example": "avatars/folder/cat.png" }
@@ -506,9 +546,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -549,15 +591,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -615,9 +659,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -646,14 +692,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "$ref": "#/components/schemas/def-1", "description": "Error response" }
}
}
}
}
@@ -696,15 +745,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"signedURL": {
@@ -718,9 +769,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -756,9 +809,11 @@
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "$ref": "#/components/schemas/def-1", "description": "Error response" }
}
}
}
}
@@ -800,15 +855,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -830,9 +887,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -863,15 +922,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": { "type": "string", "example": "Successfully moved" }
@@ -882,9 +943,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -928,15 +991,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -993,9 +1058,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -1026,15 +1093,17 @@
"in": "header",
"name": "authorization",
"required": true,
"schema": { "type": "string" }
"schema": { "type": "string" },
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": { "type": "string", "example": "folder/destination.png" }
@@ -1045,9 +1114,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "description": "Error response", "$ref": "#/components/schemas/def-1" }
}
}
}
}
@@ -1075,9 +1146,11 @@
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/def-1" } }
"application/json": {
"schema": { "$ref": "#/components/schemas/def-1", "description": "Error response" }
}
}
}
}
spec/transforms/storage_v0_openapi_deparsed.json
+103 -52
View File
@@ -11,7 +11,8 @@
"type": "object",
"properties": {
"authorization": {
"type": "string"
"type": "string",
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
},
"required": [
@@ -82,15 +83,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"name": {
@@ -106,10 +109,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -146,15 +150,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -215,10 +221,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -267,15 +274,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -288,10 +297,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -340,15 +350,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"id": {
@@ -394,10 +406,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -449,15 +462,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -473,10 +488,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -523,15 +539,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -544,10 +562,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -606,15 +625,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -627,10 +648,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -656,7 +678,7 @@
}
},
"get": {
"summary": "Get object (deprecated)",
"summary": "Get object",
"tags": [
"deprecated"
],
@@ -688,7 +710,8 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
@@ -753,15 +776,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -777,10 +802,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -837,15 +863,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -861,10 +889,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -939,15 +968,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -1071,10 +1102,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1133,15 +1165,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1220,15 +1254,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"signedURL": {
@@ -1244,10 +1280,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1311,10 +1348,11 @@
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1395,15 +1433,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -1438,10 +1478,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1509,15 +1550,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"message": {
@@ -1533,10 +1576,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1639,15 +1683,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "array",
"items": {
"type": "object",
@@ -1770,10 +1816,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1841,15 +1888,17 @@
"required": true,
"schema": {
"type": "string"
}
},
"example": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24ifQ.625_WdcF3KHqz5amU0x2X5WWHP-OEs_4qj0ssLNHzTs"
}
],
"responses": {
"200": {
"description": "Default Response",
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"description": "Successful response",
"type": "object",
"properties": {
"Key": {
@@ -1865,10 +1914,11 @@
}
},
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {
@@ -1924,10 +1974,11 @@
],
"responses": {
"4XX": {
"description": "Default Response",
"description": "Error response",
"content": {
"application/json": {
"schema": {
"description": "Error response",
"type": "object",
"properties": {
"statusCode": {