-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.json
257 lines (257 loc) · 9.33 KB
/
openapi.json
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
{
"openapi": "3.0.2",
"info": {
"title": "Mtaa API Documentation",
"version": "1.0",
"description": "Mtaa A simple REST API to access Tanzania's location information,With mtaa API you can easily query and integrate all the location in tanzania from region level to streets from your programming language of your your choice",
"contact": {
"name": "Mtaa API",
"url": "https://github.com/HackEAC/mtaaAPI",
"email": "[email protected]"
},
"license": {
"name": "MIT License",
"url": "https://github.com/HackEAC/mtaaAPI/blob/main/LICENSE"
}
},
"servers": [
{
"url": "https://mtaa-api.herokuapp.com/api",
"description": "Production Server"
}
],
"paths": {
"/{country}": {
"get": {
"tags": [
"Tanzania regions"
],
"summary": "Returns all regions present in Tanzania",
"description": "Fetches all regions present in Tanzania and then return a response as json",
"operationId": "Tanzania-regions",
"parameters": [
{
"name": "country",
"in": "path",
"description": "Country name in lowercase eg (Tanzania)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response"
}
}
}
},
"/{country}/{region}": {
"get": {
"tags": [
"Districts in region"
],
"summary": "Returns all districts in region",
"description": "Returns a post code and all districts in a specified region",
"operationId": "Districts-in-a-region",
"parameters": [
{
"name": "country",
"in": "path",
"description": "Country name in lowercase eg( tanzania)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "path",
"description": "Name of the region eg (Mbeya)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response"
},
"404": {
"description": "Resource not Found"
}
}
}
},
"/{country}/{region}/{district}": {
"get": {
"tags": [
"Wards in a district"
],
"summary": "Returns all wards in a district",
"description": "Returns all wards in a specified district and district postcode",
"operationId": "Wards-in-a-district",
"parameters": [
{
"name": "country",
"in": "path",
"description": "Country name in lowercase eg( tanzania)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "path",
"description": "Name of the region eg (Mbeya)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "district",
"in": "path",
"description": "Name of the District eg (Rungwe)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response"
},
"404": {
"description": "Resource not Found"
}
}
}
},
"/{country}/{region}/{district}/{ward}": {
"get": {
"tags": [
"Streets in a ward"
],
"summary": "Returns all streets in a ward",
"description": "Returns all streets in a specified ward and ward postcode",
"operationId": "streets-in-a-ward",
"parameters": [
{
"name": "country",
"in": "path",
"description": "Country name in lowercase eg( tanzania)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "path",
"description": "Name of the region eg (Mbeya)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "district",
"in": "path",
"description": "Name of the District eg (Rungwe)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ward",
"in": "path",
"description": "Name of the Ward eg (Kiwira)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response"
},
"404": {
"description": "Resource not Found"
}
}
}
},
"/{country}/{region}/{district}/{ward}/{street}": {
"get": {
"tags": [
"neighborhood in a street"
],
"summary": "Returns all neighborhood in a street",
"description": "Returns all neighborhood in a specified street",
"operationId": "neighborhood-in-a-street-",
"parameters": [
{
"name": "country",
"in": "path",
"description": "Country name in lowercase eg( tanzania)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "path",
"description": "Name of the region eg (Mbeya)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "district",
"in": "path",
"description": "Name of the District eg (Rungwe)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ward",
"in": "path",
"description": "Name of the Ward eg (Kiwira)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "street",
"in": "path",
"description": "Name of the Street eg (Ilundo)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response"
},
"404": {
"description": "Resource not Found"
}
}
}
}
}
}