Mercurial > gemma

annotate api/server/swagger.yaml @ 170:9f1b84b712a8

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