-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_methods.yaml
202 lines (202 loc) · 5.21 KB
/
api_methods.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
swagger: "2.0"
info:
title: Flask RESTful API Documentation
version: "1.0"
paths:
/categories:
get:
summary: Get list of categories
responses:
200:
description: Successful response
post:
summary: Create a new category
parameters:
- in: body
name: category
description: Category data to be created
required: true
schema:
$ref: "#/definitions/CategoryInput"
responses:
201:
description: Category created successfully
404:
description: Admin not found or unauthorized
/categories/{category_id}:
get:
summary: Get category by ID
parameters:
- in: path
name: category_id
description: ID of the category to retrieve
required: true
type: integer
responses:
200:
description: Successful response
404:
description: Category not found
put:
summary: Update a category by ID
parameters:
- in: path
name: category_id
description: ID of the category to update
required: true
type: integer
- in: body
name: category
description: Category data to be updated
required: true
schema:
$ref: "#/definitions/CategoryInput"
responses:
201:
description: Category name changed
404:
description: Category not found or unauthorized
delete:
summary: Delete a category by ID
parameters:
- in: path
name: category_id
description: ID of the category to delete
required: true
type: integer
- in: body
name: credentials
description: Admin credentials for authorization
required: true
schema:
$ref: "#/definitions/Credentials"
responses:
201:
description: Category deleted
404:
description: Category not found or unauthorized
/products:
get:
summary: Get list of products
responses:
200:
description: Successful response
post:
summary: Create a new product
parameters:
- in: body
name: product
description: Product data to be created
required: true
schema:
$ref: "#/definitions/ProductInput"
responses:
201:
description: Product created successfully
404:
description: Admin not found or unauthorized
/products/{product_id}:
get:
summary: Get product by ID
parameters:
- in: path
name: product_id
description: ID of the product to retrieve
required: true
type: integer
responses:
200:
description: Successful response
404:
description: Product not found
put:
summary: Update a product by ID
parameters:
- in: path
name: product_id
description: ID of the product to update
required: true
type: integer
- in: body
name: product
description: Product data to be updated
required: true
schema:
$ref: "#/definitions/ProductInput"
responses:
201:
description: Product updated successfully
404:
description: Product not found or unauthorized
delete:
summary: Delete a product by ID
parameters:
- in: path
name: product_id
description: ID of the product to delete
required: true
type: integer
- in: body
name: credentials
description: Admin credentials for authorization
required: true
schema:
$ref: "#/definitions/Credentials"
responses:
201:
description: Product deleted successfully
404:
description: Product not found or unauthorized
definitions:
CategoryInput:
type: object
properties:
name:
type: string
description: Name of the category
email:
type: string
description: Admin's email
password:
type: string
description: Admin's password
ProductInput:
type: object
properties:
name:
type: string
description: Name of the product
email:
type: string
description: Admin's email
password:
type: string
description: Admin's password
quantity:
type: integer
description: Quantity of the product
price:
type: number
format: float
description: Price of the product
category:
type: string
description: Name of the category
category_id:
type: integer
description: ID of the category
description:
type: string
description: Description of the product
si_unit:
type: string
description: SI unit of the product
Credentials:
type: object
properties:
email:
type: string
description: Admin's email
password:
type: string
description: Admin's password