This repository has been archived by the owner on Jul 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
/
swagger.json.php
206 lines (205 loc) · 4.66 KB
/
swagger.json.php
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
<?php header('Content-Type: application/json') ?>{
"swagger": "2.0",
"info": {
"title": "Todo App API",
"description": "Example Todo Application API",
"version": "1.0.0",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host": "<?php echo $_SERVER['HTTP_HOST'] ?>",
"basePath": "/api",
"schemes": [
"http",
"https"
],
"paths": {
"/": {
"get": {
"tags": [
"tasks",
"fetching"
],
"summary": "List all tasks",
"description": "Fetches all tasks from the database",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "All is good",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Task"
}
}
}
}
},
"post": {
"tags": [
"tasks",
"creating"
],
"summary": "Create new task",
"description": "Stores new task in the database",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Task to create",
"required": true,
"schema": {
"$ref": "#/definitions/Task"
}
}
],
"responses": {
"201": {
"description": "All is good",
"schema": {
"$ref": "#/definitions/Task"
}
}
}
}
},
"/{id}": {
"get": {
"tags": [
"tasks",
"fetching"
],
"summary": "Fetch task",
"description": "Fetches task by given identifier",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"type": "integer",
"format": "int64",
"description": "Task identifier",
"required": true
}
],
"responses": {
"200": {
"description": "All is good",
"schema": {
"$ref": "#/definitions/Task"
}
},
"404": {
"description": "No task with provided identifier found"
}
}
},
"put": {
"tags": [
"tasks",
"updating"
],
"summary": "Update task",
"description": "Updates task by given identifier",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"type": "integer",
"format": "int64",
"description": "Task identifier",
"required": true
},
{
"in": "body",
"name": "body",
"description": "Task with updates",
"required": true,
"schema": {
"$ref": "#/definitions/Task"
}
}
],
"responses": {
"200": {
"description": "All is good",
"schema": {
"$ref": "#/definitions/Task"
}
}
}
},
"delete": {
"tags": [
"tasks",
"destruction"
],
"summary": "Delete task",
"description": "Deletes task by given identifier",
"parameters": [
{
"in": "path",
"name": "id",
"type": "integer",
"format": "int64",
"description": "Task identifier to delete",
"required": true
}
],
"responses": {
"204": {
"description": "Task deleted"
}
}
}
}
},
"securityDefinitions": {
"username_password": {
"type": "basic"
}
},
"definitions": {
"Task": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"title": "Task ID",
"description": "Unique task identifier"
},
"task": {
"type": "string",
"title": "The task",
"description": "Task line"
},
"completed": {
"type": "integer",
"title": "Task completition status",
"description": "0 - ongoing, 1 - completed",
"minimum": 0,
"maximum": 1
}
}
}
}
}