Mercurial > gemma

comparison api/server/swagger.yaml @ 169:9fcfccb18b16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
feat: Added draft version of API specification for server Open API specification available under /api/server UI version served with yarn swagger from client folder - port 5000
author Thomas Junk <thomas.junk@intevation.de>
date Tue, 10 Jul 2018 10:36:50 +0200
parents
children 9f1b84b712a8
comparison
equal deleted inserted replaced
168:e4e4a0e6338e 169:9fcfccb18b16
1 openapi: 3.0.0
2 info:
3 version: 1.0.0
4 title: Gemma
5 description: API draft of gemma backend
6 servers:
7 - url: http://localhost:8000
8 tags:
9 - name: users
10 description: User related stuff
11 - name: auth
12 description: Login logout
13 - name: health
14 description: Everything considered health
15 - name: management
16 description: Everything about management
17 - name: templates
18 description: Everything about templates
19 paths:
20 /users:
21 get:
22 summary: Get list of users
23 responses:
24 '200':
25 description: Success response
26 tags:
27 - users
28 post:
29 summary: Create a new user
30 responses:
31 '200':
32 description: Success response
33 tags:
34 - users
35 /users/{id}:
36 get:
37 summary: Get user with id
38 parameters:
39 - in: path
40 name: id
41 schema:
42 type: integer
43 required: true
44 responses:
45 '200':
46 description: Success response
47 tags:
48 - users
49 put:
50 summary: Update user with id
51 parameters:
52 - in: path
53 name: id
54 schema:
55 type: integer
56 required: true
57 responses:
58 '200':
59 description: Success response
60 tags:
61 - users
62 patch:
63 summary: Partially update user with id
64 parameters:
65 - in: path
66 name: id
67 schema:
68 type: integer
69 required: true
70 responses:
71 '200':
72 description: Success response
73 tags:
74 - users
75 delete:
76 summary: Delete user with id
77 parameters:
78 - in: path
79 name: id
80 schema:
81 type: integer
82 required: true
83 responses:
84 '200':
85 description: Success response
86 tags:
87 - users
88 /users/{id}/passwordreset:
89 post:
90 summary: Reset password for user with id
91 parameters:
92 - in: path
93 name: id
94 schema:
95 type: integer
96 required: true
97 responses:
98 '200':
99 description: Success response
100 tags:
101 - users
102 /login:
103 get:
104 summary: Authenticates user
105 responses:
106 '200':
107 description: Success response
108 tags:
109 - auth
110 /logout:
111 get:
112 summary: Deauthenticates user
113 responses:
114 '200':
115 description: Success response
116 tags:
117 - auth
118 /health/hardware:
119 get:
120 summary: Access hardware logs
121 responses:
122 '200':
123 description: Success response
124 tags:
125 - health
126 /health/system:
127 get:
128 summary: Access sytem eventlogs
129 responses:
130 '200':
131 description: Success response
132 tags:
133 - health
134 /health/access:
135 get:
136 summary: Access the access logs
137 responses:
138 '200':
139 description: Success response
140 tags:
141 - health
142 /health/sendtestmail:
143 post:
144 summary: Send testemail
145 responses:
146 '200':
147 description: Success response
148 tags:
149 - health
150 /management:
151 get:
152 summary: Get the current system settings
153 responses:
154 '200':
155 description: Success response
156 tags:
157 - management
158 put:
159 summary: Update the current system settings
160 responses:
161 '200':
162 description: Success response
163 tags:
164 - management
165 patch:
166 summary: Partially update the current system settings
167 responses:
168 '200':
169 description: Success response
170 tags:
171 - management
172 /templates:
173 get:
174 summary: Get the templates
175 responses:
176 '200':
177 description: Success response
178 tags:
179 - templates
180 post:
181 summary: Create template
182 responses:
183 '200':
184 description: Success response
185 tags:
186 - templates
187 /templates/{id}:
188 get:
189 summary: Get template with id
190 parameters:
191 - in: path
192 name: id
193 schema:
194 type: integer
195 required: true
196 responses:
197 '200':
198 description: Success response
199 tags:
200 - templates
201 put:
202 summary: Update template with id
203 parameters:
204 - in: path
205 name: id
206 schema:
207 type: integer
208 required: true
209 responses:
210 '200':
211 description: Success response
212 tags:
213 - templates
214 patch:
215 summary: Partially update template with id
216 parameters:
217 - in: path
218 name: id
219 schema:
220 type: integer
221 required: true
222 responses:
223 '200':
224 description: Success response
225 tags:
226 - templates
227 delete:
228 summary: Delete template with id
229 parameters:
230 - in: path
231 name: id
232 schema:
233 type: integer
234 required: true
235 responses:
236 '200':
237 description: Success response
238 tags:
239 - templates
240 /maps:
241 get:
242 summary: Everything about maps
243 responses:
244 '200':
245 description: Success response
246 /search:
247 get:
248 summary: Search
249 responses:
250 '200':
251 description: Success response
252 /bottlenecks:
253 get:
254 summary: Search
255 responses:
256 '200':
257 description: Success response