backend/api/settings/documentation/1.0.0/settings.json (view raw)
1{
2 "paths": {
3 "/settings": {
4 "get": {
5 "deprecated": false,
6 "description": "Find all the settings's records",
7 "responses": {
8 "200": {
9 "description": "Retrieve settings document(s)",
10 "content": {
11 "application/json": {
12 "schema": {
13 "type": "array",
14 "items": {
15 "$ref": "#/components/schemas/Settings"
16 }
17 }
18 }
19 }
20 },
21 "403": {
22 "description": "Forbidden",
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/Error"
27 }
28 }
29 }
30 },
31 "404": {
32 "description": "Not found",
33 "content": {
34 "application/json": {
35 "schema": {
36 "$ref": "#/components/schemas/Error"
37 }
38 }
39 }
40 },
41 "default": {
42 "description": "unexpected error",
43 "content": {
44 "application/json": {
45 "schema": {
46 "$ref": "#/components/schemas/Error"
47 }
48 }
49 }
50 }
51 },
52 "summary": "",
53 "tags": [
54 "Settings"
55 ],
56 "parameters": [
57 {
58 "name": "_limit",
59 "in": "query",
60 "required": false,
61 "description": "Maximum number of results possible",
62 "schema": {
63 "type": "integer"
64 },
65 "deprecated": false
66 },
67 {
68 "name": "_sort",
69 "in": "query",
70 "required": false,
71 "description": "Sort according to a specific field.",
72 "schema": {
73 "type": "string"
74 },
75 "deprecated": false
76 },
77 {
78 "name": "_start",
79 "in": "query",
80 "required": false,
81 "description": "Skip a specific number of entries (especially useful for pagination)",
82 "schema": {
83 "type": "integer"
84 },
85 "deprecated": false
86 },
87 {
88 "name": "=",
89 "in": "query",
90 "required": false,
91 "description": "Get entries that matches exactly your input",
92 "schema": {
93 "type": "string"
94 },
95 "deprecated": false
96 },
97 {
98 "name": "_ne",
99 "in": "query",
100 "required": false,
101 "description": "Get records that are not equals to something",
102 "schema": {
103 "type": "string"
104 },
105 "deprecated": false
106 },
107 {
108 "name": "_lt",
109 "in": "query",
110 "required": false,
111 "description": "Get record that are lower than a value",
112 "schema": {
113 "type": "string"
114 },
115 "deprecated": false
116 },
117 {
118 "name": "_lte",
119 "in": "query",
120 "required": false,
121 "description": "Get records that are lower than or equal to a value",
122 "schema": {
123 "type": "string"
124 },
125 "deprecated": false
126 },
127 {
128 "name": "_gt",
129 "in": "query",
130 "required": false,
131 "description": "Get records that are greater than a value",
132 "schema": {
133 "type": "string"
134 },
135 "deprecated": false
136 },
137 {
138 "name": "_gte",
139 "in": "query",
140 "required": false,
141 "description": "Get records that are greater than or equal a value",
142 "schema": {
143 "type": "string"
144 },
145 "deprecated": false
146 },
147 {
148 "name": "_contains",
149 "in": "query",
150 "required": false,
151 "description": "Get records that contains a value",
152 "schema": {
153 "type": "string"
154 },
155 "deprecated": false
156 },
157 {
158 "name": "_containss",
159 "in": "query",
160 "required": false,
161 "description": "Get records that contains (case sensitive) a value",
162 "schema": {
163 "type": "string"
164 },
165 "deprecated": false
166 },
167 {
168 "name": "_in",
169 "in": "query",
170 "required": false,
171 "description": "Get records that matches any value in the array of values",
172 "schema": {
173 "type": "array",
174 "items": {
175 "type": "string"
176 }
177 },
178 "deprecated": false
179 },
180 {
181 "name": "_nin",
182 "in": "query",
183 "required": false,
184 "description": "Get records that doesn't match any value in the array of values",
185 "schema": {
186 "type": "array",
187 "items": {
188 "type": "string"
189 }
190 },
191 "deprecated": false
192 }
193 ]
194 },
195 "put": {
196 "deprecated": false,
197 "description": "Update a single settings record",
198 "responses": {
199 "200": {
200 "description": "Retrieve settings document(s)",
201 "content": {
202 "application/json": {
203 "schema": {
204 "$ref": "#/components/schemas/Settings"
205 }
206 }
207 }
208 },
209 "403": {
210 "description": "Forbidden",
211 "content": {
212 "application/json": {
213 "schema": {
214 "$ref": "#/components/schemas/Error"
215 }
216 }
217 }
218 },
219 "404": {
220 "description": "Not found",
221 "content": {
222 "application/json": {
223 "schema": {
224 "$ref": "#/components/schemas/Error"
225 }
226 }
227 }
228 },
229 "default": {
230 "description": "unexpected error",
231 "content": {
232 "application/json": {
233 "schema": {
234 "$ref": "#/components/schemas/Error"
235 }
236 }
237 }
238 }
239 },
240 "summary": "",
241 "tags": [
242 "Settings"
243 ],
244 "requestBody": {
245 "description": "",
246 "required": true,
247 "content": {
248 "application/json": {
249 "schema": {
250 "$ref": "#/components/schemas/NewSettings"
251 }
252 }
253 }
254 },
255 "parameters": []
256 },
257 "delete": {
258 "deprecated": false,
259 "description": "Delete a single settings record",
260 "responses": {
261 "200": {
262 "description": "deletes a single settings based on the ID supplied",
263 "content": {
264 "application/json": {
265 "schema": {
266 "type": "integer",
267 "format": "int64"
268 }
269 }
270 }
271 },
272 "403": {
273 "description": "Forbidden",
274 "content": {
275 "application/json": {
276 "schema": {
277 "$ref": "#/components/schemas/Error"
278 }
279 }
280 }
281 },
282 "404": {
283 "description": "Not found",
284 "content": {
285 "application/json": {
286 "schema": {
287 "$ref": "#/components/schemas/Error"
288 }
289 }
290 }
291 },
292 "default": {
293 "description": "unexpected error",
294 "content": {
295 "application/json": {
296 "schema": {
297 "$ref": "#/components/schemas/Error"
298 }
299 }
300 }
301 }
302 },
303 "summary": "",
304 "tags": [
305 "Settings"
306 ],
307 "parameters": []
308 }
309 }
310 },
311 "components": {
312 "schemas": {
313 "Settings": {
314 "required": [
315 "id"
316 ],
317 "properties": {
318 "id": {
319 "type": "string"
320 },
321 "gtm_id": {
322 "type": "string"
323 },
324 "about_link": {
325 "type": "string"
326 }
327 }
328 },
329 "NewSettings": {
330 "properties": {
331 "gtm_id": {
332 "type": "string"
333 },
334 "about_link": {
335 "type": "string"
336 }
337 }
338 }
339 }
340 },
341 "tags": [
342 {
343 "name": "Settings"
344 }
345 ]
346}