/
swagger_new.yaml
227 lines (225 loc) · 7 KB
/
swagger_new.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
swagger: '2.0'
info:
title: restify_waterline_scaffold API
description: Simple user+auth scaffold using Waterline, Restify and Redis
version: "1.0.0"
schemes:
- http
- https
basePath: /api
produces:
- application/json
paths:
/user:
get:
summary: Retrieve user data
parameters:
- name: X-Access-Token
in: header
description: Valid Access Token from which user can be found at
required: true
type: string
#$ref: '#/definitions/AccessToken'
responses:
200:
description: User associated with that access token
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
post:
summary: Create user
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
201:
description: Created user
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
put:
summary: Update user
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
200:
description: Updated user
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
delete:
summary: Delete user
parameters:
- name: X-Access-Token
in: header
description: Valid Access Token from which user can be found at
required: true
type: string
responses:
204:
description: User associated with that access token
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/auth:
post:
summary: Login user
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
201:
description: Created user
schema:
$ref: '#/definitions/Token'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
delete:
summary: Logout user
parameters:
- name: X-Access-Token
in: header
description: Valid Access Token from which user can be found at
required: true
type: string
responses:
204:
description: User associated with that access token
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/message/{to}:
parameters:
- in: path
name: to
description: Author to communicate with
required: true
type: string
get:
summary: Retrieve message thread
parameters:
- name: X-Access-Token
in: header
description: Valid Access Token from which user can be found at
required: true
type: string
#$ref: '#/definitions/AccessToken'
responses:
200:
description: Message thread
schema:
$ref: '#/definitions/Post'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
post:
summary: Send message
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
201:
description: Created user
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/message/{to}/{uuid}:
parameters:
- in: path
name: to
description: Author to communicate with
required: true
type: string
- in: path
name: uuid
description: uuid of message
required: true
type: string
put:
summary: Update message
responses:
200:
description: Updated message thread
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
delete:
summary: Delete message
responses:
200:
description: Updated message thread
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
definitions:
User:
type: object
properties:
email:
type: string
password:
type: string
title:
type: string
required:
- email
- password
Post:
type: object
properties:
uuid:
type: string
message:
type: string
datetime:
type: date
author:
type: string
Token:
type: object
properties:
access_token:
type: string
required:
- access_token
Error:
type: object
properties:
error:
type: string
error_message:
type: string