-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
executable file
·229 lines (229 loc) · 5.32 KB
/
swagger.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
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
---
swagger: "2.0"
info:
description: ""
version: "0.0.1"
title: "API"
host: "localhost:5050"
basePath: "/"
schemes:
- "http"
paths:
/v1/auth/signup:
post:
tags:
- user
summary: Create new user
description: ""
operationId: "Create User"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/json"
parameters:
- name: "UserName"
in: "formData"
description: "User name"
required: true
type: "string"
- name: "Email"
in: "formData"
description: "User email"
required: true
type: "string"
- name: "Password"
in: "formData"
description: "User password"
required: true
type: "string"
responses:
'201':
description: "successful operation"
schema:
$ref: '#/definitions/User'
'302':
description: "User already exist"
/v1/auth/signin:
post:
tags:
- user
summary: Sing in
description: "Get a token"
operationId: "Sing in"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/json"
parameters:
- name: "Email"
in: "formData"
description: "User email"
required: true
type: "string"
- name: "Password"
in: "formData"
description: "User password"
required: true
type: "string"
responses:
'200':
description: "successful operation"
schema:
$ref: '#/definitions/User'
/v1/users/{userId}:
get:
tags:
- "user"
summary: "Find user by ID"
description: "This can only be done by the logged in user."
operationId: "getUserById"
produces:
- "application/json"
parameters:
- name: "userId"
in: "path"
description: "ID of user to return"
required: true
type: "integer"
format: "uint"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/User"
400:
description: "Invalid ID supplied"
404:
description: "User not found"
security:
- api_key: []
/v1/weather:
get:
tags:
- "weather"
summary: "Find by city name weather"
description: "This can only be done by the logged in user."
operationId: "getWeathers"
produces:
- "application/json"
parameters:
- in: query
name: city
type: string
required: true
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Weather"
404:
description: "Weather not found"
security:
- api_key: []
/v1/weather/monitor:
get:
tags:
- "weather"
summary: "Find all weather by User"
description: "This can only be done by the logged in user."
operationId: "getWeatherByUser"
produces:
- "application/json"
responses:
202:
description: "successful operation"
schema:
$ref: "#/definitions/Weather"
404:
description: "Weather not found"
security:
- api_key: []
/v1/weather/monitor/{cityName}:
put:
tags:
- "weather"
summary: "Add city"
description: "This can only be done by the logged in user."
operationId: "putCityByName"
produces:
- "application/json"
parameters:
- name: "cityName"
in: "path"
required: true
type: "string"
responses:
201:
description: "successful operation"
schema:
$ref: "#/definitions/Weather"
400:
description: "Invalid ID supplied"
404:
description: "City not found"
security:
- api_key: []
/v1/weather/monitor/cities/{cityName}:
delete:
tags:
- "weather"
summary: "Delete city"
description: "This can only be done by the logged in user."
operationId: "deleteWeather"
produces:
- "application/json"
parameters:
- name: "cityName"
in: "path"
description: "The name that needs to be deleted"
required: true
type: "string"
responses:
202:
description: "successful operation"
400:
description: "Invalid city name supplied"
404:
description: "City not found"
security:
- api_key: []
securityDefinitions:
api_key:
type: "apiKey"
name: "Authorization"
in: "header"
definitions:
User:
type: "object"
required:
- "id"
- "user_name"
- "email"
- "password"
properties:
id:
type: integer
format: uint
user_name:
type: string
email:
type: string
Weather:
type: "object"
required:
- "id"
properties:
id:
type: integer
format: uint
city_name:
type: string
temp_max:
type: number
format: float64
temp:
type: number
format: float64
temp_min:
type: number
format: float64