-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1020 lines (1019 loc) · 28 KB
/
openapi.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: Library API
description: Get information about books and members of library at OSU.
version: v1
license:
name: GNU Affero General Public License Version 3
url: http://www.gnu.org/licenses/agpl-3.0.en.html
contact:
name: IS Data Architecture Team
url: https://is.oregonstate.edu/data-architecture
email: [email protected]
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/library-api
servers:
- url: https://api.oregonstate.edu/v1
security:
- OAuth2:
- full
paths:
/library/books:
get:
summary: Retrieve a list of all books in the library.
tags:
- books
description: Get all books
operationId: getBooks
parameters:
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageSize'
- in: query
name: filter[title]
description: Search by book title
required: false
schema:
type: string
example: The Alchemist
- in: query
name: filter[author][fuzzy]
description: Search by book author.
required: false
schema:
type: string
example: Paulo Coelho
- in: query
name: filter[publicationYear]
description: Filter books published on a specific year.
required: false
schema:
type: string
pattern: '^\d{4}$'
example: '1988'
- in: query
name: filter[isbn]
description: Filter books by International Standard Book Number (ISBN) for the book
required: false
schema:
type: string
example: '978-0061122415'
- in: query
name: filter[available]
description: Filter books by availability (true/false).
required: false
schema:
type: boolean
- in: query
name: filter[genre]
description: Filter books by genre.
required: false
schema:
type: string
example: Fiction
- in: query
name: filter[description][fuzzy]
description: Search by book description.
required: false
schema:
type: string
example: The Alchemist follows the journey of an Andalusian shepherd
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BookSetResult'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
post:
summary: Add a new book to library
tags:
- books
operationId: postBook
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BookPostBody'
responses:
'201':
description: Book successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/BookResult'
'400':
$ref: '#/components/responses/400'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
/library/books/{bookId}:
get:
summary: Retrieve details of a specific book.
tags:
- books
description: Get book by unique identifier.
operationId: getBookById
parameters:
- $ref: '#/components/parameters/bookId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BookResult'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
patch:
summary: Update details of a specific book.
tags:
- books
description: Update a book by unique identifier.
operationId: updateBookById
parameters:
- $ref: '#/components/parameters/bookId'
requestBody:
required: true
description: patch body for a book
content:
application/json:
schema:
$ref: '#/components/schemas/BookPatchBody'
responses:
'200':
description: Details of the updated book.
content:
application/json:
schema:
$ref: '#/components/schemas/BookResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
/library/members:
get:
summary: Retrieve a list of all library members.
tags:
- members
description: Get all Members
operationId: getMembers
parameters:
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageSize'
- in: query
name: filter[firstName]
description: Search by member first name.
required: false
schema:
type: string
example: John
- in: query
name: filter[lastName]
description: Search by member last name.
required: false
schema:
type: string
example: Doe
- in: query
name: filter[email]
description: Search by member email.
required: false
schema:
type: string
example: '[email protected]'
- in: query
name: filter[address][fuzzy]
description: Search by member street address.
required: false
schema:
type: string
example: 123 Main Street
- in: query
name: filter[city]
description: Search by the city of member.
required: false
schema:
type: string
example: Corvallis
- in: query
name: filter[state]
description: Search by the state of member.
required: false
schema:
type: string
pattern: '^[A-Z]{2}$'
example: OR
- in: query
name: filter[country]
description: Search by the country of member.
required: false
schema:
type: string
example: US
- in: query
name: filter[phoneNumber]
description: Search by member phone number.
required: false
schema:
type: string
pattern: '^\d{3}-\d{3}-\d{4}$'
example: '555-123-4567'
- in: query
name: filter[status]
description: Filter members by membership status.
required: false
schema:
type: string
allOf:
- $ref: '#/components/schemas/MemberStatusEnum'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MemberSetResult'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
post:
summary: Add a new member to the library.
tags:
- members
operationId: postMember
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MemberPostBody'
responses:
'201':
description: Member successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResult'
'400':
$ref: '#/components/responses/400'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
/library/members/{memberId}:
get:
summary: Retrieve details of a specific member.
tags:
- members
description: Get Member by unique identifier.
operationId: getMemberById
parameters:
- $ref: '#/components/parameters/memberId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResult'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
patch:
summary: Update details of a specific member.
tags:
- members
description: Update a member by unique identifier.
operationId: updateMemberById
parameters:
- $ref: '#/components/parameters/memberId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MemberPatchBody'
responses:
'200':
description: Details of the updated member.
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResult'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/library/borrows:
get:
summary: Retrieve a list of all borrowed books from the library.
tags:
- borrows
description: Get all Borrowed Books
operationId: getBorrows
parameters:
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageSize'
- in: query
name: filter[bookId]
description: Search by book ID borrowed.
required: false
schema:
type: string
example: '26'
- in: query
name: filter[memberId]
description: Search by member ID who borrowed the book.
required: false
schema:
type: string
example: '001'
- in: query
name: filter[borrowDate]
description: Filter books borrowed on a specific date.
required: false
schema:
type: string
format: date
description: The borrow date in the format YYYY-MM-DD.
example: '2023-06-30'
- in: query
name: filter[dueDate]
description: Filter books on a specific due date.
required: false
schema:
type: string
format: date
description: The due date in the format YYYY-MM-DD.
example: '2023-07-30'
- in: query
name: filter[returnDate]
description: Filter books returned on a specific date.
required: false
example: '2023-08-30'
schema:
type: string
format: date
description: The return date in the format YYYY-MM-DD.
- in: query
name: filter[status]
description: Filter books by borrowing status.
required: false
schema:
type: string
allOf:
- $ref: '#/components/schemas/BookStatusEnum'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BorrowSetResult'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
post:
summary: Borrow a book against a specific member.
tags:
- borrows
operationId: postBorrowBook
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowPostBody'
responses:
'201':
description: The newly borrowed book.
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowResult'
'400':
$ref: '#/components/responses/400'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
/library/borrows/{borrowId}:
get:
summary: Retrieve details of a specific borrowed book.
tags:
- borrows
description: Get a Borrowed Book by unique identifier.
operationId: getBorrowBookById
parameters:
- $ref: '#/components/parameters/borrowId'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowResult'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
patch:
summary: Update details of a specific borrowed book.
tags:
- borrows
description: Update a borrowed book transaction by a unique identifier.
operationId: updateBorrowBookById
parameters:
- $ref: '#/components/parameters/borrowId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowPatchBody'
responses:
'200':
description: Details of the updated borrowed book.
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowResult'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
components:
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
parameters:
pageNumber:
name: page[number]
in: query
required: false
description: Page number of results
schema:
type: integer
minimum: 1
default: 1
pageSize:
name: page[size]
in: query
required: false
description: Number of results to return
schema:
type: integer
minimum: 1
maximum: 500
default: 25
bookId:
name: bookId
in: path
description: Unique Book ID
required: true
schema:
type: string
pattern: '^[A-Za-z0-9-]+$'
memberId:
name: memberId
in: path
description: Unique Member ID
required: true
schema:
type: string
pattern: '^[A-Za-z0-9-]+$'
borrowId:
name: borrowId
in: path
description: Unique Borrow ID
required: true
schema:
type: string
pattern: '^[A-Za-z0-9-]+$'
responses:
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResult'
schemas:
BookId:
type: string
description: Book ID
example: '26'
BookType:
type: string
enum:
- books
BookAvailable:
type: string
nullable: false
description: Availability of book (true/false).
example: true
BookStatusEnum:
type: string
enum:
- ongoing
- returned
- overdue
MemberId:
type: string
description: Member ID
example: '001'
MemberType:
type: string
enum:
- members
MembershipStatus:
type: string
nullable: false
description: Membership status of the member (active/suspended/expired).
allOf:
- $ref: '#/components/schemas/MemberStatusEnum'
MemberStatusEnum:
type: string
enum:
- active
- suspended
- expired
BorrowId:
type: string
description: Borrow ID
example: bo123
BorrowType:
type: string
enum:
- borrows
BorrowReturnDate:
type: string
format: date
nullable: true
description: Returned date of the book
example: '2023-08-30'
BorrowStatus:
type: string
nullable: true
description: Current borrow status of the book (ongoing/returned/overdue)
allOf:
- $ref: '#/components/schemas/BookStatusEnum'
BookPostBody:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- type
- attributes
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/BookType'
attributes:
allOf:
- $ref: '#/components/schemas/BookPostRequired'
- $ref: '#/components/schemas/BookPostAttributes'
BookPostRequired:
type: object
required:
- title
- author
- publicationYear
- genre
BookPostAttributes:
type: object
additionalProperties: false
properties:
title:
type: string
nullable: false
description: Title of book
example: The Alchemist
author:
type: string
nullable: false
description: Author of book
example: Paulo Coelho
publicationYear:
type: string
nullable: false
description: Publication year of book
pattern: '^\d{4}$'
example: '1988'
isbn:
type: string
nullable: true
description: International Standard Book Number (ISBN) for the book
example: '978-0061122415'
genre:
type: string
nullable: false
description: Genre year of book
example: Fiction
description:
type: string
nullable: true
description: Description or summary of book
minLength: 50
maxLength: 500
example: 'The Alchemist follows the journey of an Andalusian shepherd boy named Santiago...'
BookAttributes:
allOf:
- $ref: '#/components/schemas/BookPostAttributes'
- type: object
properties:
available:
$ref: '#/components/schemas/BookAvailable'
BookResource:
type: object
properties:
id:
$ref: '#/components/schemas/BookId'
type:
$ref: '#/components/schemas/BookType'
links:
$ref: '#/components/schemas/SelfLink'
attributes:
$ref: '#/components/schemas/BookAttributes'
BookResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
$ref: '#/components/schemas/BookResource'
BookSetResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
type: array
items:
$ref: '#/components/schemas/BookResource'
BookPatchBody:
type: object
required:
- data
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/BookId'
type:
$ref: '#/components/schemas/BookType'
attributes:
$ref: '#/components/schemas/BookAttributes'
MemberPostBody:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- type
- attributes
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/MemberType'
attributes:
allOf:
- $ref: '#/components/schemas/MemberPostRequired'
- $ref: '#/components/schemas/MemberPostAttributes'
MemberPostRequired:
type: object
required:
- firstName
- lastName
- email
- address
- city
- state
- country
- phoneNumber
MemberPostAttributes:
type: object
properties:
firstName:
type: string
nullable: false
description: First name of member
example: John
lastName:
type: string
nullable: false
description: Last name of member
example: Doe
email:
type: string
nullable: false
description: Email of member
example: '[email protected]'
address:
type: string
nullable: false
description: Street Address of member
example: 123 Main Street
city:
type: string
nullable: false
description: City of member
example: Corvallis
state:
type: string
nullable: false
description: State of member
pattern: '^[A-Z]{2}$'
example: OR
country:
type: string
nullable: false
description: Country of member
example: US
phoneNumber:
type: string
pattern: '^\d{3}-\d{3}-\d{4}$'
nullable: false
description: Phone number of member
example: '555-123-4567'
MemberAttributes:
allOf:
- $ref: '#/components/schemas/MemberPostAttributes'
- type: object
properties:
status:
$ref: '#/components/schemas/MembershipStatus'
MemberResource:
type: object
properties:
id:
$ref: '#/components/schemas/MemberId'
type:
$ref: '#/components/schemas/MemberType'
links:
$ref: '#/components/schemas/SelfLink'
attributes:
$ref: '#/components/schemas/MemberAttributes'
MemberResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
$ref: '#/components/schemas/MemberResource'
MemberSetResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
type: array
items:
$ref: '#/components/schemas/MemberResource'
MemberPatchBody:
type: object
required:
- data
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/MemberId'
type:
$ref: '#/components/schemas/MemberType'
attributes:
$ref: '#/components/schemas/MemberAttributes'
BorrowSetResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
type: array
items:
$ref: '#/components/schemas/BorrowResource'
BorrowResource:
type: object
properties:
id:
$ref: '#/components/schemas/BorrowId'
type:
$ref: '#/components/schemas/BorrowType'
links:
$ref: '#/components/schemas/SelfLink'
attributes:
$ref: '#/components/schemas/BorrowAttributes'
BorrowAttributes:
allOf:
- $ref: '#/components/schemas/BorrowPostAttributes'
- type: object
properties:
returnDate:
$ref: '#/components/schemas/BorrowReturnDate'
status:
$ref: '#/components/schemas/BorrowStatus'
BorrowPostAttributes:
type: object
additionalProperties: false
properties:
bookId:
$ref: '#/components/schemas/BookId'
memberId:
$ref: '#/components/schemas/MemberId'
borrowDate:
type: string
format: date
nullable: false
description: Borrow date of the book
example: '2023-06-30'
dueDate:
type: string
format: date
nullable: false
description: Due date for returning the book
example: '2023-07-30'
BorrowPostBody:
type: object
required:
- data
additionalProperties: false
properties:
data:
type: object
required:
- type
- attributes
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/BorrowType'
attributes:
allOf:
- $ref: '#/components/schemas/BorrowPostRequired'
- $ref: '#/components/schemas/BorrowPostAttributes'
BorrowPostRequired:
type: object
required:
- bookId
- memberId
- borrowDate
- dueDate
BorrowResult:
properties:
links:
$ref: '#/components/schemas/SelfLink'
data:
$ref: '#/components/schemas/BorrowResource'
BorrowPatchBody:
type: object
required:
- data
properties:
data:
type: object
required:
- id
- type
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/BorrowId'
type:
$ref: '#/components/schemas/BorrowType'
attributes:
$ref: '#/components/schemas/BorrowAttributes'
Meta:
properties:
totalResults:
type: integer
description: Total number of results
example: 10
totalPages:
type: integer
description: Total number of pages
example: 10
currentPageNumber:
type: integer
description: Page number of the returned results
example: 1
currentPageSize:
type: integer
description: Number of results per page
example: 25
SelfLink:
properties:
self:
type: string
format: uri
description: Self-link of current resource
PaginationLinks:
properties:
first:
type: string
format: uri
description: The first page of data
last:
type: string
format: uri
description: The last page of data
prev:
type: string
format: uri
nullable: true
description: The previous page of data
next:
type: string
format: uri
nullable: true
description: The next page of data
ErrorObject:
properties:
status:
type: string
description: HTTP status code
example: '123'
title:
type: string
description: A short, user readable summary of the error
example: Not Found
code: