Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
399 lines (399 loc) · 10.7 KB
/
Copy pathopenapi.yaml
File metadata and controls
399 lines (399 loc) · 10.7 KB
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
openapi: 3.1.0
info:
title: ImageFlow API
version: 0.1.0
summary: Asynchronous image-processing jobs
description: |
ImageFlow accepts an image URL and a sequence of transformations, persists
the request, downloads public JPEG/PNG sources, processes them asynchronously,
and exposes the generated artifact when the job completes.
license:
name: All rights reserved
servers:
- url: http://localhost:8080
description: Local development
security:
- bearerAuth: []
tags:
- name: Health
description: Process liveness and dependency readiness.
- name: Jobs
description: Asynchronous image-processing jobs.
paths:
/health/live:
get:
security: []
operationId: getLiveness
summary: Check API liveness
tags: [Health]
responses:
"200":
description: The API process is running.
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
example:
status: ok
/health/ready:
get:
security: []
operationId: getReadiness
summary: Check API readiness
description: Verifies that PostgreSQL is reachable.
tags: [Health]
responses:
"200":
description: The API is ready to receive traffic.
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
example:
status: ready
"503":
description: PostgreSQL is unavailable.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
error:
code: not_ready
message: database is unavailable
/v1/jobs:
post:
operationId: createJob
summary: Create an image-processing job
description: |
Persists the job and its outbox event atomically. Processing continues
asynchronously after the response.
tags: [Jobs]
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateJobRequest"
examples:
resizeAndConvert:
summary: Resize and convert to JPEG
value:
source_url: https://example.com/product.jpg
operations:
- type: resize
width: 1200
fit: contain
- type: convert
format: jpeg
quality: 82
responses:
"202":
description: Job accepted for asynchronous processing.
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"401":
$ref: "#/components/responses/Unauthorized"
"400":
description: Malformed JSON or unknown request fields.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"413":
description: Request body exceeds one MiB.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"422":
description: The URL or operation pipeline is invalid.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: The job could not be persisted.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v1/jobs/{id}:
get:
operationId: getJob
summary: Get a job
tags: [Jobs]
parameters:
- $ref: "#/components/parameters/JobID"
responses:
"200":
description: Current job representation.
content:
application/json:
schema:
$ref: "#/components/schemas/Job"
"401":
$ref: "#/components/responses/Unauthorized"
"404":
description: No job exists with this identifier.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: The job could not be retrieved.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v1/jobs/{id}/result:
get:
operationId: getJobResult
summary: Get the generated image
tags: [Jobs]
parameters:
- $ref: "#/components/parameters/JobID"
responses:
"200":
description: Generated JPEG or PNG artifact.
content:
image/jpeg: {}
image/png: {}
"401":
$ref: "#/components/responses/Unauthorized"
"404":
description: No job exists with this identifier.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"409":
description: The job has not completed successfully.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
components:
responses:
Unauthorized:
description: The Bearer API key is missing, invalid, or revoked.
headers:
WWW-Authenticate:
schema:
type: string
example: Bearer realm="imageflow"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
example:
error:
code: unauthorized
message: a valid API key is required
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: ImageFlow API key
description: Use an `if_test_...` or `if_live_...` project API key.
parameters:
JobID:
name: id
in: path
required: true
description: Server-generated job identifier.
schema:
type: string
pattern: "^job_[a-f0-9]{24}$"
example: job_5aa58501c5ac48355fba70e4
schemas:
HealthResponse:
type: object
additionalProperties: false
required: [status]
properties:
status:
type: string
CreateJobRequest:
type: object
additionalProperties: false
required: [source_url, operations]
properties:
source_url:
type: string
format: uri
pattern: "^https?://"
description: Absolute HTTP or HTTPS URL of the source image.
operations:
type: array
minItems: 1
items:
$ref: "#/components/schemas/Operation"
Operation:
oneOf:
- $ref: "#/components/schemas/ResizeOperation"
- $ref: "#/components/schemas/CropOperation"
- $ref: "#/components/schemas/ConvertOperation"
discriminator:
propertyName: type
mapping:
resize: "#/components/schemas/ResizeOperation"
crop: "#/components/schemas/CropOperation"
convert: "#/components/schemas/ConvertOperation"
ResizeOperation:
type: object
additionalProperties: false
required: [type]
properties:
type:
type: string
const: resize
width:
type: integer
minimum: 1
maximum: 12000
height:
type: integer
minimum: 1
maximum: 12000
fit:
type: string
enum: [contain, cover, fill]
default: contain
anyOf:
- required: [width]
- required: [height]
CropOperation:
type: object
additionalProperties: false
required: [type, x, y, width, height]
properties:
type:
type: string
const: crop
x:
type: integer
minimum: 0
y:
type: integer
minimum: 0
width:
type: integer
minimum: 1
maximum: 12000
height:
type: integer
minimum: 1
maximum: 12000
ConvertOperation:
type: object
additionalProperties: false
required: [type, format]
properties:
type:
type: string
const: convert
format:
type: string
enum: [jpeg, png]
quality:
type: integer
minimum: 0
maximum: 100
JobStatus:
type: string
enum: [queued, processing, completed, failed, cancelled]
Job:
type: object
additionalProperties: false
required:
- id
- project_id
- source_url
- operations
- status
- progress
- attempts
- created_at
- updated_at
properties:
id:
type: string
example: job_5aa58501c5ac48355fba70e4
project_id:
type: string
example: prj_0123456789abcdef
source_url:
type: string
format: uri
operations:
type: array
items:
$ref: "#/components/schemas/Operation"
status:
$ref: "#/components/schemas/JobStatus"
progress:
type: integer
minimum: 0
maximum: 100
attempts:
type: integer
minimum: 0
error_code:
type: string
error_message:
type: string
output:
$ref: "#/components/schemas/Output"
created_at:
type: string
format: date-time
started_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
Output:
type: object
additionalProperties: false
required: [content_type, format, size_bytes, width, height, url]
properties:
content_type:
type: string
enum: [image/jpeg, image/png]
format:
type: string
enum: [jpeg, png]
size_bytes:
type: integer
minimum: 1
width:
type: integer
minimum: 1
height:
type: integer
minimum: 1
url:
type: string
Error:
type: object
additionalProperties: false
required: [code, message]
properties:
code:
type: string
message:
type: string
ErrorResponse:
type: object
additionalProperties: false
required: [error]
properties:
error:
$ref: "#/components/schemas/Error"