-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi-schema.yaml
1340 lines (1327 loc) · 34.4 KB
/
openapi-schema.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
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.0
info:
title: CyberDindarolo API
description: ""
version: v1
security:
- Bearer: []
paths:
"/login/":
post:
operationId: login_create
description: An APIview for logging in.
responses:
"200":
description: ""
content:
"application/json":
schema:
type: object
properties:
user_data:
$ref: "#/components/schemas/UserProfileWithoutPB"
token:
description: User auth token
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
description: User username
type: string
password:
description: User password
type: string
required:
- username
- password
tags:
- login
parameters: []
"/logout/":
get:
operationId: logout_list
description: An APIView for logging out.
responses:
"200":
description: ""
tags:
- logout
parameters: []
"/register/":
post:
operationId: register_create
description: An APIView for signing up new User instances.
responses:
"201":
description: ""
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
description: User username
type: string
example: "JohnDoe80"
email:
description: User email
type: string
example: "[email protected]"
first_name:
description: User first name
type: string
example: "John"
last_name:
description: User last name
type: string
example: "Doe"
passwordA:
description: password
type: string
example: "8charMinPWD"
passwordB:
description: password confirmation
type: string
example: "8charMinPWD"
required:
- username
- email
- passwordA
- passwordB
- first_name
- last_name
tags:
- register
parameters: []
"/verify_account/{uidb64}/{token}/":
get:
security: []
operationId: verify_account_read
summary: This APIView send a one time link to the user mail to verify his mail.
description: |-
:param uidb64: user identifier in base64
:param token: one time token for email confirmation
responses:
"200":
description: ""
tags:
- verify_account
parameters:
- name: token
in: path
required: true
schema:
type: string
- name: uidb64
in: path
required: true
schema:
type: string
"/forgot_password/":
post:
security: []
operationId: forgot_password_create
description: This APIView send an email to the user to reset his password.
responses:
"201":
description: ""
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: "[email protected]"
required:
- email
tags:
- password
parameters: []
"/reset_password/{uidb64}/{token}/":
get:
security: []
operationId: reset_password_read
summary: This APIView assigns a temporary password to the user and send it to him
via mail.
description: |-
:param uidb64: user identifier in base64
:param token: one time token for password change
responses:
"200":
description: ""
tags:
- password
parameters:
- name: token
in: path
required: true
schema:
type: string
- name: uidb64
in: path
required: true
schema:
type: string
"/users/":
get:
operationId: users_list
description: A viewset for viewing and editing User instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/UserProfileWithoutPB"
tags:
- users
parameters: []
"/users/inside/{piggybank}/":
get:
operationId: users_inside_read
description: An APIView for viewing users inside pb.
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Participate"
tags:
- users
parameters:
- name: piggybank
in: path
required: true
schema:
type: string
"/users/search/{pattern}/":
get:
operationId: users_search_read
description: An APIview for searching User instances by username or email.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/UserProfileWithoutPB"
tags:
- users
parameters:
- name: pattern
in: path
required: true
schema:
type: string
"/users/{auth_user}/":
get:
operationId: users_read
description: A viewset for viewing and editing User instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/UserProfileWithoutPB"
tags:
- users
patch:
operationId: users_partial_update
description: A viewset for viewing and editing User instances.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UserProfileWithoutPB"
required: true
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/UserProfileWithoutPB"
tags:
- users
delete:
operationId: users_delete
description: A viewset for viewing and editing User instances.
responses:
"204":
description: ""
tags:
- users
parameters:
- name: auth_user
in: path
description: A unique value identifying this user profile.
required: true
schema:
type: string
"/credit/{piggybank}/":
get:
operationId: credit_read
description: An APIView for viewing user credit in pb.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/PartialParticipate"
tags:
- credit
parameters:
- name: piggybank
in: path
required: true
schema:
type: string
"/entries/":
get:
operationId: entries_list
description: A viewset for viewing and editing Entry instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Entry"
tags:
- entries
post:
operationId: entries_create
description: A viewset for viewing and editing Entry instances.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Entry"
required: true
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Entry"
tags:
- entries
parameters: []
"/entries/{id}/":
get:
operationId: entries_read
description: A viewset for viewing and editing Entry instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Entry"
tags:
- entries
delete:
operationId: entries_delete
description: A viewset for viewing and editing Entry instances.
responses:
"204":
description: ""
tags:
- entries
parameters:
- name: id
in: path
description: A unique integer value identifying this entry.
required: true
schema:
type: integer
"/purchases/":
get:
operationId: purchases_list
description: A viewset for viewing and editing Purchase instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Purchase"
tags:
- purchases
post:
operationId: purchases_create
description: A viewset for viewing and editing Purchase instances.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Purchase"
required: true
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Purchase"
tags:
- purchases
parameters: []
"/purchases/{id}/":
get:
operationId: purchases_read
description: A viewset for viewing and editing Purchase instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Purchase"
tags:
- purchases
delete:
operationId: purchases_delete
description: A viewset for viewing and editing Purchase instances.
responses:
"204":
description: ""
tags:
- purchases
parameters:
- name: id
in: path
description: A unique integer value identifying this purchase.
required: true
schema:
type: integer
"/stock/{piggybank}/":
get:
operationId: stock_read
description: An APIView for viewing the stock of a pb instance.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Stock"
tags:
- stock
parameters:
- name: piggybank
in: path
required: true
schema:
type: string
"/stock/{piggybank}/{product}/":
get:
operationId: stock_read_with_product
description: An APIView for viewing the stock of a product in pb instance.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Stock"
tags:
- stock
parameters:
- name: piggybank
in: path
required: true
schema:
type: string
- name: product
in: path
required: true
schema:
type: string
"/invitations/":
get:
operationId: invitations_list
description: A viewset for viewing and deleting Invitation instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Invitation"
tags:
- invitations
post:
operationId: invitations_create
description: A viewset for viewing and deleting Invitation instances.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Invitation"
required: true
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Invitation"
tags:
- invitations
parameters: []
"/invitations/manage/{invitation}/":
post:
operationId: invitations_manage_create
description: An APIview for managing invitation (accept or decline).
responses:
"201":
description: ""
requestBody:
content:
application/json:
schema:
type: object
properties:
accept:
description: Accept or decline invitation
type: integer
default: 0
minimum: 0
maximum: 1
tags:
- invitations
parameters:
- name: invitation
in: path
required: true
schema:
type: string
"/invitations/{id}/":
get:
operationId: invitations_read
description: A viewset for viewing and deleting Invitation instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Invitation"
tags:
- invitations
delete:
operationId: invitations_delete
description: A viewset for viewing and deleting Invitation instances.
responses:
"204":
description: ""
tags:
- invitations
parameters:
- name: id
in: path
description: A unique integer value identifying this invitation.
required: true
schema:
type: integer
"/piggybanks/":
get:
operationId: piggybanks_list
description: A viewset for viewing and editing PiggyBank instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/PiggyBank"
tags:
- piggybanks
post:
operationId: piggybanks_create
description: A viewset for viewing and editing PiggyBank instances.
requestBody:
$ref: "#/components/requestBodies/PiggyBank"
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/PiggyBank"
tags:
- piggybanks
parameters: []
"/piggybanks/search/{pattern}/":
get:
operationId: piggybanks_search_read
description: An APIview for searching PiggyBank instances by name.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/PiggyBank"
tags:
- piggybanks
parameters:
- name: pattern
in: path
required: true
schema:
type: string
"/piggybanks/{id}/":
get:
operationId: piggybanks_read
description: A viewset for viewing and editing PiggyBank instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/PiggyBank"
tags:
- piggybanks
patch:
operationId: piggybanks_partial_update
description: A viewset for viewing and editing PiggyBank instances.
requestBody:
$ref: "#/components/requestBodies/PiggyBank"
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/PiggyBank"
tags:
- piggybanks
delete:
operationId: piggybanks_delete
description: A viewset for viewing and editing PiggyBank instances.
responses:
"204":
description: ""
tags:
- piggybanks
parameters:
- name: id
in: path
description: A unique integer value identifying this piggy bank.
required: true
schema:
type: integer
"/products/":
get:
operationId: products_list
description: A viewset for viewing and editing Product instances.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Product"
tags:
- products
post:
operationId: products_create
description: A viewset for viewing and editing Product instances.
requestBody:
$ref: "#/components/requestBodies/Product"
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
tags:
- products
parameters: []
"/products/search/{pattern}/":
get:
operationId: products_search_read
description: An APIview for searching Product instances by name.
responses:
"200":
description: ""
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
nullable: true
previous:
type: string
format: uri
nullable: true
results:
type: array
items:
$ref: "#/components/schemas/Product"
tags:
- products
parameters:
- name: pattern
in: path
required: true
schema:
type: string
"/products/{id}/":
get:
operationId: products_read
description: A viewset for viewing and editing Product instances.
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
tags:
- products
patch:
operationId: products_partial_update
description: A viewset for viewing and editing Product instances.
requestBody:
$ref: "#/components/requestBodies/Product"
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
tags:
- products
delete:
operationId: products_delete
description: A viewset for viewing and editing Product instances.
responses:
"204":
description: ""
tags:
- products
parameters:
- name: id
in: path
description: A unique integer value identifying this product.
required: true
schema:
type: integer
servers:
- url: http://localhost:8000/api/v1
components:
requestBodies:
Product:
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
required: true
PiggyBank:
content:
application/json:
schema:
$ref: "#/components/schemas/PiggyBank"
required: true
securitySchemes:
Bearer:
type: apiKey
name: Authorization
in: header
schemas:
Entry:
required:
- product
- piggybank
- entry_price
- set_quantity
type: object
properties:
id:
title: ID
type: integer
readOnly: true
example: 1
product:
title: Product
type: integer
example: 1
product_name:
title: Product name
type: string
readOnly: true
minLength: 1
example: "Ice Cream (Brand XYZ)"
piggybank:
title: Piggybank
type: integer
example: 1
piggybank_name:
title: Piggybank name
type: string
readOnly: true
minLength: 1
example: "My PiggyBank 1"
entry_date:
title: Entry date
type: string
format: date-time
readOnly: true
entry_price:
title: Entry price
type: string
format: decimal
description: Single set price
example: 4.99
entered_by:
title: Entered by
type: string
readOnly: true
example: 1
entered_by_username:
title: Entered by username
type: string
readOnly: true
minLength: 1
example: "JohnDoe80"
set_quantity:
title: Set quantity
type: integer
maximum: 9223372036854776000
minimum: 1
example: 1
Invitation:
required:
- invited
- piggybank
type: object
properties: