-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yml
191 lines (190 loc) · 4.94 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
openapi: 3.0.0
info:
title: Salad Simple Storage Service
version: 1.1.0
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Salad-Api-Key
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
servers:
- url: https://storage-api.salad.com
security:
- ApiKeyAuth: []
- BearerAuth: []
paths:
/organizations/{organization_name}/files/{filename+}:
put:
summary: Upload a file
security:
- ApiKeyAuth: []
- BearerAuth: []
parameters:
- name: organization_name
in: path
required: true
schema:
type: string
- name: filename+
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: The file to upload
mimeType:
type: string
description: The MIME type of the file
sign:
type: string
description: '"true" to return a signed url'
signatureExp:
type: string
description: The expiration ttl of the signature in seconds. Default is 30 days.
responses:
200:
description: File uploaded successfully
content:
application/json:
schema:
type: object
properties:
url:
type: string
format: uri
get:
summary: Download a file
security:
- ApiKeyAuth: []
- BearerAuth: []
parameters:
- name: organization_name
in: path
required: true
schema:
type: string
- name: filename+
in: path
required: true
schema:
type: string
responses:
200:
description: File retrieved successfully
content:
"*/*":
schema:
type: string
format: binary
404:
description: File not found
delete:
summary: Delete a file
security:
- ApiKeyAuth: []
- BearerAuth: []
parameters:
- name: organization_name
in: path
required: true
schema:
type: string
- name: filename+
in: path
required: true
schema:
type: string
responses:
204:
description: File deleted successfully
/organizations/{organization_name}/files:
get:
summary: List all files
security:
- ApiKeyAuth: []
- BearerAuth: []
parameters:
- name: organization_name
in: path
required: true
schema:
type: string
responses:
200:
description: List of files retrieved successfully
content:
application/json:
schema:
type: object
properties:
files:
type: array
items:
type: object
properties:
url:
type: string
format: uri
mimeType:
type: string
size:
type: integer
uploaded:
type: string
format: date-time
/organizations/{organization_name}/file_tokens/{filename+}:
post:
summary: Sign a file and return a signed URL
security:
- ApiKeyAuth: []
- BearerAuth: []
parameters:
- name: organization_name
in: path
required: true
schema:
type: string
- name: filename+
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
method:
type: string
example: "GET"
description: The HTTP method to sign the URL for. Currently only supports GET
exp:
type: string
example: "3600"
description: The expiration ttl of the signed URL in seconds
responses:
200:
description: Signed URL generated successfully
content:
application/json:
schema:
type: object
properties:
url:
type: string