This repository was archived by the owner on Oct 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtypes.raml
177 lines (166 loc) · 3.35 KB
/
types.raml
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
#%RAML 1.0
Email:
type: string
minLength: 1
pattern: ^.+@.+\..+$
User:
type: object
properties:
id: integer
email: Email
firstName:
type: string
minLength: 1
lastName:
type: string
minLength: 1
emailVerified: boolean
disabled: boolean
absent: boolean
EmailRegistration:
type: object
properties:
email: Email
firstName:
type: string
minLength: 1
lastName:
type: string
minLength: 1
password:
type: string
minLength: 1
absent: boolean
InvitationRegistration:
type: object
properties:
firstName:
type: string
minLength: 1
lastName:
type: string
minLength: 1
password:
type: string
minLength: 1
invitationCode:
type: string
minLength: 16
maxLength: 16
absent: boolean
LoginCredentials:
type: object
properties:
email: Email
password:
type: string
minLength: 1
TokenResponse:
type: object
properties:
token:
type: string
pattern: ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$
description: JWT token
tokenId:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 20
maxLength: 20
description: JWT ID (jti)
validFor:
type: integer
minimum: 1
description: |
Validity duration in seconds (excluding server-side grace period)
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
minLength: 1
message: string
Turn:
type: object
properties:
userId: integer
startDate:
type: datetime
format: rfc3339
RequestTask:
type: object
properties:
title:
type: string
minLength: 1
description:
type: string
minLength: 1
frequency:
type: integer
minimum: 1
description: |
Number of days between two executions of this task
completionTime:
type: integer
minimum: 1
description: |
Time to be allowed for the task to be completed in hours
users:
type: integer[]
minItems: 1
description: |
All users that will have to complete this task at one point or another
Task:
type: object
properties:
id: integer
title:
type: string
minLength: 1
description:
type: string
minLength: 1
frequency:
type: integer
minimum: 1
description: |
Number of days between two executions of this task
completionTime:
type: integer
minimum: 1
description: |
Time to be allowed for the task to be completed in hours
users:
type: integer[]
minItems: 1
description: |
All users that will have to complete this task at one point or another.
currentTurn:
type: Turn | nil
upcomingTurns:
type: Turn[]
Info:
type: object
properties:
version:
type: string
example: "v0.1"
pattern: ^v\d+(\.\d){1,2}$
description: Version of the server
currentTime:
type: string
example: "2018-02-12T15:41:42.799328781Z"
description: Current time of the server
name:
type: string
example: "core"
description: Name of the implementation of the server
Invitation:
type: object
properties:
id: integer
email: Email