-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.api
168 lines (162 loc) · 4.29 KB
/
swagger.api
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
openapi: 3.0.3
info:
title: Swagger Folder Store - OpenAPI 3.0
description: |-
This is a Test API
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.11
servers:
- url: http://88.80.185.224:5000/api/v1/
paths:
/folders:
put:
summary: Update an existing folder
description: Update an existing folder by Id
requestBody:
description: Update an existent folder in the store
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: Invalid ID supplied
'404':
description: Folder not found
'405':
description: Validation exception
post:
summary: Add a new Folder to the store
description: Add a new Folder to the store
requestBody:
description: Create a new folder in the store
content:
application/json:
schema:
$ref: '#/components/schemas/FolderCreate'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: Invalid input
get:
summary: Return all folders
description: Returns all Folders, paginated
parameters:
- name: page
in: query
description: Which page of results to fetch
required: true
schema:
type: integer
format: int64
- name: per_page
in: query
description: how many results per page
required: true
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Folder'
'400':
description: Invalid ID supplied
'404':
description: Folder not found
/folders/{folder_id}:
get:
summary: Finds Folder by Id
description: Return a single folder
parameters:
- name: folder_id
in: path
description: Folder Id to filter y
required: true
schema:
type: integer
default: -1
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
'400':
description: Invalid folder id value
delete:
summary: Deletes a Folder
description: delete a Folder
parameters:
- name: folder_id
in: path
description: Folder id to delete
required: true
schema:
type: integer
format: int64
responses:
'400':
description: Invalid folder/endpoint
'404':
description: Cannot find Folder
components:
schemas: Folder:
required:
- folder_name
type: object
properties:
id:
type: integer
format: int64
example: 10
folder_name:
type: string
example: TestDir
FolderCreate:
required:
- folder_name
type: object
properties:
folder_name:
type: string
example: TestDir
ApiResponse:
type: object
properties:
status:
type: object
requestBodies:
Folder:
description: Folder object that needs to be added to the store
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
FolderCreate:
description: Folder object that needs to be added to the store
content:
application/json:
schema:
$ref: '#/components/schemas/FolderCreate'