/
survey.raml
168 lines (165 loc) · 3.67 KB
/
survey.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
#%RAML 0.8
title: Survey Api
baseUri: localhost
mediaType: application/json
protocols:
- HTTP
version: 1.0.0
schemas:
- LoginParams: !include schemas/LoginParam.schema.json
- ErrorMessage: !include schemas/ErrorMessage.schema.json
- LoginResponse: !include schemas/LoginResponse.schema.json
- UserResponse: !include schemas/UserResponse.schema.json
- Surveys: !include schemas/Surveys.schema.json
- Survey: !include schemas/Survey.schema.json
- PutSurvey: !include schemas/PutSurvey.schema.json
/authentication:
post:
body:
schema: LoginParams
responses:
200:
body:
schema: LoginResponse
400:
body:
schema: ErrorMessage
get:
headers:
Authentication:
type: string
required: true
responses:
200:
body:
schema: LoginResponse
401:
delete:
responses:
204:
/users:
post:
description: Register
body:
schema: |
{
"type": "object",
"properties": {
"username": { "type": "string" },
"email": { "type": "string" },
"password": { "type": "string" }
}
}
responses:
201:
body:
schema: UserResponse
400:
body:
schema: ErrorMessage
/{userId}:
get:
description: Get user info
headers:
Authentication:
type: string
required: true
responses:
200:
body:
schema: UserResponse
404:
/surveys:
post:
headers:
Authentication:
type: string
required: true
description: Create new survey
body:
schema: |
{
"type": "object",
"properties": {
"title": { "type": "string" },
"subTitle": { "type": "string" },
"questions": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
responses:
201:
400:
403:
description: user not currentUser
get:
description: Get user's surveys
headers:
Authentication:
type: string
required: true
responses:
200:
body:
schema: Surveys
403:
description: user not currentUser
/surveys:
/{surveyId}:
get:
description: Get survey info
responses:
200:
body:
schema: Survey
404:
description: false survey.receiveResults and currentUser not survey.author
put:
headers:
Authentication:
type: string
required: true
description: Update survey info
body:
schema: PutSurvey
responses:
204:
404:
/results:
get:
description: Get all survey results
responses:
200:
body:
schema: |
{
"type": "array",
"items": {
"type": "object"
}
}
403:
description: false surveyPublishResults and survey.author not currentUser
post:
description: Fill survey
body:
schema: |
{
"type": "object"
}
responses:
201:
400:
/{resultId}:
delete:
headers:
Authentication:
type: string
required: true
responses:
204:
404: