-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
271 lines (271 loc) · 7.4 KB
/
openapi.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
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
---
openapi: 3.0.3
info:
title: blogger
version: 1.0.0
servers: []
paths:
"/api/v1/auth/user":
post:
summary: authenticate
tags:
- Api::V1::Authentication
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: password
responses:
'200':
description: authenticates a user when the credentials are valid
content:
application/json:
schema:
type: object
properties:
token:
type: string
example:
token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyMzksImV4cCI6MTY0Mjk2NDU4NX0.NPjDoV-e7vtBzUFmz1q1stvjcxJPv6hXbALy5NQ_TLw
'401':
description: fails to authenticate a user when the crentials are invalid
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
user_authentication:
type: string
example:
error:
user_authentication: invalid credentials
"/api/v1/users":
post:
summary: create
tags:
- Api::V1::User
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
user:
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
example:
user:
name: user1
email: [email protected]
password: password
responses:
'201':
description: creates a new user when the request is valid
content:
application/json:
schema:
type: object
properties:
name:
type: string
email:
type: string
example:
name: user1
email: [email protected]
'422':
description: fails when the name is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Name is too short (minimum is 3 characters)
"/api/v1/posts":
post:
summary: create
tags:
- Api::V1::Post
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
post:
type: object
properties:
title:
type: string
content:
type: string
example:
post:
title: Recusandae minima consequatur
content: Recusandae minima consequatur. Expedita sequi blanditiis.
Ut fuga et
responses:
'201':
description: creates a new post when the request is valid
content:
application/json:
schema:
type: object
properties:
title:
type: string
content:
type: string
author:
type: string
example:
title: Recusandae minima consequatur
content: Recusandae minima consequatur. Expedita sequi blanditiis.
Ut fuga et
author: user1
'401':
description: fails when the token is not present
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Not Authorized
'422':
description: fails when the title is not present
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Title can't be blank
get:
summary: index
tags:
- Api::V1::Post
responses:
'200':
description: retrives first 10 posts
content:
application/json:
schema:
type: object
properties:
posts:
type: array
items:
nullable: true
type: object
properties:
title:
type: string
content:
type: string
author:
type: string
id:
type: integer
example:
posts: []
"/api/v1/posts/{post_id}/comments":
post:
summary: create
tags:
- Api::V1::Comment
parameters:
- name: post_id
in: path
required: true
schema:
type: integer
example: 40ß
- name: post_id
in: path
required: true
schema:
type: integer
example: 84
- name: post_id
in: path
required: true
schema:
type: integer
example: 85
- name: post_id
in: path
required: true
schema:
type: integer
example: 92
- name: post_id
in: path
required: true
schema:
type: integer
example: 93
responses:
'401':
description: creates a new comment when the request is valid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example:
error: Not Authorized
'201':
description: creates a new comment when the request is valid
content:
application/json:
schema:
type: object
properties:
description:
type: string
user:
type: string
example:
description: Recusandae minima consequatur
user: user1
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
comment:
type: object
properties:
description:
type: string
example:
comment:
description: Recusandae minima consequatur