-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
225 lines (222 loc) · 4.53 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
openapi: 3.0.0
info:
title: Jobs-API
contact: {}
version: '1.0'
servers:
- url: https://boiling-basin-92730.herokuapp.com/api/v1
variables: {}
paths:
/auth/register:
post:
tags:
- Auth
summary: Register User
operationId: RegisterUser
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterUserRequest'
example:
name: peter
email: peter@gmail.com
password: secret
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/auth/login:
post:
tags:
- Auth
summary: Login User
operationId: LoginUser
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LoginUserRequest'
example:
email: peter@gmail.com
password: secret
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security: []
/jobs:
post:
tags:
- Jobs
summary: Create A Job
operationId: CreateAJob
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAJobRequest'
example:
company: amazon
position: sde peter
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security:
- bearer: []
get:
tags:
- Jobs
summary: Get All Jobs
operationId: GetAllJobs
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security:
- bearer: []
/jobs/{id}:
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The job ID
get:
tags:
- Jobs
summary: Get A Job
operationId: GetAJob
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security:
- bearer: []
patch:
tags:
- Jobs
summary: Update Job
operationId: UpdateJob
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJobRequest'
example:
company: netflix
position: full stack
required: true
responses:
'200':
description: ''
headers: {}
deprecated: false
security:
- bearer: []
delete:
tags:
- Jobs
summary: Delete A Job
operationId: DeleteAJob
parameters: []
responses:
'200':
description: ''
headers: {}
deprecated: false
security:
- bearer: []
components:
schemas:
LoginUserRequest:
title: LoginUserRequest
required:
- email
- password
type: object
properties:
email:
type: string
password:
type: string
example:
email: peter@gmail.com
password: secret
RegisterUserRequest:
title: RegisterUserRequest
required:
- name
- email
- password
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
example:
name: peter
email: peter@gmail.com
password: secret
CreateAJobRequest:
title: CreateAJobRequest
required:
- company
- position
type: object
properties:
company:
type: string
position:
type: string
example:
company: amazon
position: sde peter
UpdateJobRequest:
title: UpdateJobRequest
required:
- company
- position
type: object
properties:
company:
type: string
position:
type: string
example:
company: netflix
position: full stack
securitySchemes:
bearer:
type: http
scheme: bearer
security: []
tags:
- name: Auth
description: ''
- name: Jobs
description: ''