· 2 years ago · Jul 18, 2023, 04:15 PM
1 "default": null,
2 "schema": {
3 "type": "integer"
4 }
5 },
6 {
7 "in": "query",
8 "name": "toolGroup",
9 "default": null,
10 "schema": {
11 "type": "integer"
12 },
13 "description": "Filter on specific toolType"
14 },
15 {
16 "in": "query",
17 "name": "offset",
18 "default": 0,
19 "schema": {
20 "type": "integer"
21 },
22 "description": "Offset the result by this many records."
23 },
24 {
25 "in": "query",
26 "name": "limit",
27 "default": 10,
28 "schema": {
29 "type": "integer"
30 },
31 "description": "Return this [integer] amount of records."
32 }
33 ],
34 "responses": {
35 "200": {
36 "description": "A successful response"
37 }
38 }
39 },
40 "post": {
41 "tags": [
42 "merchant_workbench_tools"
43 ],
44 "summary": "Create",
45 "requestBody": {
46 "description": "Create new merchant tool entry",
47 "required": true,
48 "content": {
49 "application/json": {
50 "schema": {
51 "type": "object",
52 "properties": {
53 "name": {
54 "type": "string"
55 },
56 "description": {
57 "type": "string"
58 },
59 "toolType": {
60 "type": "number"
61 },
62 "toolGroup": {
63 "type": "number"
64 },
65 "url": {
66 "type": "string"
67 },
68 "img": {
69 "type": "string"
70 }
71 }
72 }
73 }
74 }
75 },
76 "responses": {
77 "201": {
78 "description": "Updated"
79 }
80 }
81 },
82 "components": {
83 "responses": null,
84 "UnauthorizedError": {
85 "description": "API key is missing or invalid",
86 "headers": {
87 "WWW_Authenticate": {
88 "schema": {
89 "type": "string"
90 }
91 }
92 }
93 }
94 },
95 "patch": {
96 "tags": [
97 "merchant_workbench_tools"
98 ],
99 "summary": "Update",
100 "requestBody": {
101 "description": "Update Merchant Workbench Tool",
102 "required": true,
103 "content": {
104 "application/json": {
105 "schema": {
106 "type": "object",
107 "properties": {
108 "toolID": {
109 "type": "integer"
110 },
111 "description": {
112 "type": "string"
113 },
114 "url": {
115 "type": "string"
116 },
117 "img": {
118 "type": "string"
119 }
120 }
121 }
122 }
123 }
124 },
125 "responses": {
126 "201": {
127 "description": "Updated"
128 }
129 }
130 }
131 },
132 "/mma-applications": {
133 "get": {
134 "tags": [
135 "mma_applications"
136 ],
137 "description": "Finds applications descriptions",
138 "summary": "Find",
139 "parameters": [
140 {
141 "in": "query",
142 "name": "application_name",
143 "default": null,
144 "schema": {
145 "type": "string"
146 },
147 "description": "Filter on specific application"
148 }
149 ],
150 "responses": {
151 "200": {
152 "description": "A successful response"
153 }
154 }
155 },
156 "post": {
157 "tags": [
158 "mma_applications"
159 ],
160 "summary": "Create",
161 "requestBody": {
162 "description": "Create a new reusable_api_keys",
163 "required": true,
164 "content": {
165 "application/json": {
166 "schema": {
167 "type": "object",
168 "properties": {
169 "application_name": {
170 "type": "string"
171 },
172 "application_description": {
173 "type": "string"
174 },
175 "mma_resource": {
176 "type": "string"
177 }
178 }
179 }
180 }
181 }
182 },
183 "responses": {
184 "201": {
185 "description": "Created"
186 }
187 }
188 },
189 "patch": {
190 "tags": [
191 "mma_applications"
192 ],
193 "summary": "Update",
194 "requestBody": {
195 "description": "Update reusable_api_keys",
196 "required": true,
197 "content": {
198 "application/json": {
199 "schema": {
200 "type": "object",
201 "properties": {
202 "application_name": {
203 "type": "string"
204 },
205 "application_description": {
206 "type": "string"
207 },
208 "mma_resource": {
209 "type": "string"
210 }
211 }
212 }
213 }
214 }
215 },
216 "responses": {
217 "201": {
218 "description": "Updated"
219 }
220 }
221 },
222 "components": {
223 "responses": null,
224 "UnauthorizedError": {
225 "description": "API key is missing or invalid",
226 "headers": {
227 "WWW_Authenticate": {
228 "schema": {
229 "type": "string"
230 }
231 }
232 }
233 }
234 }
235 },
236 "/pack_and_hold_commentors": {
237 "get": {
238 "tags": [
239 "pack_and_hold_commentors"
240 ],
241 "description": "Gets users who are Pnh Commentors",
242 "summary": "Find",
243 "parameters": [
244 {
245 "in": "query",
246 "name": "ldap",
247 "default": null,
248 "schema": {
249 "type": "string"
250 },
251 "description": "Filter on ldap"
252 },
253 {
254 "in": "query",
255 "name": "limit",
256 "default": null,
257 "schema": {
258 "type": "integer"
259 },
260 "description": "Return this [integer] amount of records."
261 }
262 ],
263 "responses": {
264 "200": {
265 "description": "A successful response"
266 }
267 }
268 },
269 "post": {
270 "tags": [
271 "pack_and_hold_commentors"
272 ],
273 "summary": "Create",
274 "requestBody": {
275 "description": "Add user to Pnh Commentors",
276 "required": true,
277 "content": {
278 "application/json": {
279 "schema": {
280 "type": "object",
281 "properties": {
282 "ldap": {
283 "type": "string"
284 },
285 "display_name": {
286 "type": "string"
287 }
288 }
289 }
290 }
291 }
292 },
293 "responses": {
294 "201": {
295 "description": "Updated"
296 }
297 }
298 },
299 "components": {
300 "responses": null,
301 "UnauthorizedError": {
302 "description": "API key is missing or invalid",
303 "headers": {
304 "WWW_Authenticate": {
305 "schema": {
306 "type": "string"
307 }
308 }
309 }
310 }
311 },
312 "patch": {
313 "tags": [
314 "pack_and_hold_commentors"
315 ],
316 "summary": "Update",
317 "requestBody": {
318 "description": "Update display_name",
319 "required": true,
320 "content": {
321 "application/json": {
322 "schema": {
323 "type": "object",
324 "properties": {
325 "ldap": {
326 "type": "string"
327 },
328 "display_name": {
329 "type": "string"
330 }
331 }
332 }
333 }
334 }
335 },
336 "responses": {
337 "201": {
338 "description": "Updated"
339 }
340 }
341 },
342 "delete": {
343 "tags": [
344 "pack_and_hold_commentors"
345 ],
346 "summary": "Delete",
347 "parameters": [
348 {
349 "in": "query",
350 "name": "ldap",
351 "required": true,
352 "schema": {
353 "type": "string"
354 },
355 "description": "unique identifier"
356 }
357 ],
358 "responses": {
359 "201": {
360 "description": "Deleted"
361 }
362 }
363 }
364 },
365 "/patch-logs": {
366 "name": "patch_logs",
367 "get": {
368 "tags": [
369 "patch_logs"
370 ],
371 "description": "Finds patch logs for applications",
372 "summary": "Find",
373 "parameters": [
374 {
375 "in": "query",
376 "name": "app_name",
377 "default": null,
378 "schema": {
379 "type": "string"
380 },
381 "description": "Filter on Application Name"
382 },
383 {
384 "in": "query",
385 "name": "patch_number",
386 "default": null,
387 "schema": {
388 "type": "float"
389 },
390 "description": "Filter on Patch Number"
391 },
392 {
393 "in": "query",
394 "name": "offset",
395 "default": 0,
396 "schema": {
397 "type": "integer"
398 },
399 "description": "Offset the result by this many records."
400 },
401 {
402 "in": "query",
403 "name": "limit",
404 "default": 10,
405 "schema": {
406 "type": "integer"
407 },
408 "description": "Return this [integer] amount of records."
409 }
410 ],
411 "responses": {
412 "200": {
413 "description": "A successful response"
414 }
415 }
416 },
417 "post": {
418 "tags": [
419 "patch_logs"
420 ],
421 "summary": "Create",
422 "requestBody": {
423 "description": "Create Patch Log",
424 "required": true,
425 "content": {
426 "application/json": {
427 "schema": {
428 "type": "object",
429 "properties": {
430 "app_name": {
431 "type": "string"
432 },
433 "patch_number": {
434 "type": "number"
435 },
436 "patch_notes": {
437 "type": "string"
438 }
439 }
440 }
441 }
442 }
443 },
444 "responses": {
445 "201": {
446 "description": "Updated"
447 }
448 }
449 },
450 "components": {
451 "responses": null,
452 "UnauthorizedError": {
453 "description": "API key is missing or invalid",
454 "headers": {
455 "WWW_Authenticate": {
456 "schema": {
457 "type": "string"
458 }
459 }
460 }
461 }
462 }
463 },
464 "/po-approval-redirects": {
465 "get": {
466 "tags": [
467 "po_approval_redirects"
468 ],
469 "description": "Finds all recoreds of po approval redirects for the order approval tool",
470 "summary": "Find",
471 "parameters": [
472 {
473 "in": "query",
474 "name": "rule_maker_ldap",
475 "default": "wpan1",
476 "schema": {
477 "type": "string"
478 },
479 "description": "Filter on rule_maker_ldap Id"
480 },
481 {
482 "in": "query",
483 "name": "buyer_ldap",
484 "default": "wpan1",
485 "schema": {
486 "type": "string"
487 },
488 "description": "Filter on buyer_ldap Id"
489 }
490 ],
491 "responses": {
492 "200": {
493 "description": "A successful response"
494 }
495 }
496 },
497 "post": {
498 "tags": [
499 "po_approval_redirects"
500 ],