-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
1524 lines (1492 loc) · 48.1 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
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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Fauna JavaScript sample app
description: |
HTTP API reference documentation for the [Fauna JavaScript sample
app](https://github.com/fauna/js-sample-app).
The app uses Fauna and Node.js to create HTTP API endpoints for a sample
e-commerce store. You can use the endpoints to manage customers,
products, and orders for the store.
For an overview and more details, see the
[README](https://github.com/fauna/js-sample-app).
## Authentication
Requests to the endpoints require no authentication. Internally, requests to
Fauna are authenticated using a Fauna key's secret. You pass the secret
using the `FAUNA_SECRET` environment variable in `.env`.
For setup instructions, see the
[README](https://github.com/fauna/js-sample-app).
servers:
- url: /
description: Local development server
tags:
- name: Customers
description: "Get, create, and update customers for the e-commerce store."
- name: Products
description: "Get, create, and update products for the e-commerce store."
- name: Orders
description: |
Get, create, and update customer orders for the e-commerce store.
You can also use these endpoints to create and udpate a customer's cart.
A customer's cart is an order with the `cart` status. A customer can have
one cart at a time.
An order contains zero or more items. An item links a product, with a
quantity, to an order.
components:
schemas:
CustomerRequest:
type: object
required:
- name
- email
- address
properties:
name:
type: string
description: Customer name
email:
type: string
format: email
description: |
Customer's email address. Must be unique.
Internally, the `Customer` collection uses a unique constraint to
ensure `email` values are unique across customers.
address:
type: object
description: Customer's mailing address.
required:
- street
- city
- state
- postalCode
- country
properties:
street:
type: string
description: Street of the customer's mailing address.
city:
type: string
description: City of the customer's mailing address.
state:
type: string
description: State of the customer's mailing address.
postalCode:
type: string
description: Postal code of the customer's mailing address.
country:
type: string
description: Country of the customer's mailing address.
example:
name: John Doe
email: [email protected]
address:
street: 123 Main St
city: San Francisco
state: CA
postalCode: "12345"
country: United States
CustomerResponse:
type: object
properties:
id:
type: string
description: "Unique, auto-generated ID for the customer."
name:
type: string
description: Customer name.
email:
type: string
format: email
description: Customer's email address. Must be unique.
address:
type: object
description: Customer's mailing address.
properties:
street:
type: string
description: Street of the customer's mailing address.
city:
type: string
description: City of the customer's mailing address.
state:
type: string
description: State of the customer's mailing address.
postalCode:
type: string
description: Postal code of the customer's mailing address.
country:
type: string
description: Country of the customer's mailing address.
example:
id: "111"
name: John Doe
email: [email protected]
address:
street: 123 Main St
city: San Francisco
state: CA
postalCode: "12345"
country: United States
ProductRequest:
type: object
required:
- name
- description
- price
- stock
- category
properties:
name:
type: string
description: |
Name of the product. Must be unique.
Internally, the `Product` collection uses a unique constraint to
ensure `name` values are unique across products.
description:
type: string
description: Description of the product.
price:
type: integer
description: |
Price of the product in USD cents.
Internally, the `Product` collection uses a check constraint to
ensure `price` is an integer greater than zero.
stock:
type: integer
description: |
Quantity of the product available in stock.
Internally, the `Product` collection uses a check constraint to
ensure `stock` is greater than or equal to zero.
category:
type: string
description: >
Name of the product's category. Must match an existing category.
Internally, this field contains a reference to a `Category`
collection
document.
example:
name: The Old Man and the Sea
price: 899
description: A book by Ernest Hemingway
stock: 10
category: books
ProductPageResponse:
type: object
properties:
results:
type: array
description: Page of products.
items:
$ref: "#/components/schemas/ProductResponse"
nextToken:
type: string
description: |
Pagination token. Pass the token to the endpoint's `nextToken` query
parameter to get the next page of results.
example:
results:
- id: "123"
name: The Old Man and the Sea
price: 899
description: A book by Ernest Hemingway
stock: 10
category:
id: "123"
name: books
description: Bargain books!
nextToken: hdW...
ProductResponse:
type: object
properties:
id:
type: string
description: "Unique, auto-generated ID for the product."
name:
type: string
description: Name of the product.
price:
type: integer
description: Price of the product in USD cents.
description:
type: string
description: Description of the product.
stock:
type: integer
description: Quantity of the product available in stock.
category:
type: object
description: Category to which the product belongs.
properties:
id:
type: string
description: "Unique, auto-generated ID for the category."
name:
type: string
description: Name of the category.
description:
type: string
description: Description of the category.
example:
id: "123"
name: The Old Man and the Sea
price: 899
description: A book by Ernest Hemingway
stock: 10
category:
id: "123"
name: books
description: Bargain books!
FilteredProductPageResponse:
type: object
properties:
data:
type: array
description: Page of filtered products.
items:
$ref: "#/components/schemas/FilteredProductResponse"
nextToken:
type: string
description: |
Pagination token. Pass the token to the endpoint's `nextToken` query
parameter to get the next page of results.
example:
results:
- id: "123"
name: The Old Man and the Sea
description: A book by Ernest Hemingway
price: 899
stock: 10
category:
id: "123"
name: "books"
description: "Bargain books!"
nextToken: hdW...
FilteredProductResponse:
type: object
properties:
name:
type: string
description: Name of the product.
description:
type: string
description: Description of the product.
price:
type: integer
description: Price of the product in USD cents.
stock:
type: integer
description: Quantity of the product available in stock.
example:
name: The Old Man and the Sea
description: A book by Ernest Hemingway
price: 899
stock: 10
OrderRequest:
type: object
properties:
status:
type: string
enum:
- cart
- processing
- shipped
- delivered
description: |
Status of the order.
An order's status can only transition as follows:
`cart` → `processing` → `shipped` → `delivered`
Internally, the endpoint uses the `validateOrderStatusTransition()`
user-defined function (UDF) to ensure an order's `status` change is
allowed.
payment:
type: object
default: {}
description: |
Arbitrary object containing payment information.
You can only update payment information if the `status` is `cart`.
Adding payment information automatically transitions the order's
`status` to `processing`.
example:
status: processing
OrderPageResponse:
type: object
properties:
results:
type: array
description: Page of orders.
items:
$ref: "#/components/schemas/OrderResponse"
nextToken:
type: string
description: |
Pagination token. Pass the token to the endpoint's `nextToken` query
parameter to get the next page of results.
example:
results:
- id: "123"
payment: {}
createdAt: "2099-08-09T16:43:07.153186Z"
status: cart
total: 899
items:
- product:
id: "123"
name: For Whom the Bell Tolls
price: 899
description: A book by Ernest Hemingway
stock: 10
category:
id: "123"
name: books
description: Bargain books!
quantity: 1
customer:
id: "111"
name: John Doe
email: [email protected]
address:
street: 123 Main St
city: San Francisco
state: CA
postalCode: "12345"
country: United States
nextToken: hdW...
OrderResponse:
type: object
properties:
id:
type: string
description: "Unique, auto-generated ID for the order."
payment:
type: object
description: Payment details for the order (currently empty).
createdAt:
type: string
format: date-time
description: ISO-8601-formatted timestamp of when the order was created.
status:
type: string
description: Current status of the order.
enum:
- cart
- processing
- shipped
- delivered
total:
type: integer
description: Total cost of the order.
items:
type: array
description: Items in the order.
items:
$ref: "#/components/schemas/OrderItem"
customer:
$ref: "#/components/schemas/CustomerResponse"
example:
id: "123"
payment: {}
createdAt: "2099-08-09T16:43:07.153186Z"
status: cart
total: 899
items:
- product:
id: "123"
name: For Whom the Bell Tolls
price: 899
description: A book by Ernest Hemingway
stock: 10
category:
id: "123"
name: books
description: Bargain books!
quantity: 1
customer:
id: "111"
name: John Doe
email: [email protected]
address:
street: 123 Main St
city: San Francisco
state: CA
postalCode: "12345"
country: United States
OrderItem:
type: object
properties:
product:
$ref: "#/components/schemas/ProductResponse"
quantity:
type: integer
description: Quantity of the product in the order.
example:
product:
id: "123"
name: For Whom the Bell Tolls
price: 899
description: A book by Ernest Hemingway
stock: 7
category:
id: "123"
name: books
description: Bargain books!
quantity: 1
OrderItemRequest:
type: object
required:
- productName
- quantity
properties:
productName:
type: string
description: |
Name of an existing product to add to the order.
quantity:
type: integer
description: >
Quantity of the product to add to the order.
Must be a non-negative integer. The quantity must be less than the
product's `stock`.
Internally, the `OrderItem` collection uses a check constraint to
ensure `quantity` is a positive integer.
example:
productName: The Old Man and the Sea
quantity: 1
ErrorResponse:
type: object
properties:
message:
type: string
description: Error message.
example:
message: Invalid request parameter
paths:
/customers:
post:
summary: Create a customer.
operationId: create-customer
security:
- {}
tags:
- Customers
description: Create a customer with the specified details.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerRequest"
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
invalid-name:
summary: Invalid name.
value:
message: Name must be a non-empty string.
invalid-email:
summary: Invalid email.
value:
message: Email must be a non-empty string.
invalid-address:
summary: Invalid address.
value:
message: >-
Address must contain a street, city, state, postalCode and
country represented as strings.
invalid-request:
summary: Invalid customer request.
value:
message: >-
Unable to create customer, please check that the fields in
your request body are valid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Unauthorized.
value:
message: >-
Unauthorized. Set the `FAUNA_SECRET` env var to a valid
Fauna key's secret.
"409":
description: Conflict
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Customer email already exists.
value:
message: A customer with that email already exists.
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example-1:
summary: Internal server error.
value:
message: An unexpected error occurred
x-codeSamples:
- lang: curl
source: |-
curl -v -X POST http://localhost:8000/customers \
--header 'content-type: application/json' \
--data '{"name":"John Doe","email":"[email protected]","address":{"street":"123 Main St","city":"San Francisco","state":"CA","postalCode":"12345","country":"United States"}}'
"/customers/{id}":
get:
summary: Get a customer.
operationId: get-customer
security:
- {}
tags:
- Customers
description: Fetch the details of a customer by their ID.
parameters:
- name: id
in: path
description: ID of the customer to retrieve.
required: true
schema:
type: string
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Invalid id
value:
message: Invalid id '!' provided.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Unauthorized
value:
message: >-
Unauthorized. Set the `FAUNA_SECRET` env var to a valid
Fauna key's secret.
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: No customer with id
value:
message: No customer with id '111' exists.
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example-1:
summary: Internal server error
value:
message: An unexpected error occurred
x-codeSamples:
- lang: curl
source: |-
curl -v http://localhost:8000/customers/111
patch:
summary: Update a customer.
operationId: update-customer
security:
- {}
tags:
- Customers
description: Update the details of a customer by their ID.
parameters:
- name: id
in: path
description: ID of the customer to update.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerRequest"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
invalid-name:
summary: Invalid name.
value:
message: Name must be a non-empty string or be omitted.
invalid-email:
summary: Invalid email.
value:
message: Name must be a non-empty string or be omitted.
invalid-address:
summary: Invalid address.
value:
message: >-
Address must contain a street, city, state, postalCode and
country represented as strings or be omitted.
invalid-request:
summary: Invalid customer request.
value:
message: >-
Unable to create customer, please check that the fields in
your request body are valid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Unauthorized
value:
message: >-
Unauthorized. Set the `FAUNA_SECRET` env var to a valid
Fauna key's secret.
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: No customer with id
value:
message: No customer with id '111' exists.
"409":
description: Conflict
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Customer email already exists
value:
message: A customer with that email already exists.
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example-1:
summary: Internal server error
value:
message: An unexpected error occurred
x-codeSamples:
- lang: curl
source: |-
curl -v -X PATCH http://localhost:8000/customers/111 \
--header 'content-type: application/json' \
--data '{"name":"John Doe","email":"[email protected]","address":{"street":"123 Main St","city":"San Francisco","state":"CA","postalCode":"12345","country":"United States"}}'
/products:
get:
summary: Get a page of products.
operationId: get-products
security:
- {}
tags:
- Products
parameters:
- name: category
in: query
schema:
type: string
description: Category name to filter products by.
- name: nextToken
in: query
schema:
type: string
description: |
Accepts a pagination token. The endpoint's responses
return these tokens in the `nextToken` property.
- name: pageSize
in: query
schema:
type: integer
default: 10
description: Number of products to return per page.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ProductPageResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
invalid-cat:
summary: Invalid category.
value:
message: Category must be a string or be omitted.
cat-not-found:
summary: Category not found.
value:
message: Category does not exist.
invalid-pagesize:
summary: Invalid pageSize.
value:
message: Page size must be a positive integer or be omitted.
invalid-next-token:
summary: Invalid nextToken.
value:
message: Next token must be a string or be omitted.
invalid-query:
summary: Invalid product request.
value:
message: >-
Unable to create product, please check that the fields in
your request body are valid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Unauthorized.
value:
message: >-
Unauthorized. Set the `FAUNA_SECRET` env var to a valid
Fauna key's secret.
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example-1:
summary: Internal server error.
value:
message: An unexpected error occurred
x-codeSamples:
- lang: curl
source: |-
curl -v 'http://localhost:8000/products?category=books&pageSize=1'
post:
summary: Create a product.
operationId: create-product
security:
- {}
tags:
- Products
description: Create a product with the specified details.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ProductRequest"
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ProductResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
invalid-name:
summary: Invalid name.
value:
message: Name must be a non-empty string.
invalid-price:
summary: Invalid price.
value:
message: Price must be an integer greater than 0.
invalid-desc:
summary: Invalid description.
value:
message: Description must be a non-empty string.
invalid-stock:
summary: Invalid stock.
value:
message: Stock must be an integer greater than or equal to 0.
invalid-cat:
summary: Invalid category.
value:
message: Category must be a non-empty string.
cat-not-found:
summary: Category not found.
value:
message: Category does not exist.
invalid-query:
summary: Invalid product request.
value:
message: >-
Unable to create product, please check that the fields in
your request body are valid.
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Unauthorized.
value:
message: >-
Unauthorized. Set the `FAUNA_SECRET` env var to a valid
Fauna key's secret.
"409":
description: Conflict
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example:
summary: Customer email already exists.
value:
message: A product with that name already exists.
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
example-1:
summary: Internal server error.
value:
message: An unexpected error occurred
x-codeSamples:
- lang: curl
source: |-
curl -v -X POST http://localhost:8000/products \
--header 'content-type: application/json' \
--data '{"name":"The Old Man and the Sea","price":899,"description":"A book by Ernest Hemingway","stock":10,"category":"books"}'
"/products/{id}":
patch:
summary: Update a product.
operationId: update-product
security:
- {}
tags:
- Products
description: Update the details of a product by its ID.
parameters:
- name: id
in: path
description: ID of the product to update.
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ProductRequest"
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ProductResponse"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
invalid-name:
summary: Invalid name.
value:
message: Name must be a non-empty string or be omitted.
invalid-price:
summary: Invalid price.
value:
message: Price must be an integer greater than 0 or be omitted.
invalid-desc:
summary: Invalid description.
value:
message: Description must be a string or be omitted.
invalid-stock:
summary: Invalid stock.
value:
message: >-
Stock must be an integer greater than or equal to 0 or be
omitted.
invalid-cat:
summary: Invalid category.
value:
message: Category must be a string or be omitted.
cat-not-found: