Mercurial > gemma

annotate 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
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:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
31 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
32 description: Success response
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
35 /users/{id}:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
36 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
37 summary: Get user with id
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
40 name: id
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:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
50 summary: Update user with id
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
53 name: id
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:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
63 summary: Partially update user with id
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
66 name: id
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:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
76 summary: Delete user with id
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
79 name: id
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
88 /users/{id}/passwordreset:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
89 post:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
90 summary: Reset password for user with id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
91 parameters:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
92 - in: path
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
93 name: id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
94 schema:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
95 type: integer
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
96 required: true
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
97 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
98 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
99 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
100 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
101 - users
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
102 /login:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
103 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
104 summary: Authenticates user
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
105 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
106 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
107 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
108 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
109 - auth
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
110 /logout:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
111 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
112 summary: Deauthenticates user
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
113 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
114 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
115 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
116 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
117 - auth
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
118 /health/hardware:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
119 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
120 summary: Access hardware logs
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
121 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
122 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
123 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
124 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
125 - health
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
126 /health/system:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
127 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
128 summary: Access sytem eventlogs
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
129 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
130 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
131 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
132 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
133 - health
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
134 /health/access:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
135 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
136 summary: Access the access logs
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
137 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
138 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
139 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
140 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
141 - health
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
142 /health/sendtestmail:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
143 post:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
144 summary: Send testemail
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
145 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
146 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
147 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
148 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
149 - health
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
150 /management:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
151 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
152 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
153 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
154 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
155 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
156 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
157 - management
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
158 put:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
159 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
160 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
161 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
162 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
163 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
164 - management
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
165 patch:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
166 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
167 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
168 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
169 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
170 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
171 - management
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
172 /templates:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
173 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
174 summary: Get the templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
175 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
176 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
177 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
178 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
179 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
180 post:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
181 summary: Create template
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
182 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
183 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
184 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
185 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
186 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
187 /templates/{id}:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
188 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
189 summary: Get template with id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
190 parameters:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
191 - in: path
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
192 name: id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
193 schema:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
194 type: integer
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
195 required: true
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
196 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
197 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
198 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
199 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
200 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
201 put:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
202 summary: Update template with id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
203 parameters:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
204 - in: path
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
205 name: id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
206 schema:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
207 type: integer
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
208 required: true
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
209 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
210 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
211 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
212 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
213 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
214 patch:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
215 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
216 parameters:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
217 - in: path
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
218 name: id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
219 schema:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
220 type: integer
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
221 required: true
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
222 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
223 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
224 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
225 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
226 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
227 delete:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
228 summary: Delete template with id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
229 parameters:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
230 - in: path
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
231 name: id
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
232 schema:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
233 type: integer
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
234 required: true
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
235 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
236 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
237 description: Success response
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
238 tags:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
239 - templates
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
240 /maps:
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: Everything about maps
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 /search:
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
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
252 /bottlenecks:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
253 get:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
254 summary: Search
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
255 responses:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
256 '200':
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
257 description: Success response