generated from Redocly/openapi-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathphixer.yaml
722 lines (692 loc) · 26.6 KB
/
phixer.yaml
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
openapi: "3.1.0"
info:
version: "1"
title: "API"
tags:
- name: Projects
description: ""
- name: Products
description: ""
servers:
- url: "https://api.phixer.net/"
security:
- apiKey_header: []
paths:
/v1/projects:
post:
tags:
- Projects
summary: Create a project
description: ""
operationId: Create a project
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewProject"
responses:
"200":
description: Project
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
get:
tags:
- Projects
summary: List of projects
description: ""
operationId: Retrieve projects
parameters:
- name: search
in: query
description: Return projects that have fields matching this term.
required: false
schema:
type: string
- name: status
in: query
description: Return projects that have a certain status.
required: false
schema:
type: string
enum:
- NEW
- EDITING
- COMPLETED
- ARCHIVED
- name: per_page
in: query
description: The number of items per page. Defaults to 25.
required: false
schema:
type: integer
default: 25
- name: page
in: query
description: The requested page. Defaults to 1.
required: false
schema:
type: integer
default: 1
responses:
"200":
description: Project
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Project"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/projects/{projectId}:
get:
tags:
- Projects
summary: Retrieve a project
description: ""
operationId: Retrieve a project
parameters:
- name: projectId
in: path
description: ID of project to return
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Project
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
tags:
- Projects
summary: Delete a project
description: ""
operationId: Delete a project
parameters:
- name: projectId
in: path
description: ID of project to delete
required: true
schema:
type: string
format: uuid
responses:
"200":
description: No Content
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/products:
get:
tags:
- Products
summary: List of Editing products
description: ""
operationId: List of Editing products
responses:
"200":
description: Product
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/packages:
get:
tags:
- Packages
summary: List of Photoshoot packages
description: ""
operationId: List of Photoshoot packages
responses:
"200":
description: Package
content:
application/json:
schema:
$ref: "#/components/schemas/Package"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/photoshoots:
post:
tags:
- Photoshoots
summary: Create a Photoshoot project
description: ""
operationId: Create a Photoshoot project
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/NewPhotoshoot"
responses:
"200":
description: Photoshoot
content:
application/json:
schema:
$ref: "#/components/schemas/Photoshoot"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
get:
tags:
- Photoshoots
summary: List of Photoshoot projects
description: ""
operationId: Retrieve Photoshoot projects
parameters:
- name: search
in: query
description: Return Photoshoot projects that have fields matching this term.
required: false
schema:
type: string
- name: status
in: query
description: Return Photoshoot projects that have a certain status.
required: false
schema:
type: string
enum:
- NEW
- CANCELLED
- RESCHEDULED
- SCHEDULED
- EDITING
- COMPLETED
- ARCHIVED
- name: per_page
in: query
description: The number of items per page. Defaults to 25.
required: false
schema:
type: integer
default: 25
- name: page
in: query
description: The requested page. Defaults to 1.
required: false
schema:
type: integer
default: 1
responses:
"200":
description: Photoshoot
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Photoshoot"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/photoshoots/{photoshootId}:
get:
tags:
- Photoshoots
summary: Retrieve a Photoshoot project
description: ""
operationId: Retrieve a Photoshoot project
parameters:
- name: photoshootId
in: path
description: ID of photoshoot project to return
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Photoshoot
content:
application/json:
schema:
$ref: "#/components/schemas/Photoshoot"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
tags:
- Photoshoots
summary: Delete a Photoshoot project
description: You can only delete photoshoot if the status is `NEW` and `CANCELLED`
operationId: Delete a Photoshoot project
parameters:
- name: photoshootId
in: path
description: ID of photoshoot project to delete
required: true
schema:
type: string
format: uuid
responses:
"200":
description: No Content
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/photoshoots/{photoshootId}/cancel:
post:
tags:
- Photoshoots
summary: Cancel a Scheduled Photoshoot project
description: ""
operationId: Cancel a Scheduled Photoshoot project
parameters:
- name: photoshootId
in: path
description: ID of photoshoot project to return
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cancel_reason:
type: string
description: The reason why to cancel.
responses:
"200":
description: Photoshoot
content:
application/json:
schema:
$ref: "#/components/schemas/Photoshoot"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/v1/photoshoots/{photoshootId}/reschedule:
post:
tags:
- Photoshoots
summary: Reschedule a Scheduled Photoshoot project
description: ""
operationId: Reschedule a Scheduled Photoshoot project
parameters:
- name: photoshootId
in: path
description: ID of photoshoot project to return
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
preferred_date:
type: string
description: The new preferred shoot date and time (ISO 8601 format).
responses:
"200":
description: Photoshoot
content:
application/json:
schema:
$ref: "#/components/schemas/Photoshoot"
400:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
securitySchemes:
apiKey_header:
type: apiKey
in: header
name: Authorization
description: An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
schemas:
Project:
type: object
properties:
id:
type: string
description: ID of the project.
example: a938e733-2c1e-4cd3-b1fd-384d2b5cb695
external_id:
type: string
description: Your internal ID as reference for this project.
example: 27d001cc-061a-4dcf-81e2-3d5d697844af
name:
type: string
description: The name of the project.
example: 4070 Georgia St, San Diego, CA 92103, USA
product_id:
type: string
description: ID of the EDITING_STYLE product to associate with this project.
example: 1
turnaround_time_id:
type: string
description: ID of the TURNAROUND_TIME product to associate with this project.
example: 2
notes:
type: string
description: Notes for the project.
example: Water needs to be natural looking (no unrealistic blues), Please keep exterior trees/bushes a lush green (not yellowish)
files:
type: array
description: The list of your files
items:
type: object
properties:
id:
type: string
description: ID of the file.
example: 6505684f-08b5-4ad0-91bf-3b8c436b8116
url:
type: string
description: URL of the file.
example: https://phixer-enterprise-assets.s3.us-west-2.amazonaws.com/projects/6789c0ba-626f-03c1-6822-c320752c02bd/raw/_MG_5184.jpg
version:
type: integer
description: Version of the file.
example: 0
type:
type: string
description: Type of the file.
enum:
- RAW
- EDITED
example: RAW
editing_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was edited.
example: 2024-12-07T14:00:00.255Z
completed_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was completed.
example: 2024-12-07T14:00:00.255Z
created_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was created.
example: 2024-12-07T14:00:00.255Z
updated_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was last updated.
example: 2024-12-07T14:00:00.255Z
status:
type: string
description: The status of the project.
enum:
- NEW
- EDITING
- COMPLETED
- ARCHIVED
example: NEW
Product:
type: object
properties:
id:
type: string
description: ID of the product.
example: 2f578663-56d2-4466-9498-115f45249f72
name:
type: string
description: The name of the product.
example: Basic Editing
type:
type: string
description: Type of the product.
enum:
- EDITING_STYLE
- TURNAROUND_TIME
example: EDITING_STYLE
NewProject:
type: object
required:
- name
- external_id
- product_id
- photo_urls
properties:
name:
type: string
description: The name of the project.
external_id:
type: string
description: Your internal ID as reference for this project.
product_id:
type: string
description: ID of the EDITING_STYLE product to associate with this project.
turnaround_time_id:
type: string
description: ID of the TURNAROUND_TIME product to associate with this project.
notes:
type: string
description: Notes for the project.
photo_urls:
type: array
description: The list of public raw photo urls.
items:
type: string
NewPhotoshoot:
type: object
required:
- address
- address_coordinates
- external_id
- package_id
- preferred_photoshoot_date
properties:
address:
type: string
description: The full address of the property.
address_coordinates:
type: object
properties:
lat:
type: string
description: the latitude coordinate of the property.
lng:
type: string
description: the longitude coordinate of the property.
external_id:
type: string
description: Your internal ID as reference for this photoshoot.
package_id:
type: string
description: ID of the Photoshoot Package to associate with this photoshoot.
preferred_photoshoot_date:
type: string
description: The preferred shoot date and time (ISO 8601 format).
notes:
type: string
description: Notes or instructions for photographer for the photoshoot.
apt:
type: string
description: The apartment number of the property.
Photoshoot:
type: object
properties:
id:
type: string
description: ID of the photoshoot.
example: 056fa34f-fdee-48fe-b3c3-58db76833401
external_id:
type: string
description: Your internal ID as reference for this photoshoot.
example: a1b20e42-fc47-4a7e-a3c1-ebab3bd119a3
name:
type: string
description: The name of the photoshoot project.
example: 4070 Georgia St, San Diego, CA 92103, USA
package_id:
type: string
description: ID of the Photoshoot Package to associate with this photoshoot.
example: 1
notes:
type: string
description: Notes or instructions for photographer for the photoshoot.
example: "Contact on site is Bill Brasky, His phone number is: 206-999-0909"
preferred_photoshoot_date:
type: string
description: The preferred shoot date and time (ISO 8601 format).
example: 2024-12-07T14:00:00.255Z
files:
type: array
description: The list of your files
items:
type: object
properties:
id:
type: string
description: ID of the file.
example: 6505684f-08b5-4ad0-91bf-3b8c436b8116
url:
type: string
description: URL of the file.
example: https://phixer-enterprise-assets.s3.us-west-2.amazonaws.com/projects/6789c0ba-626f-03c1-6822-c320752c02bd/raw/_MG_5184.jpg
version:
type: integer
description: Version of the file.
example: 0
type:
type: string
description: Type of the file.
enum:
- RAW
- EDITED
example: RAW
photographer:
$ref: "#/components/schemas/Photographer"
description: The photographer assigned to the photoshoot.
cancelled_reason:
type: string
description: The reason why the photo shoot is cancelled.
editing_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was edited.
example: 2024-12-07T14:00:00.255Z
scheduled_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was scheduled.
example: 2024-12-07T14:00:00.255Z
completed_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was completed.
example: 2024-12-07T14:00:00.255Z
created_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was created.
example: 2024-12-07T14:00:00.255Z
updated_at:
type: date-time
description: The date and time (ISO 8601 format) when the project was last updated.
example: 2024-12-07T14:00:00.255Z
status:
type: string
description: The status of the project.
enum:
- NEW
- CANCELLED
- RESCHEDULED
- SCHEDULED
- EDITING
- COMPLETED
- ARCHIVED
example: NEW
Photographer:
type: object
properties:
id:
type: string
description: ID of the photographer.
example: 570efe86-bc3c-4931-950a-0d018ea0d43a
first_name:
type: string
description: The first name of the photographer.
example: Johnny
last_name:
type: string
description: The last name of the photographer.
example: Sinner
phone:
type: string
description: The phone number of the photographer
example: 313-333-337
Package:
type: object
properties:
id:
type: string
description: ID of the photoshoot package.
example: 1
name:
type: string
description: The name of the photoshoot package.
example: Standard Package
description:
type: string
description: The description of the photoshoot package.
example: 25 Still photos
Error:
type: object
required:
- message
properties:
message:
description: A human readable error message
type: string