Skip to content

Commit 5536dc6

Browse files
committed
Merge branch 'main' of https://github.com/OperationCode/resources_api into feature/implement-flask-admin
2 parents 6f1de51 + f27184a commit 5536dc6

File tree

3 files changed

+82
-65
lines changed

3 files changed

+82
-65
lines changed

app/static/openapi.yaml

Lines changed: 47 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ paths:
176176
content:
177177
application/json:
178178
schema:
179-
$ref: '#/components/schemas/Category'
179+
$ref: '#/components/schemas/CategoriesResponse'
180180
example:
181181
apiVersion: '1.0'
182182
categories:
@@ -253,7 +253,7 @@ paths:
253253
content:
254254
application/json:
255255
schema:
256-
$ref: '#/components/schemas/Category_data'
256+
$ref: '#/components/schemas/CategoryResponse'
257257
example:
258258
apiVersion: '1.0'
259259
category:
@@ -350,7 +350,7 @@ paths:
350350
content:
351351
application/json:
352352
schema:
353-
$ref: '#/components/schemas/Language_data'
353+
$ref: '#/components/schemas/Language'
354354
example:
355355
apiVersion: '1.0'
356356
language:
@@ -494,7 +494,7 @@ paths:
494494
content:
495495
application/json:
496496
schema:
497-
$ref: '#/components/schemas/Resource_data'
497+
$ref: '#/components/schemas/Resource'
498498
example:
499499
apiVersion: '1.0'
500500
resource:
@@ -538,7 +538,7 @@ paths:
538538
content:
539539
application/json:
540540
schema:
541-
$ref: '#/components/schemas/Resource_data'
541+
$ref: '#/components/schemas/Resource'
542542
example:
543543
apiVersion: '1.0'
544544
resource:
@@ -582,7 +582,7 @@ paths:
582582
content:
583583
application/json:
584584
schema:
585-
$ref: '#/components/schemas/Resource_data'
585+
$ref: '#/components/schemas/Resource'
586586
example:
587587
apiVersion: '1.0'
588588
resource:
@@ -705,7 +705,7 @@ paths:
705705
content:
706706
application/json:
707707
schema:
708-
$ref: '#/components/schemas/Resource_list'
708+
$ref: '#/components/schemas/ResourceList'
709709
example:
710710
apiVersion: '1.0'
711711
resources:
@@ -733,7 +733,7 @@ paths:
733733
content:
734734
application/json:
735735
schema:
736-
$ref: '#/components/schemas/Error_list'
736+
$ref: '#/components/schemas/ErrorResponse'
737737
example:
738738
apiVersion: '1.0'
739739
errors:
@@ -764,14 +764,14 @@ components:
764764
type: string
765765
description: API version
766766
errors:
767-
$ref: '#/components/schemas/Error_data'
767+
$ref: '#/components/schemas/ErrorData'
768768
status:
769769
type: string
770770
description: Status message
771771
status_code:
772772
type: integer
773773
description: Status code
774-
Error_data:
774+
ErrorData:
775775
type: object
776776
description: The response errors
777777
properties:
@@ -830,22 +830,22 @@ components:
830830
message:
831831
description: Error message
832832
type: string
833-
Error_list:
833+
ErrorResponse:
834834
type: object
835835
properties:
836836
apiVersion:
837837
type: string
838838
description: API version
839839
errors:
840-
$ref: '#/components/schemas/Error_list_data'
840+
$ref: '#/components/schemas/ErrorDataList'
841841
status:
842842
type: string
843843
description: Status message
844844
status_code:
845845
type: integer
846846
description: Status code
847847

848-
Error_list_data:
848+
ErrorDataList:
849849
type: array
850850
items:
851851
type: object
@@ -917,21 +917,21 @@ components:
917917
type: string
918918
description: API version
919919
resource:
920-
$ref: '#/components/schemas/Resource_data'
920+
$ref: '#/components/schemas/ResourceData'
921921
status:
922922
type: string
923923
description: Status message
924924
status_code:
925925
type: integer
926926
description: Status code
927927

928-
Category:
928+
CategoriesResponse:
929929
type: object
930930
properties:
931931
apiVersion:
932932
type: string
933933
category:
934-
$ref: '#/components/schemas/Category_data'
934+
$ref: '#/components/schemas/CategoryDataList'
935935
status:
936936
type: string
937937
description: Status message
@@ -940,17 +940,34 @@ components:
940940
description: Status code
941941
total_count:
942942
type: integer
943-
Category_data:
944-
type: array
945-
items:
946-
type: object
947-
properties:
943+
CategoryResponse:
944+
type: object
945+
properties:
946+
apiVersion:
947+
type: string
948+
category:
949+
$ref: '#/components/schemas/CategoryData'
950+
status:
951+
type: string
952+
description: Status message
953+
status_code:
954+
type: integer
955+
description: Status code
956+
total_count:
957+
type: integer
958+
CategoryData:
959+
type: object
960+
properties:
948961
id:
949962
type: integer
950963
description: Category ID
951964
name:
952965
type: string
953966
description: Category name
967+
CategoryDataList:
968+
type: array
969+
items:
970+
$ref: '#/components/schemas/CategoryData'
954971

955972
Language:
956973
type: object
@@ -960,7 +977,7 @@ components:
960977
type: string
961978
description: API version
962979
languages:
963-
$ref: '#/components/schemas/Language_data'
980+
$ref: '#/components/schemas/LanguageData'
964981
status:
965982
type: string
966983
description: Status message
@@ -970,7 +987,7 @@ components:
970987
total_count:
971988
type: integer
972989
description: Total languages retrieved
973-
Language_data:
990+
LanguageData:
974991
type: object
975992
properties:
976993
id:
@@ -1035,7 +1052,7 @@ components:
10351052
type: string
10361053
description: Resource url
10371054

1038-
Resource_data:
1055+
ResourceData:
10391056
type: object
10401057
properties:
10411058
category:
@@ -1076,10 +1093,10 @@ components:
10761093
type: string
10771094
description: Resource url
10781095

1079-
Resource_list:
1096+
ResourceList:
10801097
type: array
10811098
items:
1082-
$ref: '#/components/schemas/Resource_data'
1099+
$ref: '#/components/schemas/ResourceData'
10831100

10841101
SearchResponse:
10851102
type: object
@@ -1090,7 +1107,7 @@ components:
10901107
resources:
10911108
type: array
10921109
items:
1093-
$ref: '#/components/schemas/Resource_data'
1110+
$ref: '#/components/schemas/ResourceData'
10941111
number_of_pages:
10951112
type: integer
10961113
description: Total pages
@@ -1119,7 +1136,7 @@ components:
11191136
resources:
11201137
type: array
11211138
items:
1122-
$ref: '#/components/schemas/Resource_data'
1139+
$ref: '#/components/schemas/ResourceData'
11231140
has_next:
11241141
type: boolean
11251142
description: Additional pages
@@ -1164,14 +1181,14 @@ components:
11641181
type: string
11651182
description: API version
11661183
credentials:
1167-
$ref: '#/components/schemas/ApiKeyResponse_data'
1184+
$ref: '#/components/schemas/ApiKeyResponseData'
11681185
status:
11691186
type: string
11701187
description: Status message
11711188
status_code:
11721189
type: integer
11731190
description: Status code
1174-
ApiKeyResponse_data:
1191+
ApiKeyResponseData:
11751192
type: object
11761193
properties:
11771194
apikey:

poetry.lock

Lines changed: 34 additions & 34 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)