forked from personio/backend-coding-challenge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
171 lines (166 loc) · 3.61 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
openapi: "3.0.0"
info:
title: Reminders Service
version: 0.1.0
tags:
- name: Settings
- name: Occurrences
paths:
/reminders:
get:
summary: retrieve all reminders settings
tags:
- Settings
parameters:
- name: employeeId
in: query
schema:
type: string
format: uuid
required: true
responses:
200:
description: Ok
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/ReminderResponse"
post:
summary: create a reminder
tags:
- Settings
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateReminderRequest"
responses:
201:
description: Ok
/reminders/{id}:
delete:
summary: deletes a specific reminder settings
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: id of the reminder
schema:
type: string
format: uuid
responses:
204:
description: Ok
/occurrences:
get:
summary: retrieve all open occurrences
tags:
- Occurrences
parameters:
- name: employeeId
in: query
schema:
type: string
format: uuid
required: true
responses:
200:
description: Ok
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: "#/components/schemas/OccurrenceResponse"
/occurrences/{id}:
put:
summary: acknowledge an occurrence
tags:
- Occurrences
parameters:
- name: id
in: path
required: true
description: id of the occurrence
schema:
type: string
format: uuid
responses:
204:
description: Ok
components:
schemas:
ReminderResponse:
type: object
required:
- id
- text
- date
- recurring
properties:
id:
type: string
text:
type: string
date:
type: string
format: datetime
recurring:
type: boolean
recurrence_interval:
type: integer
recurrence_frequency:
type: integer
CreateReminderRequest:
type: object
required:
- employee_id
- text
- date
- is_recurring
properties:
employee_id:
type: string
format: uuid
text:
type: string
date:
type: string
format: datetime
is_recurring:
type: boolean
recurrence_interval:
type: integer
recurrence_frequency:
type: integer
description: 1 = daily, 2 = weekly, 3 = monthly, 4 = yearly
OccurrenceResponse:
type: object
required:
- id
- reminder_id
- text
- date
properties:
id:
type: string
format: uuid
reminder_id:
type: string
format: uuid
text:
type: string
date:
type: string
format: datetime