Commit cb6cf476c253eef2a7cb4cf50076a32b3491e1ca
1 parent
4e28516e
feat(docs): use strapi documentation plugin to generate api your documentation(s…
…wagger ui); 使用strapi document plugin 自动生成API 文档(由swagger ui 驱动)
Showing
10 changed files
with
8512 additions
and
17 deletions
back-end/h5-api/api/work/documentation/1.0.0/work.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/works/cors-proxy": { | ||
| 4 | + "get": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "properties": { | ||
| 14 | + "foo": { | ||
| 15 | + "type": "string" | ||
| 16 | + } | ||
| 17 | + } | ||
| 18 | + } | ||
| 19 | + } | ||
| 20 | + } | ||
| 21 | + }, | ||
| 22 | + "403": { | ||
| 23 | + "description": "Forbidden", | ||
| 24 | + "content": { | ||
| 25 | + "application/json": { | ||
| 26 | + "schema": { | ||
| 27 | + "$ref": "#/components/schemas/Error" | ||
| 28 | + } | ||
| 29 | + } | ||
| 30 | + } | ||
| 31 | + }, | ||
| 32 | + "404": { | ||
| 33 | + "description": "Not found", | ||
| 34 | + "content": { | ||
| 35 | + "application/json": { | ||
| 36 | + "schema": { | ||
| 37 | + "$ref": "#/components/schemas/Error" | ||
| 38 | + } | ||
| 39 | + } | ||
| 40 | + } | ||
| 41 | + }, | ||
| 42 | + "default": { | ||
| 43 | + "description": "unexpected error", | ||
| 44 | + "content": { | ||
| 45 | + "application/json": { | ||
| 46 | + "schema": { | ||
| 47 | + "$ref": "#/components/schemas/Error" | ||
| 48 | + } | ||
| 49 | + } | ||
| 50 | + } | ||
| 51 | + } | ||
| 52 | + }, | ||
| 53 | + "summary": "", | ||
| 54 | + "tags": [ | ||
| 55 | + "Work" | ||
| 56 | + ], | ||
| 57 | + "parameters": [] | ||
| 58 | + } | ||
| 59 | + }, | ||
| 60 | + "/works": { | ||
| 61 | + "get": { | ||
| 62 | + "deprecated": false, | ||
| 63 | + "description": "", | ||
| 64 | + "responses": { | ||
| 65 | + "200": { | ||
| 66 | + "description": "response", | ||
| 67 | + "content": { | ||
| 68 | + "application/json": { | ||
| 69 | + "schema": { | ||
| 70 | + "type": "array", | ||
| 71 | + "items": { | ||
| 72 | + "$ref": "#/components/schemas/Work" | ||
| 73 | + } | ||
| 74 | + } | ||
| 75 | + } | ||
| 76 | + } | ||
| 77 | + }, | ||
| 78 | + "403": { | ||
| 79 | + "description": "Forbidden", | ||
| 80 | + "content": { | ||
| 81 | + "application/json": { | ||
| 82 | + "schema": { | ||
| 83 | + "$ref": "#/components/schemas/Error" | ||
| 84 | + } | ||
| 85 | + } | ||
| 86 | + } | ||
| 87 | + }, | ||
| 88 | + "404": { | ||
| 89 | + "description": "Not found", | ||
| 90 | + "content": { | ||
| 91 | + "application/json": { | ||
| 92 | + "schema": { | ||
| 93 | + "$ref": "#/components/schemas/Error" | ||
| 94 | + } | ||
| 95 | + } | ||
| 96 | + } | ||
| 97 | + }, | ||
| 98 | + "default": { | ||
| 99 | + "description": "unexpected error", | ||
| 100 | + "content": { | ||
| 101 | + "application/json": { | ||
| 102 | + "schema": { | ||
| 103 | + "$ref": "#/components/schemas/Error" | ||
| 104 | + } | ||
| 105 | + } | ||
| 106 | + } | ||
| 107 | + } | ||
| 108 | + }, | ||
| 109 | + "summary": "", | ||
| 110 | + "tags": [ | ||
| 111 | + "Work" | ||
| 112 | + ], | ||
| 113 | + "parameters": [ | ||
| 114 | + { | ||
| 115 | + "name": "_limit", | ||
| 116 | + "in": "query", | ||
| 117 | + "required": false, | ||
| 118 | + "description": "Maximum number of results possible", | ||
| 119 | + "schema": { | ||
| 120 | + "type": "integer" | ||
| 121 | + }, | ||
| 122 | + "deprecated": false | ||
| 123 | + }, | ||
| 124 | + { | ||
| 125 | + "name": "_sort", | ||
| 126 | + "in": "query", | ||
| 127 | + "required": false, | ||
| 128 | + "description": "Sort according to a specific field.", | ||
| 129 | + "schema": { | ||
| 130 | + "type": "string" | ||
| 131 | + }, | ||
| 132 | + "deprecated": false | ||
| 133 | + }, | ||
| 134 | + { | ||
| 135 | + "name": "_start", | ||
| 136 | + "in": "query", | ||
| 137 | + "required": false, | ||
| 138 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 139 | + "schema": { | ||
| 140 | + "type": "integer" | ||
| 141 | + }, | ||
| 142 | + "deprecated": false | ||
| 143 | + }, | ||
| 144 | + { | ||
| 145 | + "name": "=", | ||
| 146 | + "in": "query", | ||
| 147 | + "required": false, | ||
| 148 | + "description": "Get entries that matches exactly your input", | ||
| 149 | + "schema": { | ||
| 150 | + "type": "string" | ||
| 151 | + }, | ||
| 152 | + "deprecated": false | ||
| 153 | + }, | ||
| 154 | + { | ||
| 155 | + "name": "_ne", | ||
| 156 | + "in": "query", | ||
| 157 | + "required": false, | ||
| 158 | + "description": "Get records that are not equals to something", | ||
| 159 | + "schema": { | ||
| 160 | + "type": "string" | ||
| 161 | + }, | ||
| 162 | + "deprecated": false | ||
| 163 | + }, | ||
| 164 | + { | ||
| 165 | + "name": "_lt", | ||
| 166 | + "in": "query", | ||
| 167 | + "required": false, | ||
| 168 | + "description": "Get record that are lower than a value", | ||
| 169 | + "schema": { | ||
| 170 | + "type": "string" | ||
| 171 | + }, | ||
| 172 | + "deprecated": false | ||
| 173 | + }, | ||
| 174 | + { | ||
| 175 | + "name": "_lte", | ||
| 176 | + "in": "query", | ||
| 177 | + "required": false, | ||
| 178 | + "description": "Get records that are lower than or equal to a value", | ||
| 179 | + "schema": { | ||
| 180 | + "type": "string" | ||
| 181 | + }, | ||
| 182 | + "deprecated": false | ||
| 183 | + }, | ||
| 184 | + { | ||
| 185 | + "name": "_gt", | ||
| 186 | + "in": "query", | ||
| 187 | + "required": false, | ||
| 188 | + "description": "Get records that are greater than a value", | ||
| 189 | + "schema": { | ||
| 190 | + "type": "string" | ||
| 191 | + }, | ||
| 192 | + "deprecated": false | ||
| 193 | + }, | ||
| 194 | + { | ||
| 195 | + "name": "_gte", | ||
| 196 | + "in": "query", | ||
| 197 | + "required": false, | ||
| 198 | + "description": "Get records that are greater than or equal a value", | ||
| 199 | + "schema": { | ||
| 200 | + "type": "string" | ||
| 201 | + }, | ||
| 202 | + "deprecated": false | ||
| 203 | + }, | ||
| 204 | + { | ||
| 205 | + "name": "_contains", | ||
| 206 | + "in": "query", | ||
| 207 | + "required": false, | ||
| 208 | + "description": "Get records that contains a value", | ||
| 209 | + "schema": { | ||
| 210 | + "type": "string" | ||
| 211 | + }, | ||
| 212 | + "deprecated": false | ||
| 213 | + }, | ||
| 214 | + { | ||
| 215 | + "name": "_containss", | ||
| 216 | + "in": "query", | ||
| 217 | + "required": false, | ||
| 218 | + "description": "Get records that contains (case sensitive) a value", | ||
| 219 | + "schema": { | ||
| 220 | + "type": "string" | ||
| 221 | + }, | ||
| 222 | + "deprecated": false | ||
| 223 | + }, | ||
| 224 | + { | ||
| 225 | + "name": "_in", | ||
| 226 | + "in": "query", | ||
| 227 | + "required": false, | ||
| 228 | + "description": "Get records that matches any value in the array of values", | ||
| 229 | + "schema": { | ||
| 230 | + "type": "array" | ||
| 231 | + }, | ||
| 232 | + "deprecated": false | ||
| 233 | + }, | ||
| 234 | + { | ||
| 235 | + "name": "_nin", | ||
| 236 | + "in": "query", | ||
| 237 | + "required": false, | ||
| 238 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 239 | + "schema": { | ||
| 240 | + "type": "array" | ||
| 241 | + }, | ||
| 242 | + "deprecated": false | ||
| 243 | + } | ||
| 244 | + ] | ||
| 245 | + }, | ||
| 246 | + "post": { | ||
| 247 | + "deprecated": false, | ||
| 248 | + "description": "Create a new record", | ||
| 249 | + "responses": { | ||
| 250 | + "200": { | ||
| 251 | + "description": "response", | ||
| 252 | + "content": { | ||
| 253 | + "application/json": { | ||
| 254 | + "schema": { | ||
| 255 | + "$ref": "#/components/schemas/Work" | ||
| 256 | + } | ||
| 257 | + } | ||
| 258 | + } | ||
| 259 | + }, | ||
| 260 | + "403": { | ||
| 261 | + "description": "Forbidden", | ||
| 262 | + "content": { | ||
| 263 | + "application/json": { | ||
| 264 | + "schema": { | ||
| 265 | + "$ref": "#/components/schemas/Error" | ||
| 266 | + } | ||
| 267 | + } | ||
| 268 | + } | ||
| 269 | + }, | ||
| 270 | + "404": { | ||
| 271 | + "description": "Not found", | ||
| 272 | + "content": { | ||
| 273 | + "application/json": { | ||
| 274 | + "schema": { | ||
| 275 | + "$ref": "#/components/schemas/Error" | ||
| 276 | + } | ||
| 277 | + } | ||
| 278 | + } | ||
| 279 | + }, | ||
| 280 | + "default": { | ||
| 281 | + "description": "unexpected error", | ||
| 282 | + "content": { | ||
| 283 | + "application/json": { | ||
| 284 | + "schema": { | ||
| 285 | + "$ref": "#/components/schemas/Error" | ||
| 286 | + } | ||
| 287 | + } | ||
| 288 | + } | ||
| 289 | + } | ||
| 290 | + }, | ||
| 291 | + "summary": "", | ||
| 292 | + "tags": [ | ||
| 293 | + "Work" | ||
| 294 | + ], | ||
| 295 | + "requestBody": { | ||
| 296 | + "description": "", | ||
| 297 | + "required": true, | ||
| 298 | + "content": { | ||
| 299 | + "application/json": { | ||
| 300 | + "schema": { | ||
| 301 | + "$ref": "#/components/schemas/NewWork" | ||
| 302 | + } | ||
| 303 | + } | ||
| 304 | + } | ||
| 305 | + } | ||
| 306 | + } | ||
| 307 | + }, | ||
| 308 | + "/works/count": { | ||
| 309 | + "get": { | ||
| 310 | + "deprecated": false, | ||
| 311 | + "description": "", | ||
| 312 | + "responses": { | ||
| 313 | + "200": { | ||
| 314 | + "description": "response", | ||
| 315 | + "content": { | ||
| 316 | + "application/json": { | ||
| 317 | + "schema": { | ||
| 318 | + "properties": { | ||
| 319 | + "count": { | ||
| 320 | + "type": "integer" | ||
| 321 | + } | ||
| 322 | + } | ||
| 323 | + } | ||
| 324 | + } | ||
| 325 | + } | ||
| 326 | + }, | ||
| 327 | + "403": { | ||
| 328 | + "description": "Forbidden", | ||
| 329 | + "content": { | ||
| 330 | + "application/json": { | ||
| 331 | + "schema": { | ||
| 332 | + "$ref": "#/components/schemas/Error" | ||
| 333 | + } | ||
| 334 | + } | ||
| 335 | + } | ||
| 336 | + }, | ||
| 337 | + "404": { | ||
| 338 | + "description": "Not found", | ||
| 339 | + "content": { | ||
| 340 | + "application/json": { | ||
| 341 | + "schema": { | ||
| 342 | + "$ref": "#/components/schemas/Error" | ||
| 343 | + } | ||
| 344 | + } | ||
| 345 | + } | ||
| 346 | + }, | ||
| 347 | + "default": { | ||
| 348 | + "description": "unexpected error", | ||
| 349 | + "content": { | ||
| 350 | + "application/json": { | ||
| 351 | + "schema": { | ||
| 352 | + "$ref": "#/components/schemas/Error" | ||
| 353 | + } | ||
| 354 | + } | ||
| 355 | + } | ||
| 356 | + } | ||
| 357 | + }, | ||
| 358 | + "summary": "", | ||
| 359 | + "tags": [ | ||
| 360 | + "Work" | ||
| 361 | + ], | ||
| 362 | + "parameters": [] | ||
| 363 | + } | ||
| 364 | + }, | ||
| 365 | + "/works/{id}": { | ||
| 366 | + "get": { | ||
| 367 | + "deprecated": false, | ||
| 368 | + "description": "", | ||
| 369 | + "responses": { | ||
| 370 | + "200": { | ||
| 371 | + "description": "response", | ||
| 372 | + "content": { | ||
| 373 | + "application/json": { | ||
| 374 | + "schema": { | ||
| 375 | + "$ref": "#/components/schemas/Work" | ||
| 376 | + } | ||
| 377 | + } | ||
| 378 | + } | ||
| 379 | + }, | ||
| 380 | + "403": { | ||
| 381 | + "description": "Forbidden", | ||
| 382 | + "content": { | ||
| 383 | + "application/json": { | ||
| 384 | + "schema": { | ||
| 385 | + "$ref": "#/components/schemas/Error" | ||
| 386 | + } | ||
| 387 | + } | ||
| 388 | + } | ||
| 389 | + }, | ||
| 390 | + "404": { | ||
| 391 | + "description": "Not found", | ||
| 392 | + "content": { | ||
| 393 | + "application/json": { | ||
| 394 | + "schema": { | ||
| 395 | + "$ref": "#/components/schemas/Error" | ||
| 396 | + } | ||
| 397 | + } | ||
| 398 | + } | ||
| 399 | + }, | ||
| 400 | + "default": { | ||
| 401 | + "description": "unexpected error", | ||
| 402 | + "content": { | ||
| 403 | + "application/json": { | ||
| 404 | + "schema": { | ||
| 405 | + "$ref": "#/components/schemas/Error" | ||
| 406 | + } | ||
| 407 | + } | ||
| 408 | + } | ||
| 409 | + } | ||
| 410 | + }, | ||
| 411 | + "summary": "", | ||
| 412 | + "tags": [ | ||
| 413 | + "Work" | ||
| 414 | + ], | ||
| 415 | + "parameters": [ | ||
| 416 | + { | ||
| 417 | + "name": "id", | ||
| 418 | + "in": "path", | ||
| 419 | + "description": "", | ||
| 420 | + "deprecated": false, | ||
| 421 | + "required": true, | ||
| 422 | + "schema": { | ||
| 423 | + "type": "string" | ||
| 424 | + } | ||
| 425 | + } | ||
| 426 | + ] | ||
| 427 | + }, | ||
| 428 | + "put": { | ||
| 429 | + "deprecated": false, | ||
| 430 | + "description": "Update a record", | ||
| 431 | + "responses": { | ||
| 432 | + "200": { | ||
| 433 | + "description": "response", | ||
| 434 | + "content": { | ||
| 435 | + "application/json": { | ||
| 436 | + "schema": { | ||
| 437 | + "$ref": "#/components/schemas/Work" | ||
| 438 | + } | ||
| 439 | + } | ||
| 440 | + } | ||
| 441 | + }, | ||
| 442 | + "403": { | ||
| 443 | + "description": "Forbidden", | ||
| 444 | + "content": { | ||
| 445 | + "application/json": { | ||
| 446 | + "schema": { | ||
| 447 | + "$ref": "#/components/schemas/Error" | ||
| 448 | + } | ||
| 449 | + } | ||
| 450 | + } | ||
| 451 | + }, | ||
| 452 | + "404": { | ||
| 453 | + "description": "Not found", | ||
| 454 | + "content": { | ||
| 455 | + "application/json": { | ||
| 456 | + "schema": { | ||
| 457 | + "$ref": "#/components/schemas/Error" | ||
| 458 | + } | ||
| 459 | + } | ||
| 460 | + } | ||
| 461 | + }, | ||
| 462 | + "default": { | ||
| 463 | + "description": "unexpected error", | ||
| 464 | + "content": { | ||
| 465 | + "application/json": { | ||
| 466 | + "schema": { | ||
| 467 | + "$ref": "#/components/schemas/Error" | ||
| 468 | + } | ||
| 469 | + } | ||
| 470 | + } | ||
| 471 | + } | ||
| 472 | + }, | ||
| 473 | + "summary": "", | ||
| 474 | + "tags": [ | ||
| 475 | + "Work" | ||
| 476 | + ], | ||
| 477 | + "requestBody": { | ||
| 478 | + "description": "", | ||
| 479 | + "required": true, | ||
| 480 | + "content": { | ||
| 481 | + "application/json": { | ||
| 482 | + "schema": { | ||
| 483 | + "$ref": "#/components/schemas/NewWork" | ||
| 484 | + } | ||
| 485 | + } | ||
| 486 | + } | ||
| 487 | + }, | ||
| 488 | + "parameters": [ | ||
| 489 | + { | ||
| 490 | + "name": "id", | ||
| 491 | + "in": "path", | ||
| 492 | + "description": "", | ||
| 493 | + "deprecated": false, | ||
| 494 | + "required": true, | ||
| 495 | + "schema": { | ||
| 496 | + "type": "string" | ||
| 497 | + } | ||
| 498 | + } | ||
| 499 | + ] | ||
| 500 | + }, | ||
| 501 | + "delete": { | ||
| 502 | + "deprecated": false, | ||
| 503 | + "description": "Delete a record", | ||
| 504 | + "responses": { | ||
| 505 | + "200": { | ||
| 506 | + "description": "deletes a single record based on the ID supplied", | ||
| 507 | + "content": { | ||
| 508 | + "application/json": { | ||
| 509 | + "schema": { | ||
| 510 | + "type": "integer", | ||
| 511 | + "format": "int64" | ||
| 512 | + } | ||
| 513 | + } | ||
| 514 | + } | ||
| 515 | + }, | ||
| 516 | + "403": { | ||
| 517 | + "description": "Forbidden", | ||
| 518 | + "content": { | ||
| 519 | + "application/json": { | ||
| 520 | + "schema": { | ||
| 521 | + "$ref": "#/components/schemas/Error" | ||
| 522 | + } | ||
| 523 | + } | ||
| 524 | + } | ||
| 525 | + }, | ||
| 526 | + "404": { | ||
| 527 | + "description": "Not found", | ||
| 528 | + "content": { | ||
| 529 | + "application/json": { | ||
| 530 | + "schema": { | ||
| 531 | + "$ref": "#/components/schemas/Error" | ||
| 532 | + } | ||
| 533 | + } | ||
| 534 | + } | ||
| 535 | + }, | ||
| 536 | + "default": { | ||
| 537 | + "description": "unexpected error", | ||
| 538 | + "content": { | ||
| 539 | + "application/json": { | ||
| 540 | + "schema": { | ||
| 541 | + "$ref": "#/components/schemas/Error" | ||
| 542 | + } | ||
| 543 | + } | ||
| 544 | + } | ||
| 545 | + } | ||
| 546 | + }, | ||
| 547 | + "summary": "", | ||
| 548 | + "tags": [ | ||
| 549 | + "Work" | ||
| 550 | + ], | ||
| 551 | + "parameters": [ | ||
| 552 | + { | ||
| 553 | + "name": "id", | ||
| 554 | + "in": "path", | ||
| 555 | + "description": "", | ||
| 556 | + "deprecated": false, | ||
| 557 | + "required": true, | ||
| 558 | + "schema": { | ||
| 559 | + "type": "string" | ||
| 560 | + } | ||
| 561 | + } | ||
| 562 | + ] | ||
| 563 | + } | ||
| 564 | + }, | ||
| 565 | + "/works/preview/{id}": { | ||
| 566 | + "get": { | ||
| 567 | + "deprecated": false, | ||
| 568 | + "description": "", | ||
| 569 | + "responses": { | ||
| 570 | + "200": { | ||
| 571 | + "description": "response", | ||
| 572 | + "content": { | ||
| 573 | + "application/json": { | ||
| 574 | + "schema": { | ||
| 575 | + "properties": { | ||
| 576 | + "foo": { | ||
| 577 | + "type": "string" | ||
| 578 | + } | ||
| 579 | + } | ||
| 580 | + } | ||
| 581 | + } | ||
| 582 | + } | ||
| 583 | + }, | ||
| 584 | + "403": { | ||
| 585 | + "description": "Forbidden", | ||
| 586 | + "content": { | ||
| 587 | + "application/json": { | ||
| 588 | + "schema": { | ||
| 589 | + "$ref": "#/components/schemas/Error" | ||
| 590 | + } | ||
| 591 | + } | ||
| 592 | + } | ||
| 593 | + }, | ||
| 594 | + "404": { | ||
| 595 | + "description": "Not found", | ||
| 596 | + "content": { | ||
| 597 | + "application/json": { | ||
| 598 | + "schema": { | ||
| 599 | + "$ref": "#/components/schemas/Error" | ||
| 600 | + } | ||
| 601 | + } | ||
| 602 | + } | ||
| 603 | + }, | ||
| 604 | + "default": { | ||
| 605 | + "description": "unexpected error", | ||
| 606 | + "content": { | ||
| 607 | + "application/json": { | ||
| 608 | + "schema": { | ||
| 609 | + "$ref": "#/components/schemas/Error" | ||
| 610 | + } | ||
| 611 | + } | ||
| 612 | + } | ||
| 613 | + } | ||
| 614 | + }, | ||
| 615 | + "summary": "", | ||
| 616 | + "tags": [ | ||
| 617 | + "Work" | ||
| 618 | + ], | ||
| 619 | + "parameters": [ | ||
| 620 | + { | ||
| 621 | + "name": "id", | ||
| 622 | + "in": "path", | ||
| 623 | + "description": "", | ||
| 624 | + "deprecated": false, | ||
| 625 | + "required": true, | ||
| 626 | + "schema": { | ||
| 627 | + "type": "string" | ||
| 628 | + } | ||
| 629 | + } | ||
| 630 | + ] | ||
| 631 | + } | ||
| 632 | + }, | ||
| 633 | + "/works/form/submit/{id}": { | ||
| 634 | + "post": { | ||
| 635 | + "deprecated": false, | ||
| 636 | + "description": "Create a new record", | ||
| 637 | + "responses": { | ||
| 638 | + "200": { | ||
| 639 | + "description": "response", | ||
| 640 | + "content": { | ||
| 641 | + "application/json": { | ||
| 642 | + "schema": { | ||
| 643 | + "properties": { | ||
| 644 | + "foo": { | ||
| 645 | + "type": "string" | ||
| 646 | + } | ||
| 647 | + } | ||
| 648 | + } | ||
| 649 | + } | ||
| 650 | + } | ||
| 651 | + }, | ||
| 652 | + "403": { | ||
| 653 | + "description": "Forbidden", | ||
| 654 | + "content": { | ||
| 655 | + "application/json": { | ||
| 656 | + "schema": { | ||
| 657 | + "$ref": "#/components/schemas/Error" | ||
| 658 | + } | ||
| 659 | + } | ||
| 660 | + } | ||
| 661 | + }, | ||
| 662 | + "404": { | ||
| 663 | + "description": "Not found", | ||
| 664 | + "content": { | ||
| 665 | + "application/json": { | ||
| 666 | + "schema": { | ||
| 667 | + "$ref": "#/components/schemas/Error" | ||
| 668 | + } | ||
| 669 | + } | ||
| 670 | + } | ||
| 671 | + }, | ||
| 672 | + "default": { | ||
| 673 | + "description": "unexpected error", | ||
| 674 | + "content": { | ||
| 675 | + "application/json": { | ||
| 676 | + "schema": { | ||
| 677 | + "$ref": "#/components/schemas/Error" | ||
| 678 | + } | ||
| 679 | + } | ||
| 680 | + } | ||
| 681 | + } | ||
| 682 | + }, | ||
| 683 | + "summary": "", | ||
| 684 | + "tags": [ | ||
| 685 | + "Work" | ||
| 686 | + ], | ||
| 687 | + "requestBody": { | ||
| 688 | + "description": "", | ||
| 689 | + "required": true, | ||
| 690 | + "content": { | ||
| 691 | + "application/json": { | ||
| 692 | + "schema": { | ||
| 693 | + "properties": { | ||
| 694 | + "foo": { | ||
| 695 | + "type": "string" | ||
| 696 | + } | ||
| 697 | + } | ||
| 698 | + } | ||
| 699 | + } | ||
| 700 | + } | ||
| 701 | + } | ||
| 702 | + } | ||
| 703 | + }, | ||
| 704 | + "/works/form/query/{id}": { | ||
| 705 | + "get": { | ||
| 706 | + "deprecated": false, | ||
| 707 | + "description": "", | ||
| 708 | + "responses": { | ||
| 709 | + "200": { | ||
| 710 | + "description": "response", | ||
| 711 | + "content": { | ||
| 712 | + "application/json": { | ||
| 713 | + "schema": { | ||
| 714 | + "properties": { | ||
| 715 | + "foo": { | ||
| 716 | + "type": "string" | ||
| 717 | + } | ||
| 718 | + } | ||
| 719 | + } | ||
| 720 | + } | ||
| 721 | + } | ||
| 722 | + }, | ||
| 723 | + "403": { | ||
| 724 | + "description": "Forbidden", | ||
| 725 | + "content": { | ||
| 726 | + "application/json": { | ||
| 727 | + "schema": { | ||
| 728 | + "$ref": "#/components/schemas/Error" | ||
| 729 | + } | ||
| 730 | + } | ||
| 731 | + } | ||
| 732 | + }, | ||
| 733 | + "404": { | ||
| 734 | + "description": "Not found", | ||
| 735 | + "content": { | ||
| 736 | + "application/json": { | ||
| 737 | + "schema": { | ||
| 738 | + "$ref": "#/components/schemas/Error" | ||
| 739 | + } | ||
| 740 | + } | ||
| 741 | + } | ||
| 742 | + }, | ||
| 743 | + "default": { | ||
| 744 | + "description": "unexpected error", | ||
| 745 | + "content": { | ||
| 746 | + "application/json": { | ||
| 747 | + "schema": { | ||
| 748 | + "$ref": "#/components/schemas/Error" | ||
| 749 | + } | ||
| 750 | + } | ||
| 751 | + } | ||
| 752 | + } | ||
| 753 | + }, | ||
| 754 | + "summary": "", | ||
| 755 | + "tags": [ | ||
| 756 | + "Work" | ||
| 757 | + ], | ||
| 758 | + "parameters": [ | ||
| 759 | + { | ||
| 760 | + "name": "id", | ||
| 761 | + "in": "path", | ||
| 762 | + "description": "", | ||
| 763 | + "deprecated": false, | ||
| 764 | + "required": true, | ||
| 765 | + "schema": { | ||
| 766 | + "type": "string" | ||
| 767 | + } | ||
| 768 | + } | ||
| 769 | + ] | ||
| 770 | + } | ||
| 771 | + }, | ||
| 772 | + "/works/set-as-template/{id}": { | ||
| 773 | + "post": { | ||
| 774 | + "deprecated": false, | ||
| 775 | + "description": "Create a new record", | ||
| 776 | + "responses": { | ||
| 777 | + "200": { | ||
| 778 | + "description": "response", | ||
| 779 | + "content": { | ||
| 780 | + "application/json": { | ||
| 781 | + "schema": { | ||
| 782 | + "properties": { | ||
| 783 | + "foo": { | ||
| 784 | + "type": "string" | ||
| 785 | + } | ||
| 786 | + } | ||
| 787 | + } | ||
| 788 | + } | ||
| 789 | + } | ||
| 790 | + }, | ||
| 791 | + "403": { | ||
| 792 | + "description": "Forbidden", | ||
| 793 | + "content": { | ||
| 794 | + "application/json": { | ||
| 795 | + "schema": { | ||
| 796 | + "$ref": "#/components/schemas/Error" | ||
| 797 | + } | ||
| 798 | + } | ||
| 799 | + } | ||
| 800 | + }, | ||
| 801 | + "404": { | ||
| 802 | + "description": "Not found", | ||
| 803 | + "content": { | ||
| 804 | + "application/json": { | ||
| 805 | + "schema": { | ||
| 806 | + "$ref": "#/components/schemas/Error" | ||
| 807 | + } | ||
| 808 | + } | ||
| 809 | + } | ||
| 810 | + }, | ||
| 811 | + "default": { | ||
| 812 | + "description": "unexpected error", | ||
| 813 | + "content": { | ||
| 814 | + "application/json": { | ||
| 815 | + "schema": { | ||
| 816 | + "$ref": "#/components/schemas/Error" | ||
| 817 | + } | ||
| 818 | + } | ||
| 819 | + } | ||
| 820 | + } | ||
| 821 | + }, | ||
| 822 | + "summary": "", | ||
| 823 | + "tags": [ | ||
| 824 | + "Work" | ||
| 825 | + ], | ||
| 826 | + "requestBody": { | ||
| 827 | + "description": "", | ||
| 828 | + "required": true, | ||
| 829 | + "content": { | ||
| 830 | + "application/json": { | ||
| 831 | + "schema": { | ||
| 832 | + "properties": { | ||
| 833 | + "foo": { | ||
| 834 | + "type": "string" | ||
| 835 | + } | ||
| 836 | + } | ||
| 837 | + } | ||
| 838 | + } | ||
| 839 | + } | ||
| 840 | + } | ||
| 841 | + } | ||
| 842 | + }, | ||
| 843 | + "/works/use-template/{id}": { | ||
| 844 | + "post": { | ||
| 845 | + "deprecated": false, | ||
| 846 | + "description": "Create a new record", | ||
| 847 | + "responses": { | ||
| 848 | + "200": { | ||
| 849 | + "description": "response", | ||
| 850 | + "content": { | ||
| 851 | + "application/json": { | ||
| 852 | + "schema": { | ||
| 853 | + "properties": { | ||
| 854 | + "foo": { | ||
| 855 | + "type": "string" | ||
| 856 | + } | ||
| 857 | + } | ||
| 858 | + } | ||
| 859 | + } | ||
| 860 | + } | ||
| 861 | + }, | ||
| 862 | + "403": { | ||
| 863 | + "description": "Forbidden", | ||
| 864 | + "content": { | ||
| 865 | + "application/json": { | ||
| 866 | + "schema": { | ||
| 867 | + "$ref": "#/components/schemas/Error" | ||
| 868 | + } | ||
| 869 | + } | ||
| 870 | + } | ||
| 871 | + }, | ||
| 872 | + "404": { | ||
| 873 | + "description": "Not found", | ||
| 874 | + "content": { | ||
| 875 | + "application/json": { | ||
| 876 | + "schema": { | ||
| 877 | + "$ref": "#/components/schemas/Error" | ||
| 878 | + } | ||
| 879 | + } | ||
| 880 | + } | ||
| 881 | + }, | ||
| 882 | + "default": { | ||
| 883 | + "description": "unexpected error", | ||
| 884 | + "content": { | ||
| 885 | + "application/json": { | ||
| 886 | + "schema": { | ||
| 887 | + "$ref": "#/components/schemas/Error" | ||
| 888 | + } | ||
| 889 | + } | ||
| 890 | + } | ||
| 891 | + } | ||
| 892 | + }, | ||
| 893 | + "summary": "", | ||
| 894 | + "tags": [ | ||
| 895 | + "Work" | ||
| 896 | + ], | ||
| 897 | + "requestBody": { | ||
| 898 | + "description": "", | ||
| 899 | + "required": true, | ||
| 900 | + "content": { | ||
| 901 | + "application/json": { | ||
| 902 | + "schema": { | ||
| 903 | + "properties": { | ||
| 904 | + "foo": { | ||
| 905 | + "type": "string" | ||
| 906 | + } | ||
| 907 | + } | ||
| 908 | + } | ||
| 909 | + } | ||
| 910 | + } | ||
| 911 | + } | ||
| 912 | + } | ||
| 913 | + } | ||
| 914 | + }, | ||
| 915 | + "components": { | ||
| 916 | + "schemas": { | ||
| 917 | + "Work": { | ||
| 918 | + "required": [ | ||
| 919 | + "id" | ||
| 920 | + ], | ||
| 921 | + "properties": { | ||
| 922 | + "id": { | ||
| 923 | + "type": "string" | ||
| 924 | + }, | ||
| 925 | + "title": { | ||
| 926 | + "type": "string" | ||
| 927 | + }, | ||
| 928 | + "description": { | ||
| 929 | + "type": "string" | ||
| 930 | + }, | ||
| 931 | + "cover_image_url": { | ||
| 932 | + "type": "string" | ||
| 933 | + }, | ||
| 934 | + "pages": { | ||
| 935 | + "type": "object" | ||
| 936 | + }, | ||
| 937 | + "is_publish": { | ||
| 938 | + "type": "boolean" | ||
| 939 | + }, | ||
| 940 | + "is_template": { | ||
| 941 | + "type": "boolean" | ||
| 942 | + } | ||
| 943 | + } | ||
| 944 | + }, | ||
| 945 | + "NewWork": { | ||
| 946 | + "properties": { | ||
| 947 | + "title": { | ||
| 948 | + "type": "string" | ||
| 949 | + }, | ||
| 950 | + "description": { | ||
| 951 | + "type": "string" | ||
| 952 | + }, | ||
| 953 | + "cover_image_url": { | ||
| 954 | + "type": "string" | ||
| 955 | + }, | ||
| 956 | + "pages": { | ||
| 957 | + "type": "object" | ||
| 958 | + }, | ||
| 959 | + "is_publish": { | ||
| 960 | + "type": "boolean" | ||
| 961 | + }, | ||
| 962 | + "is_template": { | ||
| 963 | + "type": "boolean" | ||
| 964 | + } | ||
| 965 | + } | ||
| 966 | + } | ||
| 967 | + } | ||
| 968 | + }, | ||
| 969 | + "tags": [ | ||
| 970 | + { | ||
| 971 | + "name": "Work" | ||
| 972 | + } | ||
| 973 | + ] | ||
| 974 | +} | ||
| 0 | \ No newline at end of file | 975 | \ No newline at end of file |
back-end/h5-api/api/workform/documentation/1.0.0/workform.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/workforms": { | ||
| 4 | + "get": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "type": "array", | ||
| 14 | + "items": { | ||
| 15 | + "$ref": "#/components/schemas/Workform" | ||
| 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 | + "Workform" | ||
| 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 | + }, | ||
| 175 | + "deprecated": false | ||
| 176 | + }, | ||
| 177 | + { | ||
| 178 | + "name": "_nin", | ||
| 179 | + "in": "query", | ||
| 180 | + "required": false, | ||
| 181 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 182 | + "schema": { | ||
| 183 | + "type": "array" | ||
| 184 | + }, | ||
| 185 | + "deprecated": false | ||
| 186 | + } | ||
| 187 | + ] | ||
| 188 | + }, | ||
| 189 | + "post": { | ||
| 190 | + "deprecated": false, | ||
| 191 | + "description": "Create a new record", | ||
| 192 | + "responses": { | ||
| 193 | + "200": { | ||
| 194 | + "description": "response", | ||
| 195 | + "content": { | ||
| 196 | + "application/json": { | ||
| 197 | + "schema": { | ||
| 198 | + "$ref": "#/components/schemas/Workform" | ||
| 199 | + } | ||
| 200 | + } | ||
| 201 | + } | ||
| 202 | + }, | ||
| 203 | + "403": { | ||
| 204 | + "description": "Forbidden", | ||
| 205 | + "content": { | ||
| 206 | + "application/json": { | ||
| 207 | + "schema": { | ||
| 208 | + "$ref": "#/components/schemas/Error" | ||
| 209 | + } | ||
| 210 | + } | ||
| 211 | + } | ||
| 212 | + }, | ||
| 213 | + "404": { | ||
| 214 | + "description": "Not found", | ||
| 215 | + "content": { | ||
| 216 | + "application/json": { | ||
| 217 | + "schema": { | ||
| 218 | + "$ref": "#/components/schemas/Error" | ||
| 219 | + } | ||
| 220 | + } | ||
| 221 | + } | ||
| 222 | + }, | ||
| 223 | + "default": { | ||
| 224 | + "description": "unexpected error", | ||
| 225 | + "content": { | ||
| 226 | + "application/json": { | ||
| 227 | + "schema": { | ||
| 228 | + "$ref": "#/components/schemas/Error" | ||
| 229 | + } | ||
| 230 | + } | ||
| 231 | + } | ||
| 232 | + } | ||
| 233 | + }, | ||
| 234 | + "summary": "", | ||
| 235 | + "tags": [ | ||
| 236 | + "Workform" | ||
| 237 | + ], | ||
| 238 | + "requestBody": { | ||
| 239 | + "description": "", | ||
| 240 | + "required": true, | ||
| 241 | + "content": { | ||
| 242 | + "application/json": { | ||
| 243 | + "schema": { | ||
| 244 | + "$ref": "#/components/schemas/NewWorkform" | ||
| 245 | + } | ||
| 246 | + } | ||
| 247 | + } | ||
| 248 | + } | ||
| 249 | + } | ||
| 250 | + }, | ||
| 251 | + "/workforms/count": { | ||
| 252 | + "get": { | ||
| 253 | + "deprecated": false, | ||
| 254 | + "description": "", | ||
| 255 | + "responses": { | ||
| 256 | + "200": { | ||
| 257 | + "description": "response", | ||
| 258 | + "content": { | ||
| 259 | + "application/json": { | ||
| 260 | + "schema": { | ||
| 261 | + "properties": { | ||
| 262 | + "count": { | ||
| 263 | + "type": "integer" | ||
| 264 | + } | ||
| 265 | + } | ||
| 266 | + } | ||
| 267 | + } | ||
| 268 | + } | ||
| 269 | + }, | ||
| 270 | + "403": { | ||
| 271 | + "description": "Forbidden", | ||
| 272 | + "content": { | ||
| 273 | + "application/json": { | ||
| 274 | + "schema": { | ||
| 275 | + "$ref": "#/components/schemas/Error" | ||
| 276 | + } | ||
| 277 | + } | ||
| 278 | + } | ||
| 279 | + }, | ||
| 280 | + "404": { | ||
| 281 | + "description": "Not found", | ||
| 282 | + "content": { | ||
| 283 | + "application/json": { | ||
| 284 | + "schema": { | ||
| 285 | + "$ref": "#/components/schemas/Error" | ||
| 286 | + } | ||
| 287 | + } | ||
| 288 | + } | ||
| 289 | + }, | ||
| 290 | + "default": { | ||
| 291 | + "description": "unexpected error", | ||
| 292 | + "content": { | ||
| 293 | + "application/json": { | ||
| 294 | + "schema": { | ||
| 295 | + "$ref": "#/components/schemas/Error" | ||
| 296 | + } | ||
| 297 | + } | ||
| 298 | + } | ||
| 299 | + } | ||
| 300 | + }, | ||
| 301 | + "summary": "", | ||
| 302 | + "tags": [ | ||
| 303 | + "Workform" | ||
| 304 | + ], | ||
| 305 | + "parameters": [] | ||
| 306 | + } | ||
| 307 | + }, | ||
| 308 | + "/workforms/{id}": { | ||
| 309 | + "get": { | ||
| 310 | + "deprecated": false, | ||
| 311 | + "description": "", | ||
| 312 | + "responses": { | ||
| 313 | + "200": { | ||
| 314 | + "description": "response", | ||
| 315 | + "content": { | ||
| 316 | + "application/json": { | ||
| 317 | + "schema": { | ||
| 318 | + "$ref": "#/components/schemas/Workform" | ||
| 319 | + } | ||
| 320 | + } | ||
| 321 | + } | ||
| 322 | + }, | ||
| 323 | + "403": { | ||
| 324 | + "description": "Forbidden", | ||
| 325 | + "content": { | ||
| 326 | + "application/json": { | ||
| 327 | + "schema": { | ||
| 328 | + "$ref": "#/components/schemas/Error" | ||
| 329 | + } | ||
| 330 | + } | ||
| 331 | + } | ||
| 332 | + }, | ||
| 333 | + "404": { | ||
| 334 | + "description": "Not found", | ||
| 335 | + "content": { | ||
| 336 | + "application/json": { | ||
| 337 | + "schema": { | ||
| 338 | + "$ref": "#/components/schemas/Error" | ||
| 339 | + } | ||
| 340 | + } | ||
| 341 | + } | ||
| 342 | + }, | ||
| 343 | + "default": { | ||
| 344 | + "description": "unexpected error", | ||
| 345 | + "content": { | ||
| 346 | + "application/json": { | ||
| 347 | + "schema": { | ||
| 348 | + "$ref": "#/components/schemas/Error" | ||
| 349 | + } | ||
| 350 | + } | ||
| 351 | + } | ||
| 352 | + } | ||
| 353 | + }, | ||
| 354 | + "summary": "", | ||
| 355 | + "tags": [ | ||
| 356 | + "Workform" | ||
| 357 | + ], | ||
| 358 | + "parameters": [ | ||
| 359 | + { | ||
| 360 | + "name": "id", | ||
| 361 | + "in": "path", | ||
| 362 | + "description": "", | ||
| 363 | + "deprecated": false, | ||
| 364 | + "required": true, | ||
| 365 | + "schema": { | ||
| 366 | + "type": "string" | ||
| 367 | + } | ||
| 368 | + } | ||
| 369 | + ] | ||
| 370 | + }, | ||
| 371 | + "put": { | ||
| 372 | + "deprecated": false, | ||
| 373 | + "description": "Update a record", | ||
| 374 | + "responses": { | ||
| 375 | + "200": { | ||
| 376 | + "description": "response", | ||
| 377 | + "content": { | ||
| 378 | + "application/json": { | ||
| 379 | + "schema": { | ||
| 380 | + "$ref": "#/components/schemas/Workform" | ||
| 381 | + } | ||
| 382 | + } | ||
| 383 | + } | ||
| 384 | + }, | ||
| 385 | + "403": { | ||
| 386 | + "description": "Forbidden", | ||
| 387 | + "content": { | ||
| 388 | + "application/json": { | ||
| 389 | + "schema": { | ||
| 390 | + "$ref": "#/components/schemas/Error" | ||
| 391 | + } | ||
| 392 | + } | ||
| 393 | + } | ||
| 394 | + }, | ||
| 395 | + "404": { | ||
| 396 | + "description": "Not found", | ||
| 397 | + "content": { | ||
| 398 | + "application/json": { | ||
| 399 | + "schema": { | ||
| 400 | + "$ref": "#/components/schemas/Error" | ||
| 401 | + } | ||
| 402 | + } | ||
| 403 | + } | ||
| 404 | + }, | ||
| 405 | + "default": { | ||
| 406 | + "description": "unexpected error", | ||
| 407 | + "content": { | ||
| 408 | + "application/json": { | ||
| 409 | + "schema": { | ||
| 410 | + "$ref": "#/components/schemas/Error" | ||
| 411 | + } | ||
| 412 | + } | ||
| 413 | + } | ||
| 414 | + } | ||
| 415 | + }, | ||
| 416 | + "summary": "", | ||
| 417 | + "tags": [ | ||
| 418 | + "Workform" | ||
| 419 | + ], | ||
| 420 | + "requestBody": { | ||
| 421 | + "description": "", | ||
| 422 | + "required": true, | ||
| 423 | + "content": { | ||
| 424 | + "application/json": { | ||
| 425 | + "schema": { | ||
| 426 | + "$ref": "#/components/schemas/NewWorkform" | ||
| 427 | + } | ||
| 428 | + } | ||
| 429 | + } | ||
| 430 | + }, | ||
| 431 | + "parameters": [ | ||
| 432 | + { | ||
| 433 | + "name": "id", | ||
| 434 | + "in": "path", | ||
| 435 | + "description": "", | ||
| 436 | + "deprecated": false, | ||
| 437 | + "required": true, | ||
| 438 | + "schema": { | ||
| 439 | + "type": "string" | ||
| 440 | + } | ||
| 441 | + } | ||
| 442 | + ] | ||
| 443 | + }, | ||
| 444 | + "delete": { | ||
| 445 | + "deprecated": false, | ||
| 446 | + "description": "Delete a record", | ||
| 447 | + "responses": { | ||
| 448 | + "200": { | ||
| 449 | + "description": "deletes a single record based on the ID supplied", | ||
| 450 | + "content": { | ||
| 451 | + "application/json": { | ||
| 452 | + "schema": { | ||
| 453 | + "type": "integer", | ||
| 454 | + "format": "int64" | ||
| 455 | + } | ||
| 456 | + } | ||
| 457 | + } | ||
| 458 | + }, | ||
| 459 | + "403": { | ||
| 460 | + "description": "Forbidden", | ||
| 461 | + "content": { | ||
| 462 | + "application/json": { | ||
| 463 | + "schema": { | ||
| 464 | + "$ref": "#/components/schemas/Error" | ||
| 465 | + } | ||
| 466 | + } | ||
| 467 | + } | ||
| 468 | + }, | ||
| 469 | + "404": { | ||
| 470 | + "description": "Not found", | ||
| 471 | + "content": { | ||
| 472 | + "application/json": { | ||
| 473 | + "schema": { | ||
| 474 | + "$ref": "#/components/schemas/Error" | ||
| 475 | + } | ||
| 476 | + } | ||
| 477 | + } | ||
| 478 | + }, | ||
| 479 | + "default": { | ||
| 480 | + "description": "unexpected error", | ||
| 481 | + "content": { | ||
| 482 | + "application/json": { | ||
| 483 | + "schema": { | ||
| 484 | + "$ref": "#/components/schemas/Error" | ||
| 485 | + } | ||
| 486 | + } | ||
| 487 | + } | ||
| 488 | + } | ||
| 489 | + }, | ||
| 490 | + "summary": "", | ||
| 491 | + "tags": [ | ||
| 492 | + "Workform" | ||
| 493 | + ], | ||
| 494 | + "parameters": [ | ||
| 495 | + { | ||
| 496 | + "name": "id", | ||
| 497 | + "in": "path", | ||
| 498 | + "description": "", | ||
| 499 | + "deprecated": false, | ||
| 500 | + "required": true, | ||
| 501 | + "schema": { | ||
| 502 | + "type": "string" | ||
| 503 | + } | ||
| 504 | + } | ||
| 505 | + ] | ||
| 506 | + } | ||
| 507 | + } | ||
| 508 | + }, | ||
| 509 | + "components": { | ||
| 510 | + "schemas": { | ||
| 511 | + "Workform": { | ||
| 512 | + "required": [ | ||
| 513 | + "id" | ||
| 514 | + ], | ||
| 515 | + "properties": { | ||
| 516 | + "id": { | ||
| 517 | + "type": "string" | ||
| 518 | + }, | ||
| 519 | + "form": { | ||
| 520 | + "type": "object" | ||
| 521 | + }, | ||
| 522 | + "work": { | ||
| 523 | + "required": [ | ||
| 524 | + "id" | ||
| 525 | + ], | ||
| 526 | + "properties": { | ||
| 527 | + "id": { | ||
| 528 | + "type": "string" | ||
| 529 | + }, | ||
| 530 | + "title": { | ||
| 531 | + "type": "string" | ||
| 532 | + }, | ||
| 533 | + "description": { | ||
| 534 | + "type": "string" | ||
| 535 | + }, | ||
| 536 | + "cover_image_url": { | ||
| 537 | + "type": "string" | ||
| 538 | + }, | ||
| 539 | + "pages": { | ||
| 540 | + "type": "object" | ||
| 541 | + }, | ||
| 542 | + "is_publish": { | ||
| 543 | + "type": "boolean" | ||
| 544 | + }, | ||
| 545 | + "is_template": { | ||
| 546 | + "type": "boolean" | ||
| 547 | + } | ||
| 548 | + } | ||
| 549 | + } | ||
| 550 | + } | ||
| 551 | + }, | ||
| 552 | + "NewWorkform": { | ||
| 553 | + "properties": { | ||
| 554 | + "form": { | ||
| 555 | + "type": "object" | ||
| 556 | + }, | ||
| 557 | + "work": { | ||
| 558 | + "type": "string" | ||
| 559 | + } | ||
| 560 | + } | ||
| 561 | + } | ||
| 562 | + } | ||
| 563 | + }, | ||
| 564 | + "tags": [ | ||
| 565 | + { | ||
| 566 | + "name": "Workform" | ||
| 567 | + } | ||
| 568 | + ] | ||
| 569 | +} | ||
| 0 | \ No newline at end of file | 570 | \ No newline at end of file |
back-end/h5-api/extensions/documentation/documentation/1.0.0/full_documentation.json
0 → 100644
| 1 | +{ | ||
| 2 | + "openapi": "3.0.0", | ||
| 3 | + "info": { | ||
| 4 | + "version": "1.0.0", | ||
| 5 | + "title": "DOCUMENTATION", | ||
| 6 | + "description": "", | ||
| 7 | + "termsOfService": "YOUR_TERMS_OF_SERVICE_URL", | ||
| 8 | + "contact": { | ||
| 9 | + "name": "TEAM", | ||
| 10 | + "email": "contact-email@something.io", | ||
| 11 | + "url": "mywebsite.io" | ||
| 12 | + }, | ||
| 13 | + "license": { | ||
| 14 | + "name": "Apache 2.0", | ||
| 15 | + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" | ||
| 16 | + }, | ||
| 17 | + "x-generation-date": "12/16/2019 8:50:56 AM" | ||
| 18 | + }, | ||
| 19 | + "x-strapi-config": { | ||
| 20 | + "path": "/documentation", | ||
| 21 | + "showGeneratedFiles": true | ||
| 22 | + }, | ||
| 23 | + "servers": [ | ||
| 24 | + { | ||
| 25 | + "url": "http://localhost:1337", | ||
| 26 | + "description": "Development server" | ||
| 27 | + }, | ||
| 28 | + { | ||
| 29 | + "url": "YOUR_STAGING_SERVER", | ||
| 30 | + "description": "Staging server" | ||
| 31 | + }, | ||
| 32 | + { | ||
| 33 | + "url": "YOUR_PRODUCTION_SERVER", | ||
| 34 | + "description": "Production server" | ||
| 35 | + } | ||
| 36 | + ], | ||
| 37 | + "externalDocs": { | ||
| 38 | + "description": "Find out more", | ||
| 39 | + "url": "https://strapi.io/documentation/3.0.0-beta.x/" | ||
| 40 | + }, | ||
| 41 | + "security": [ | ||
| 42 | + { | ||
| 43 | + "bearerAuth": [] | ||
| 44 | + } | ||
| 45 | + ], | ||
| 46 | + "paths": { | ||
| 47 | + "/works/cors-proxy": { | ||
| 48 | + "get": { | ||
| 49 | + "deprecated": false, | ||
| 50 | + "description": "", | ||
| 51 | + "responses": { | ||
| 52 | + "200": { | ||
| 53 | + "description": "response", | ||
| 54 | + "content": { | ||
| 55 | + "application/json": { | ||
| 56 | + "schema": { | ||
| 57 | + "properties": { | ||
| 58 | + "foo": { | ||
| 59 | + "type": "string" | ||
| 60 | + } | ||
| 61 | + } | ||
| 62 | + } | ||
| 63 | + } | ||
| 64 | + } | ||
| 65 | + }, | ||
| 66 | + "403": { | ||
| 67 | + "description": "Forbidden", | ||
| 68 | + "content": { | ||
| 69 | + "application/json": { | ||
| 70 | + "schema": { | ||
| 71 | + "$ref": "#/components/schemas/Error" | ||
| 72 | + } | ||
| 73 | + } | ||
| 74 | + } | ||
| 75 | + }, | ||
| 76 | + "404": { | ||
| 77 | + "description": "Not found", | ||
| 78 | + "content": { | ||
| 79 | + "application/json": { | ||
| 80 | + "schema": { | ||
| 81 | + "$ref": "#/components/schemas/Error" | ||
| 82 | + } | ||
| 83 | + } | ||
| 84 | + } | ||
| 85 | + }, | ||
| 86 | + "default": { | ||
| 87 | + "description": "unexpected error", | ||
| 88 | + "content": { | ||
| 89 | + "application/json": { | ||
| 90 | + "schema": { | ||
| 91 | + "$ref": "#/components/schemas/Error" | ||
| 92 | + } | ||
| 93 | + } | ||
| 94 | + } | ||
| 95 | + } | ||
| 96 | + }, | ||
| 97 | + "summary": "", | ||
| 98 | + "tags": [ | ||
| 99 | + "Work" | ||
| 100 | + ], | ||
| 101 | + "parameters": [] | ||
| 102 | + } | ||
| 103 | + }, | ||
| 104 | + "/works": { | ||
| 105 | + "get": { | ||
| 106 | + "deprecated": false, | ||
| 107 | + "description": "", | ||
| 108 | + "responses": { | ||
| 109 | + "200": { | ||
| 110 | + "description": "response", | ||
| 111 | + "content": { | ||
| 112 | + "application/json": { | ||
| 113 | + "schema": { | ||
| 114 | + "type": "array", | ||
| 115 | + "items": { | ||
| 116 | + "$ref": "#/components/schemas/Work" | ||
| 117 | + } | ||
| 118 | + } | ||
| 119 | + } | ||
| 120 | + } | ||
| 121 | + }, | ||
| 122 | + "403": { | ||
| 123 | + "description": "Forbidden", | ||
| 124 | + "content": { | ||
| 125 | + "application/json": { | ||
| 126 | + "schema": { | ||
| 127 | + "$ref": "#/components/schemas/Error" | ||
| 128 | + } | ||
| 129 | + } | ||
| 130 | + } | ||
| 131 | + }, | ||
| 132 | + "404": { | ||
| 133 | + "description": "Not found", | ||
| 134 | + "content": { | ||
| 135 | + "application/json": { | ||
| 136 | + "schema": { | ||
| 137 | + "$ref": "#/components/schemas/Error" | ||
| 138 | + } | ||
| 139 | + } | ||
| 140 | + } | ||
| 141 | + }, | ||
| 142 | + "default": { | ||
| 143 | + "description": "unexpected error", | ||
| 144 | + "content": { | ||
| 145 | + "application/json": { | ||
| 146 | + "schema": { | ||
| 147 | + "$ref": "#/components/schemas/Error" | ||
| 148 | + } | ||
| 149 | + } | ||
| 150 | + } | ||
| 151 | + } | ||
| 152 | + }, | ||
| 153 | + "summary": "", | ||
| 154 | + "tags": [ | ||
| 155 | + "Work" | ||
| 156 | + ], | ||
| 157 | + "parameters": [ | ||
| 158 | + { | ||
| 159 | + "name": "_limit", | ||
| 160 | + "in": "query", | ||
| 161 | + "required": false, | ||
| 162 | + "description": "Maximum number of results possible", | ||
| 163 | + "schema": { | ||
| 164 | + "type": "integer" | ||
| 165 | + }, | ||
| 166 | + "deprecated": false | ||
| 167 | + }, | ||
| 168 | + { | ||
| 169 | + "name": "_sort", | ||
| 170 | + "in": "query", | ||
| 171 | + "required": false, | ||
| 172 | + "description": "Sort according to a specific field.", | ||
| 173 | + "schema": { | ||
| 174 | + "type": "string" | ||
| 175 | + }, | ||
| 176 | + "deprecated": false | ||
| 177 | + }, | ||
| 178 | + { | ||
| 179 | + "name": "_start", | ||
| 180 | + "in": "query", | ||
| 181 | + "required": false, | ||
| 182 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 183 | + "schema": { | ||
| 184 | + "type": "integer" | ||
| 185 | + }, | ||
| 186 | + "deprecated": false | ||
| 187 | + }, | ||
| 188 | + { | ||
| 189 | + "name": "=", | ||
| 190 | + "in": "query", | ||
| 191 | + "required": false, | ||
| 192 | + "description": "Get entries that matches exactly your input", | ||
| 193 | + "schema": { | ||
| 194 | + "type": "string" | ||
| 195 | + }, | ||
| 196 | + "deprecated": false | ||
| 197 | + }, | ||
| 198 | + { | ||
| 199 | + "name": "_ne", | ||
| 200 | + "in": "query", | ||
| 201 | + "required": false, | ||
| 202 | + "description": "Get records that are not equals to something", | ||
| 203 | + "schema": { | ||
| 204 | + "type": "string" | ||
| 205 | + }, | ||
| 206 | + "deprecated": false | ||
| 207 | + }, | ||
| 208 | + { | ||
| 209 | + "name": "_lt", | ||
| 210 | + "in": "query", | ||
| 211 | + "required": false, | ||
| 212 | + "description": "Get record that are lower than a value", | ||
| 213 | + "schema": { | ||
| 214 | + "type": "string" | ||
| 215 | + }, | ||
| 216 | + "deprecated": false | ||
| 217 | + }, | ||
| 218 | + { | ||
| 219 | + "name": "_lte", | ||
| 220 | + "in": "query", | ||
| 221 | + "required": false, | ||
| 222 | + "description": "Get records that are lower than or equal to a value", | ||
| 223 | + "schema": { | ||
| 224 | + "type": "string" | ||
| 225 | + }, | ||
| 226 | + "deprecated": false | ||
| 227 | + }, | ||
| 228 | + { | ||
| 229 | + "name": "_gt", | ||
| 230 | + "in": "query", | ||
| 231 | + "required": false, | ||
| 232 | + "description": "Get records that are greater than a value", | ||
| 233 | + "schema": { | ||
| 234 | + "type": "string" | ||
| 235 | + }, | ||
| 236 | + "deprecated": false | ||
| 237 | + }, | ||
| 238 | + { | ||
| 239 | + "name": "_gte", | ||
| 240 | + "in": "query", | ||
| 241 | + "required": false, | ||
| 242 | + "description": "Get records that are greater than or equal a value", | ||
| 243 | + "schema": { | ||
| 244 | + "type": "string" | ||
| 245 | + }, | ||
| 246 | + "deprecated": false | ||
| 247 | + }, | ||
| 248 | + { | ||
| 249 | + "name": "_contains", | ||
| 250 | + "in": "query", | ||
| 251 | + "required": false, | ||
| 252 | + "description": "Get records that contains a value", | ||
| 253 | + "schema": { | ||
| 254 | + "type": "string" | ||
| 255 | + }, | ||
| 256 | + "deprecated": false | ||
| 257 | + }, | ||
| 258 | + { | ||
| 259 | + "name": "_containss", | ||
| 260 | + "in": "query", | ||
| 261 | + "required": false, | ||
| 262 | + "description": "Get records that contains (case sensitive) a value", | ||
| 263 | + "schema": { | ||
| 264 | + "type": "string" | ||
| 265 | + }, | ||
| 266 | + "deprecated": false | ||
| 267 | + }, | ||
| 268 | + { | ||
| 269 | + "name": "_in", | ||
| 270 | + "in": "query", | ||
| 271 | + "required": false, | ||
| 272 | + "description": "Get records that matches any value in the array of values", | ||
| 273 | + "schema": { | ||
| 274 | + "type": "array" | ||
| 275 | + }, | ||
| 276 | + "deprecated": false | ||
| 277 | + }, | ||
| 278 | + { | ||
| 279 | + "name": "_nin", | ||
| 280 | + "in": "query", | ||
| 281 | + "required": false, | ||
| 282 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 283 | + "schema": { | ||
| 284 | + "type": "array" | ||
| 285 | + }, | ||
| 286 | + "deprecated": false | ||
| 287 | + } | ||
| 288 | + ] | ||
| 289 | + }, | ||
| 290 | + "post": { | ||
| 291 | + "deprecated": false, | ||
| 292 | + "description": "Create a new record", | ||
| 293 | + "responses": { | ||
| 294 | + "200": { | ||
| 295 | + "description": "response", | ||
| 296 | + "content": { | ||
| 297 | + "application/json": { | ||
| 298 | + "schema": { | ||
| 299 | + "$ref": "#/components/schemas/Work" | ||
| 300 | + } | ||
| 301 | + } | ||
| 302 | + } | ||
| 303 | + }, | ||
| 304 | + "403": { | ||
| 305 | + "description": "Forbidden", | ||
| 306 | + "content": { | ||
| 307 | + "application/json": { | ||
| 308 | + "schema": { | ||
| 309 | + "$ref": "#/components/schemas/Error" | ||
| 310 | + } | ||
| 311 | + } | ||
| 312 | + } | ||
| 313 | + }, | ||
| 314 | + "404": { | ||
| 315 | + "description": "Not found", | ||
| 316 | + "content": { | ||
| 317 | + "application/json": { | ||
| 318 | + "schema": { | ||
| 319 | + "$ref": "#/components/schemas/Error" | ||
| 320 | + } | ||
| 321 | + } | ||
| 322 | + } | ||
| 323 | + }, | ||
| 324 | + "default": { | ||
| 325 | + "description": "unexpected error", | ||
| 326 | + "content": { | ||
| 327 | + "application/json": { | ||
| 328 | + "schema": { | ||
| 329 | + "$ref": "#/components/schemas/Error" | ||
| 330 | + } | ||
| 331 | + } | ||
| 332 | + } | ||
| 333 | + } | ||
| 334 | + }, | ||
| 335 | + "summary": "", | ||
| 336 | + "tags": [ | ||
| 337 | + "Work" | ||
| 338 | + ], | ||
| 339 | + "requestBody": { | ||
| 340 | + "description": "", | ||
| 341 | + "required": true, | ||
| 342 | + "content": { | ||
| 343 | + "application/json": { | ||
| 344 | + "schema": { | ||
| 345 | + "$ref": "#/components/schemas/NewWork" | ||
| 346 | + } | ||
| 347 | + } | ||
| 348 | + } | ||
| 349 | + } | ||
| 350 | + } | ||
| 351 | + }, | ||
| 352 | + "/works/count": { | ||
| 353 | + "get": { | ||
| 354 | + "deprecated": false, | ||
| 355 | + "description": "", | ||
| 356 | + "responses": { | ||
| 357 | + "200": { | ||
| 358 | + "description": "response", | ||
| 359 | + "content": { | ||
| 360 | + "application/json": { | ||
| 361 | + "schema": { | ||
| 362 | + "properties": { | ||
| 363 | + "count": { | ||
| 364 | + "type": "integer" | ||
| 365 | + } | ||
| 366 | + } | ||
| 367 | + } | ||
| 368 | + } | ||
| 369 | + } | ||
| 370 | + }, | ||
| 371 | + "403": { | ||
| 372 | + "description": "Forbidden", | ||
| 373 | + "content": { | ||
| 374 | + "application/json": { | ||
| 375 | + "schema": { | ||
| 376 | + "$ref": "#/components/schemas/Error" | ||
| 377 | + } | ||
| 378 | + } | ||
| 379 | + } | ||
| 380 | + }, | ||
| 381 | + "404": { | ||
| 382 | + "description": "Not found", | ||
| 383 | + "content": { | ||
| 384 | + "application/json": { | ||
| 385 | + "schema": { | ||
| 386 | + "$ref": "#/components/schemas/Error" | ||
| 387 | + } | ||
| 388 | + } | ||
| 389 | + } | ||
| 390 | + }, | ||
| 391 | + "default": { | ||
| 392 | + "description": "unexpected error", | ||
| 393 | + "content": { | ||
| 394 | + "application/json": { | ||
| 395 | + "schema": { | ||
| 396 | + "$ref": "#/components/schemas/Error" | ||
| 397 | + } | ||
| 398 | + } | ||
| 399 | + } | ||
| 400 | + } | ||
| 401 | + }, | ||
| 402 | + "summary": "", | ||
| 403 | + "tags": [ | ||
| 404 | + "Work" | ||
| 405 | + ], | ||
| 406 | + "parameters": [] | ||
| 407 | + } | ||
| 408 | + }, | ||
| 409 | + "/works/{id}": { | ||
| 410 | + "get": { | ||
| 411 | + "deprecated": false, | ||
| 412 | + "description": "", | ||
| 413 | + "responses": { | ||
| 414 | + "200": { | ||
| 415 | + "description": "response", | ||
| 416 | + "content": { | ||
| 417 | + "application/json": { | ||
| 418 | + "schema": { | ||
| 419 | + "$ref": "#/components/schemas/Work" | ||
| 420 | + } | ||
| 421 | + } | ||
| 422 | + } | ||
| 423 | + }, | ||
| 424 | + "403": { | ||
| 425 | + "description": "Forbidden", | ||
| 426 | + "content": { | ||
| 427 | + "application/json": { | ||
| 428 | + "schema": { | ||
| 429 | + "$ref": "#/components/schemas/Error" | ||
| 430 | + } | ||
| 431 | + } | ||
| 432 | + } | ||
| 433 | + }, | ||
| 434 | + "404": { | ||
| 435 | + "description": "Not found", | ||
| 436 | + "content": { | ||
| 437 | + "application/json": { | ||
| 438 | + "schema": { | ||
| 439 | + "$ref": "#/components/schemas/Error" | ||
| 440 | + } | ||
| 441 | + } | ||
| 442 | + } | ||
| 443 | + }, | ||
| 444 | + "default": { | ||
| 445 | + "description": "unexpected error", | ||
| 446 | + "content": { | ||
| 447 | + "application/json": { | ||
| 448 | + "schema": { | ||
| 449 | + "$ref": "#/components/schemas/Error" | ||
| 450 | + } | ||
| 451 | + } | ||
| 452 | + } | ||
| 453 | + } | ||
| 454 | + }, | ||
| 455 | + "summary": "", | ||
| 456 | + "tags": [ | ||
| 457 | + "Work" | ||
| 458 | + ], | ||
| 459 | + "parameters": [ | ||
| 460 | + { | ||
| 461 | + "name": "id", | ||
| 462 | + "in": "path", | ||
| 463 | + "description": "", | ||
| 464 | + "deprecated": false, | ||
| 465 | + "required": true, | ||
| 466 | + "schema": { | ||
| 467 | + "type": "string" | ||
| 468 | + } | ||
| 469 | + } | ||
| 470 | + ] | ||
| 471 | + }, | ||
| 472 | + "put": { | ||
| 473 | + "deprecated": false, | ||
| 474 | + "description": "Update a record", | ||
| 475 | + "responses": { | ||
| 476 | + "200": { | ||
| 477 | + "description": "response", | ||
| 478 | + "content": { | ||
| 479 | + "application/json": { | ||
| 480 | + "schema": { | ||
| 481 | + "$ref": "#/components/schemas/Work" | ||
| 482 | + } | ||
| 483 | + } | ||
| 484 | + } | ||
| 485 | + }, | ||
| 486 | + "403": { | ||
| 487 | + "description": "Forbidden", | ||
| 488 | + "content": { | ||
| 489 | + "application/json": { | ||
| 490 | + "schema": { | ||
| 491 | + "$ref": "#/components/schemas/Error" | ||
| 492 | + } | ||
| 493 | + } | ||
| 494 | + } | ||
| 495 | + }, | ||
| 496 | + "404": { | ||
| 497 | + "description": "Not found", | ||
| 498 | + "content": { | ||
| 499 | + "application/json": { | ||
| 500 | + "schema": { | ||
| 501 | + "$ref": "#/components/schemas/Error" | ||
| 502 | + } | ||
| 503 | + } | ||
| 504 | + } | ||
| 505 | + }, | ||
| 506 | + "default": { | ||
| 507 | + "description": "unexpected error", | ||
| 508 | + "content": { | ||
| 509 | + "application/json": { | ||
| 510 | + "schema": { | ||
| 511 | + "$ref": "#/components/schemas/Error" | ||
| 512 | + } | ||
| 513 | + } | ||
| 514 | + } | ||
| 515 | + } | ||
| 516 | + }, | ||
| 517 | + "summary": "", | ||
| 518 | + "tags": [ | ||
| 519 | + "Work" | ||
| 520 | + ], | ||
| 521 | + "requestBody": { | ||
| 522 | + "description": "", | ||
| 523 | + "required": true, | ||
| 524 | + "content": { | ||
| 525 | + "application/json": { | ||
| 526 | + "schema": { | ||
| 527 | + "$ref": "#/components/schemas/NewWork" | ||
| 528 | + } | ||
| 529 | + } | ||
| 530 | + } | ||
| 531 | + }, | ||
| 532 | + "parameters": [ | ||
| 533 | + { | ||
| 534 | + "name": "id", | ||
| 535 | + "in": "path", | ||
| 536 | + "description": "", | ||
| 537 | + "deprecated": false, | ||
| 538 | + "required": true, | ||
| 539 | + "schema": { | ||
| 540 | + "type": "string" | ||
| 541 | + } | ||
| 542 | + } | ||
| 543 | + ] | ||
| 544 | + }, | ||
| 545 | + "delete": { | ||
| 546 | + "deprecated": false, | ||
| 547 | + "description": "Delete a record", | ||
| 548 | + "responses": { | ||
| 549 | + "200": { | ||
| 550 | + "description": "deletes a single record based on the ID supplied", | ||
| 551 | + "content": { | ||
| 552 | + "application/json": { | ||
| 553 | + "schema": { | ||
| 554 | + "type": "integer", | ||
| 555 | + "format": "int64" | ||
| 556 | + } | ||
| 557 | + } | ||
| 558 | + } | ||
| 559 | + }, | ||
| 560 | + "403": { | ||
| 561 | + "description": "Forbidden", | ||
| 562 | + "content": { | ||
| 563 | + "application/json": { | ||
| 564 | + "schema": { | ||
| 565 | + "$ref": "#/components/schemas/Error" | ||
| 566 | + } | ||
| 567 | + } | ||
| 568 | + } | ||
| 569 | + }, | ||
| 570 | + "404": { | ||
| 571 | + "description": "Not found", | ||
| 572 | + "content": { | ||
| 573 | + "application/json": { | ||
| 574 | + "schema": { | ||
| 575 | + "$ref": "#/components/schemas/Error" | ||
| 576 | + } | ||
| 577 | + } | ||
| 578 | + } | ||
| 579 | + }, | ||
| 580 | + "default": { | ||
| 581 | + "description": "unexpected error", | ||
| 582 | + "content": { | ||
| 583 | + "application/json": { | ||
| 584 | + "schema": { | ||
| 585 | + "$ref": "#/components/schemas/Error" | ||
| 586 | + } | ||
| 587 | + } | ||
| 588 | + } | ||
| 589 | + } | ||
| 590 | + }, | ||
| 591 | + "summary": "", | ||
| 592 | + "tags": [ | ||
| 593 | + "Work" | ||
| 594 | + ], | ||
| 595 | + "parameters": [ | ||
| 596 | + { | ||
| 597 | + "name": "id", | ||
| 598 | + "in": "path", | ||
| 599 | + "description": "", | ||
| 600 | + "deprecated": false, | ||
| 601 | + "required": true, | ||
| 602 | + "schema": { | ||
| 603 | + "type": "string" | ||
| 604 | + } | ||
| 605 | + } | ||
| 606 | + ] | ||
| 607 | + } | ||
| 608 | + }, | ||
| 609 | + "/works/preview/{id}": { | ||
| 610 | + "get": { | ||
| 611 | + "deprecated": false, | ||
| 612 | + "description": "", | ||
| 613 | + "responses": { | ||
| 614 | + "200": { | ||
| 615 | + "description": "response", | ||
| 616 | + "content": { | ||
| 617 | + "application/json": { | ||
| 618 | + "schema": { | ||
| 619 | + "properties": { | ||
| 620 | + "foo": { | ||
| 621 | + "type": "string" | ||
| 622 | + } | ||
| 623 | + } | ||
| 624 | + } | ||
| 625 | + } | ||
| 626 | + } | ||
| 627 | + }, | ||
| 628 | + "403": { | ||
| 629 | + "description": "Forbidden", | ||
| 630 | + "content": { | ||
| 631 | + "application/json": { | ||
| 632 | + "schema": { | ||
| 633 | + "$ref": "#/components/schemas/Error" | ||
| 634 | + } | ||
| 635 | + } | ||
| 636 | + } | ||
| 637 | + }, | ||
| 638 | + "404": { | ||
| 639 | + "description": "Not found", | ||
| 640 | + "content": { | ||
| 641 | + "application/json": { | ||
| 642 | + "schema": { | ||
| 643 | + "$ref": "#/components/schemas/Error" | ||
| 644 | + } | ||
| 645 | + } | ||
| 646 | + } | ||
| 647 | + }, | ||
| 648 | + "default": { | ||
| 649 | + "description": "unexpected error", | ||
| 650 | + "content": { | ||
| 651 | + "application/json": { | ||
| 652 | + "schema": { | ||
| 653 | + "$ref": "#/components/schemas/Error" | ||
| 654 | + } | ||
| 655 | + } | ||
| 656 | + } | ||
| 657 | + } | ||
| 658 | + }, | ||
| 659 | + "summary": "", | ||
| 660 | + "tags": [ | ||
| 661 | + "Work" | ||
| 662 | + ], | ||
| 663 | + "parameters": [ | ||
| 664 | + { | ||
| 665 | + "name": "id", | ||
| 666 | + "in": "path", | ||
| 667 | + "description": "", | ||
| 668 | + "deprecated": false, | ||
| 669 | + "required": true, | ||
| 670 | + "schema": { | ||
| 671 | + "type": "string" | ||
| 672 | + } | ||
| 673 | + } | ||
| 674 | + ] | ||
| 675 | + } | ||
| 676 | + }, | ||
| 677 | + "/works/form/submit/{id}": { | ||
| 678 | + "post": { | ||
| 679 | + "deprecated": false, | ||
| 680 | + "description": "Create a new record", | ||
| 681 | + "responses": { | ||
| 682 | + "200": { | ||
| 683 | + "description": "response", | ||
| 684 | + "content": { | ||
| 685 | + "application/json": { | ||
| 686 | + "schema": { | ||
| 687 | + "properties": { | ||
| 688 | + "foo": { | ||
| 689 | + "type": "string" | ||
| 690 | + } | ||
| 691 | + } | ||
| 692 | + } | ||
| 693 | + } | ||
| 694 | + } | ||
| 695 | + }, | ||
| 696 | + "403": { | ||
| 697 | + "description": "Forbidden", | ||
| 698 | + "content": { | ||
| 699 | + "application/json": { | ||
| 700 | + "schema": { | ||
| 701 | + "$ref": "#/components/schemas/Error" | ||
| 702 | + } | ||
| 703 | + } | ||
| 704 | + } | ||
| 705 | + }, | ||
| 706 | + "404": { | ||
| 707 | + "description": "Not found", | ||
| 708 | + "content": { | ||
| 709 | + "application/json": { | ||
| 710 | + "schema": { | ||
| 711 | + "$ref": "#/components/schemas/Error" | ||
| 712 | + } | ||
| 713 | + } | ||
| 714 | + } | ||
| 715 | + }, | ||
| 716 | + "default": { | ||
| 717 | + "description": "unexpected error", | ||
| 718 | + "content": { | ||
| 719 | + "application/json": { | ||
| 720 | + "schema": { | ||
| 721 | + "$ref": "#/components/schemas/Error" | ||
| 722 | + } | ||
| 723 | + } | ||
| 724 | + } | ||
| 725 | + } | ||
| 726 | + }, | ||
| 727 | + "summary": "", | ||
| 728 | + "tags": [ | ||
| 729 | + "Work" | ||
| 730 | + ], | ||
| 731 | + "requestBody": { | ||
| 732 | + "description": "", | ||
| 733 | + "required": true, | ||
| 734 | + "content": { | ||
| 735 | + "application/json": { | ||
| 736 | + "schema": { | ||
| 737 | + "properties": { | ||
| 738 | + "foo": { | ||
| 739 | + "type": "string" | ||
| 740 | + } | ||
| 741 | + } | ||
| 742 | + } | ||
| 743 | + } | ||
| 744 | + } | ||
| 745 | + } | ||
| 746 | + } | ||
| 747 | + }, | ||
| 748 | + "/works/form/query/{id}": { | ||
| 749 | + "get": { | ||
| 750 | + "deprecated": false, | ||
| 751 | + "description": "", | ||
| 752 | + "responses": { | ||
| 753 | + "200": { | ||
| 754 | + "description": "response", | ||
| 755 | + "content": { | ||
| 756 | + "application/json": { | ||
| 757 | + "schema": { | ||
| 758 | + "properties": { | ||
| 759 | + "foo": { | ||
| 760 | + "type": "string" | ||
| 761 | + } | ||
| 762 | + } | ||
| 763 | + } | ||
| 764 | + } | ||
| 765 | + } | ||
| 766 | + }, | ||
| 767 | + "403": { | ||
| 768 | + "description": "Forbidden", | ||
| 769 | + "content": { | ||
| 770 | + "application/json": { | ||
| 771 | + "schema": { | ||
| 772 | + "$ref": "#/components/schemas/Error" | ||
| 773 | + } | ||
| 774 | + } | ||
| 775 | + } | ||
| 776 | + }, | ||
| 777 | + "404": { | ||
| 778 | + "description": "Not found", | ||
| 779 | + "content": { | ||
| 780 | + "application/json": { | ||
| 781 | + "schema": { | ||
| 782 | + "$ref": "#/components/schemas/Error" | ||
| 783 | + } | ||
| 784 | + } | ||
| 785 | + } | ||
| 786 | + }, | ||
| 787 | + "default": { | ||
| 788 | + "description": "unexpected error", | ||
| 789 | + "content": { | ||
| 790 | + "application/json": { | ||
| 791 | + "schema": { | ||
| 792 | + "$ref": "#/components/schemas/Error" | ||
| 793 | + } | ||
| 794 | + } | ||
| 795 | + } | ||
| 796 | + } | ||
| 797 | + }, | ||
| 798 | + "summary": "", | ||
| 799 | + "tags": [ | ||
| 800 | + "Work" | ||
| 801 | + ], | ||
| 802 | + "parameters": [ | ||
| 803 | + { | ||
| 804 | + "name": "id", | ||
| 805 | + "in": "path", | ||
| 806 | + "description": "", | ||
| 807 | + "deprecated": false, | ||
| 808 | + "required": true, | ||
| 809 | + "schema": { | ||
| 810 | + "type": "string" | ||
| 811 | + } | ||
| 812 | + } | ||
| 813 | + ] | ||
| 814 | + } | ||
| 815 | + }, | ||
| 816 | + "/works/set-as-template/{id}": { | ||
| 817 | + "post": { | ||
| 818 | + "deprecated": false, | ||
| 819 | + "description": "Create a new record", | ||
| 820 | + "responses": { | ||
| 821 | + "200": { | ||
| 822 | + "description": "response", | ||
| 823 | + "content": { | ||
| 824 | + "application/json": { | ||
| 825 | + "schema": { | ||
| 826 | + "properties": { | ||
| 827 | + "foo": { | ||
| 828 | + "type": "string" | ||
| 829 | + } | ||
| 830 | + } | ||
| 831 | + } | ||
| 832 | + } | ||
| 833 | + } | ||
| 834 | + }, | ||
| 835 | + "403": { | ||
| 836 | + "description": "Forbidden", | ||
| 837 | + "content": { | ||
| 838 | + "application/json": { | ||
| 839 | + "schema": { | ||
| 840 | + "$ref": "#/components/schemas/Error" | ||
| 841 | + } | ||
| 842 | + } | ||
| 843 | + } | ||
| 844 | + }, | ||
| 845 | + "404": { | ||
| 846 | + "description": "Not found", | ||
| 847 | + "content": { | ||
| 848 | + "application/json": { | ||
| 849 | + "schema": { | ||
| 850 | + "$ref": "#/components/schemas/Error" | ||
| 851 | + } | ||
| 852 | + } | ||
| 853 | + } | ||
| 854 | + }, | ||
| 855 | + "default": { | ||
| 856 | + "description": "unexpected error", | ||
| 857 | + "content": { | ||
| 858 | + "application/json": { | ||
| 859 | + "schema": { | ||
| 860 | + "$ref": "#/components/schemas/Error" | ||
| 861 | + } | ||
| 862 | + } | ||
| 863 | + } | ||
| 864 | + } | ||
| 865 | + }, | ||
| 866 | + "summary": "", | ||
| 867 | + "tags": [ | ||
| 868 | + "Work" | ||
| 869 | + ], | ||
| 870 | + "requestBody": { | ||
| 871 | + "description": "", | ||
| 872 | + "required": true, | ||
| 873 | + "content": { | ||
| 874 | + "application/json": { | ||
| 875 | + "schema": { | ||
| 876 | + "properties": { | ||
| 877 | + "foo": { | ||
| 878 | + "type": "string" | ||
| 879 | + } | ||
| 880 | + } | ||
| 881 | + } | ||
| 882 | + } | ||
| 883 | + } | ||
| 884 | + } | ||
| 885 | + } | ||
| 886 | + }, | ||
| 887 | + "/works/use-template/{id}": { | ||
| 888 | + "post": { | ||
| 889 | + "deprecated": false, | ||
| 890 | + "description": "Create a new record", | ||
| 891 | + "responses": { | ||
| 892 | + "200": { | ||
| 893 | + "description": "response", | ||
| 894 | + "content": { | ||
| 895 | + "application/json": { | ||
| 896 | + "schema": { | ||
| 897 | + "properties": { | ||
| 898 | + "foo": { | ||
| 899 | + "type": "string" | ||
| 900 | + } | ||
| 901 | + } | ||
| 902 | + } | ||
| 903 | + } | ||
| 904 | + } | ||
| 905 | + }, | ||
| 906 | + "403": { | ||
| 907 | + "description": "Forbidden", | ||
| 908 | + "content": { | ||
| 909 | + "application/json": { | ||
| 910 | + "schema": { | ||
| 911 | + "$ref": "#/components/schemas/Error" | ||
| 912 | + } | ||
| 913 | + } | ||
| 914 | + } | ||
| 915 | + }, | ||
| 916 | + "404": { | ||
| 917 | + "description": "Not found", | ||
| 918 | + "content": { | ||
| 919 | + "application/json": { | ||
| 920 | + "schema": { | ||
| 921 | + "$ref": "#/components/schemas/Error" | ||
| 922 | + } | ||
| 923 | + } | ||
| 924 | + } | ||
| 925 | + }, | ||
| 926 | + "default": { | ||
| 927 | + "description": "unexpected error", | ||
| 928 | + "content": { | ||
| 929 | + "application/json": { | ||
| 930 | + "schema": { | ||
| 931 | + "$ref": "#/components/schemas/Error" | ||
| 932 | + } | ||
| 933 | + } | ||
| 934 | + } | ||
| 935 | + } | ||
| 936 | + }, | ||
| 937 | + "summary": "", | ||
| 938 | + "tags": [ | ||
| 939 | + "Work" | ||
| 940 | + ], | ||
| 941 | + "requestBody": { | ||
| 942 | + "description": "", | ||
| 943 | + "required": true, | ||
| 944 | + "content": { | ||
| 945 | + "application/json": { | ||
| 946 | + "schema": { | ||
| 947 | + "properties": { | ||
| 948 | + "foo": { | ||
| 949 | + "type": "string" | ||
| 950 | + } | ||
| 951 | + } | ||
| 952 | + } | ||
| 953 | + } | ||
| 954 | + } | ||
| 955 | + } | ||
| 956 | + } | ||
| 957 | + }, | ||
| 958 | + "/workforms": { | ||
| 959 | + "get": { | ||
| 960 | + "deprecated": false, | ||
| 961 | + "description": "", | ||
| 962 | + "responses": { | ||
| 963 | + "200": { | ||
| 964 | + "description": "response", | ||
| 965 | + "content": { | ||
| 966 | + "application/json": { | ||
| 967 | + "schema": { | ||
| 968 | + "type": "array", | ||
| 969 | + "items": { | ||
| 970 | + "$ref": "#/components/schemas/Workform" | ||
| 971 | + } | ||
| 972 | + } | ||
| 973 | + } | ||
| 974 | + } | ||
| 975 | + }, | ||
| 976 | + "403": { | ||
| 977 | + "description": "Forbidden", | ||
| 978 | + "content": { | ||
| 979 | + "application/json": { | ||
| 980 | + "schema": { | ||
| 981 | + "$ref": "#/components/schemas/Error" | ||
| 982 | + } | ||
| 983 | + } | ||
| 984 | + } | ||
| 985 | + }, | ||
| 986 | + "404": { | ||
| 987 | + "description": "Not found", | ||
| 988 | + "content": { | ||
| 989 | + "application/json": { | ||
| 990 | + "schema": { | ||
| 991 | + "$ref": "#/components/schemas/Error" | ||
| 992 | + } | ||
| 993 | + } | ||
| 994 | + } | ||
| 995 | + }, | ||
| 996 | + "default": { | ||
| 997 | + "description": "unexpected error", | ||
| 998 | + "content": { | ||
| 999 | + "application/json": { | ||
| 1000 | + "schema": { | ||
| 1001 | + "$ref": "#/components/schemas/Error" | ||
| 1002 | + } | ||
| 1003 | + } | ||
| 1004 | + } | ||
| 1005 | + } | ||
| 1006 | + }, | ||
| 1007 | + "summary": "", | ||
| 1008 | + "tags": [ | ||
| 1009 | + "Workform" | ||
| 1010 | + ], | ||
| 1011 | + "parameters": [ | ||
| 1012 | + { | ||
| 1013 | + "name": "_limit", | ||
| 1014 | + "in": "query", | ||
| 1015 | + "required": false, | ||
| 1016 | + "description": "Maximum number of results possible", | ||
| 1017 | + "schema": { | ||
| 1018 | + "type": "integer" | ||
| 1019 | + }, | ||
| 1020 | + "deprecated": false | ||
| 1021 | + }, | ||
| 1022 | + { | ||
| 1023 | + "name": "_sort", | ||
| 1024 | + "in": "query", | ||
| 1025 | + "required": false, | ||
| 1026 | + "description": "Sort according to a specific field.", | ||
| 1027 | + "schema": { | ||
| 1028 | + "type": "string" | ||
| 1029 | + }, | ||
| 1030 | + "deprecated": false | ||
| 1031 | + }, | ||
| 1032 | + { | ||
| 1033 | + "name": "_start", | ||
| 1034 | + "in": "query", | ||
| 1035 | + "required": false, | ||
| 1036 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 1037 | + "schema": { | ||
| 1038 | + "type": "integer" | ||
| 1039 | + }, | ||
| 1040 | + "deprecated": false | ||
| 1041 | + }, | ||
| 1042 | + { | ||
| 1043 | + "name": "=", | ||
| 1044 | + "in": "query", | ||
| 1045 | + "required": false, | ||
| 1046 | + "description": "Get entries that matches exactly your input", | ||
| 1047 | + "schema": { | ||
| 1048 | + "type": "string" | ||
| 1049 | + }, | ||
| 1050 | + "deprecated": false | ||
| 1051 | + }, | ||
| 1052 | + { | ||
| 1053 | + "name": "_ne", | ||
| 1054 | + "in": "query", | ||
| 1055 | + "required": false, | ||
| 1056 | + "description": "Get records that are not equals to something", | ||
| 1057 | + "schema": { | ||
| 1058 | + "type": "string" | ||
| 1059 | + }, | ||
| 1060 | + "deprecated": false | ||
| 1061 | + }, | ||
| 1062 | + { | ||
| 1063 | + "name": "_lt", | ||
| 1064 | + "in": "query", | ||
| 1065 | + "required": false, | ||
| 1066 | + "description": "Get record that are lower than a value", | ||
| 1067 | + "schema": { | ||
| 1068 | + "type": "string" | ||
| 1069 | + }, | ||
| 1070 | + "deprecated": false | ||
| 1071 | + }, | ||
| 1072 | + { | ||
| 1073 | + "name": "_lte", | ||
| 1074 | + "in": "query", | ||
| 1075 | + "required": false, | ||
| 1076 | + "description": "Get records that are lower than or equal to a value", | ||
| 1077 | + "schema": { | ||
| 1078 | + "type": "string" | ||
| 1079 | + }, | ||
| 1080 | + "deprecated": false | ||
| 1081 | + }, | ||
| 1082 | + { | ||
| 1083 | + "name": "_gt", | ||
| 1084 | + "in": "query", | ||
| 1085 | + "required": false, | ||
| 1086 | + "description": "Get records that are greater than a value", | ||
| 1087 | + "schema": { | ||
| 1088 | + "type": "string" | ||
| 1089 | + }, | ||
| 1090 | + "deprecated": false | ||
| 1091 | + }, | ||
| 1092 | + { | ||
| 1093 | + "name": "_gte", | ||
| 1094 | + "in": "query", | ||
| 1095 | + "required": false, | ||
| 1096 | + "description": "Get records that are greater than or equal a value", | ||
| 1097 | + "schema": { | ||
| 1098 | + "type": "string" | ||
| 1099 | + }, | ||
| 1100 | + "deprecated": false | ||
| 1101 | + }, | ||
| 1102 | + { | ||
| 1103 | + "name": "_contains", | ||
| 1104 | + "in": "query", | ||
| 1105 | + "required": false, | ||
| 1106 | + "description": "Get records that contains a value", | ||
| 1107 | + "schema": { | ||
| 1108 | + "type": "string" | ||
| 1109 | + }, | ||
| 1110 | + "deprecated": false | ||
| 1111 | + }, | ||
| 1112 | + { | ||
| 1113 | + "name": "_containss", | ||
| 1114 | + "in": "query", | ||
| 1115 | + "required": false, | ||
| 1116 | + "description": "Get records that contains (case sensitive) a value", | ||
| 1117 | + "schema": { | ||
| 1118 | + "type": "string" | ||
| 1119 | + }, | ||
| 1120 | + "deprecated": false | ||
| 1121 | + }, | ||
| 1122 | + { | ||
| 1123 | + "name": "_in", | ||
| 1124 | + "in": "query", | ||
| 1125 | + "required": false, | ||
| 1126 | + "description": "Get records that matches any value in the array of values", | ||
| 1127 | + "schema": { | ||
| 1128 | + "type": "array" | ||
| 1129 | + }, | ||
| 1130 | + "deprecated": false | ||
| 1131 | + }, | ||
| 1132 | + { | ||
| 1133 | + "name": "_nin", | ||
| 1134 | + "in": "query", | ||
| 1135 | + "required": false, | ||
| 1136 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 1137 | + "schema": { | ||
| 1138 | + "type": "array" | ||
| 1139 | + }, | ||
| 1140 | + "deprecated": false | ||
| 1141 | + } | ||
| 1142 | + ] | ||
| 1143 | + }, | ||
| 1144 | + "post": { | ||
| 1145 | + "deprecated": false, | ||
| 1146 | + "description": "Create a new record", | ||
| 1147 | + "responses": { | ||
| 1148 | + "200": { | ||
| 1149 | + "description": "response", | ||
| 1150 | + "content": { | ||
| 1151 | + "application/json": { | ||
| 1152 | + "schema": { | ||
| 1153 | + "$ref": "#/components/schemas/Workform" | ||
| 1154 | + } | ||
| 1155 | + } | ||
| 1156 | + } | ||
| 1157 | + }, | ||
| 1158 | + "403": { | ||
| 1159 | + "description": "Forbidden", | ||
| 1160 | + "content": { | ||
| 1161 | + "application/json": { | ||
| 1162 | + "schema": { | ||
| 1163 | + "$ref": "#/components/schemas/Error" | ||
| 1164 | + } | ||
| 1165 | + } | ||
| 1166 | + } | ||
| 1167 | + }, | ||
| 1168 | + "404": { | ||
| 1169 | + "description": "Not found", | ||
| 1170 | + "content": { | ||
| 1171 | + "application/json": { | ||
| 1172 | + "schema": { | ||
| 1173 | + "$ref": "#/components/schemas/Error" | ||
| 1174 | + } | ||
| 1175 | + } | ||
| 1176 | + } | ||
| 1177 | + }, | ||
| 1178 | + "default": { | ||
| 1179 | + "description": "unexpected error", | ||
| 1180 | + "content": { | ||
| 1181 | + "application/json": { | ||
| 1182 | + "schema": { | ||
| 1183 | + "$ref": "#/components/schemas/Error" | ||
| 1184 | + } | ||
| 1185 | + } | ||
| 1186 | + } | ||
| 1187 | + } | ||
| 1188 | + }, | ||
| 1189 | + "summary": "", | ||
| 1190 | + "tags": [ | ||
| 1191 | + "Workform" | ||
| 1192 | + ], | ||
| 1193 | + "requestBody": { | ||
| 1194 | + "description": "", | ||
| 1195 | + "required": true, | ||
| 1196 | + "content": { | ||
| 1197 | + "application/json": { | ||
| 1198 | + "schema": { | ||
| 1199 | + "$ref": "#/components/schemas/NewWorkform" | ||
| 1200 | + } | ||
| 1201 | + } | ||
| 1202 | + } | ||
| 1203 | + } | ||
| 1204 | + } | ||
| 1205 | + }, | ||
| 1206 | + "/workforms/count": { | ||
| 1207 | + "get": { | ||
| 1208 | + "deprecated": false, | ||
| 1209 | + "description": "", | ||
| 1210 | + "responses": { | ||
| 1211 | + "200": { | ||
| 1212 | + "description": "response", | ||
| 1213 | + "content": { | ||
| 1214 | + "application/json": { | ||
| 1215 | + "schema": { | ||
| 1216 | + "properties": { | ||
| 1217 | + "count": { | ||
| 1218 | + "type": "integer" | ||
| 1219 | + } | ||
| 1220 | + } | ||
| 1221 | + } | ||
| 1222 | + } | ||
| 1223 | + } | ||
| 1224 | + }, | ||
| 1225 | + "403": { | ||
| 1226 | + "description": "Forbidden", | ||
| 1227 | + "content": { | ||
| 1228 | + "application/json": { | ||
| 1229 | + "schema": { | ||
| 1230 | + "$ref": "#/components/schemas/Error" | ||
| 1231 | + } | ||
| 1232 | + } | ||
| 1233 | + } | ||
| 1234 | + }, | ||
| 1235 | + "404": { | ||
| 1236 | + "description": "Not found", | ||
| 1237 | + "content": { | ||
| 1238 | + "application/json": { | ||
| 1239 | + "schema": { | ||
| 1240 | + "$ref": "#/components/schemas/Error" | ||
| 1241 | + } | ||
| 1242 | + } | ||
| 1243 | + } | ||
| 1244 | + }, | ||
| 1245 | + "default": { | ||
| 1246 | + "description": "unexpected error", | ||
| 1247 | + "content": { | ||
| 1248 | + "application/json": { | ||
| 1249 | + "schema": { | ||
| 1250 | + "$ref": "#/components/schemas/Error" | ||
| 1251 | + } | ||
| 1252 | + } | ||
| 1253 | + } | ||
| 1254 | + } | ||
| 1255 | + }, | ||
| 1256 | + "summary": "", | ||
| 1257 | + "tags": [ | ||
| 1258 | + "Workform" | ||
| 1259 | + ], | ||
| 1260 | + "parameters": [] | ||
| 1261 | + } | ||
| 1262 | + }, | ||
| 1263 | + "/workforms/{id}": { | ||
| 1264 | + "get": { | ||
| 1265 | + "deprecated": false, | ||
| 1266 | + "description": "", | ||
| 1267 | + "responses": { | ||
| 1268 | + "200": { | ||
| 1269 | + "description": "response", | ||
| 1270 | + "content": { | ||
| 1271 | + "application/json": { | ||
| 1272 | + "schema": { | ||
| 1273 | + "$ref": "#/components/schemas/Workform" | ||
| 1274 | + } | ||
| 1275 | + } | ||
| 1276 | + } | ||
| 1277 | + }, | ||
| 1278 | + "403": { | ||
| 1279 | + "description": "Forbidden", | ||
| 1280 | + "content": { | ||
| 1281 | + "application/json": { | ||
| 1282 | + "schema": { | ||
| 1283 | + "$ref": "#/components/schemas/Error" | ||
| 1284 | + } | ||
| 1285 | + } | ||
| 1286 | + } | ||
| 1287 | + }, | ||
| 1288 | + "404": { | ||
| 1289 | + "description": "Not found", | ||
| 1290 | + "content": { | ||
| 1291 | + "application/json": { | ||
| 1292 | + "schema": { | ||
| 1293 | + "$ref": "#/components/schemas/Error" | ||
| 1294 | + } | ||
| 1295 | + } | ||
| 1296 | + } | ||
| 1297 | + }, | ||
| 1298 | + "default": { | ||
| 1299 | + "description": "unexpected error", | ||
| 1300 | + "content": { | ||
| 1301 | + "application/json": { | ||
| 1302 | + "schema": { | ||
| 1303 | + "$ref": "#/components/schemas/Error" | ||
| 1304 | + } | ||
| 1305 | + } | ||
| 1306 | + } | ||
| 1307 | + } | ||
| 1308 | + }, | ||
| 1309 | + "summary": "", | ||
| 1310 | + "tags": [ | ||
| 1311 | + "Workform" | ||
| 1312 | + ], | ||
| 1313 | + "parameters": [ | ||
| 1314 | + { | ||
| 1315 | + "name": "id", | ||
| 1316 | + "in": "path", | ||
| 1317 | + "description": "", | ||
| 1318 | + "deprecated": false, | ||
| 1319 | + "required": true, | ||
| 1320 | + "schema": { | ||
| 1321 | + "type": "string" | ||
| 1322 | + } | ||
| 1323 | + } | ||
| 1324 | + ] | ||
| 1325 | + }, | ||
| 1326 | + "put": { | ||
| 1327 | + "deprecated": false, | ||
| 1328 | + "description": "Update a record", | ||
| 1329 | + "responses": { | ||
| 1330 | + "200": { | ||
| 1331 | + "description": "response", | ||
| 1332 | + "content": { | ||
| 1333 | + "application/json": { | ||
| 1334 | + "schema": { | ||
| 1335 | + "$ref": "#/components/schemas/Workform" | ||
| 1336 | + } | ||
| 1337 | + } | ||
| 1338 | + } | ||
| 1339 | + }, | ||
| 1340 | + "403": { | ||
| 1341 | + "description": "Forbidden", | ||
| 1342 | + "content": { | ||
| 1343 | + "application/json": { | ||
| 1344 | + "schema": { | ||
| 1345 | + "$ref": "#/components/schemas/Error" | ||
| 1346 | + } | ||
| 1347 | + } | ||
| 1348 | + } | ||
| 1349 | + }, | ||
| 1350 | + "404": { | ||
| 1351 | + "description": "Not found", | ||
| 1352 | + "content": { | ||
| 1353 | + "application/json": { | ||
| 1354 | + "schema": { | ||
| 1355 | + "$ref": "#/components/schemas/Error" | ||
| 1356 | + } | ||
| 1357 | + } | ||
| 1358 | + } | ||
| 1359 | + }, | ||
| 1360 | + "default": { | ||
| 1361 | + "description": "unexpected error", | ||
| 1362 | + "content": { | ||
| 1363 | + "application/json": { | ||
| 1364 | + "schema": { | ||
| 1365 | + "$ref": "#/components/schemas/Error" | ||
| 1366 | + } | ||
| 1367 | + } | ||
| 1368 | + } | ||
| 1369 | + } | ||
| 1370 | + }, | ||
| 1371 | + "summary": "", | ||
| 1372 | + "tags": [ | ||
| 1373 | + "Workform" | ||
| 1374 | + ], | ||
| 1375 | + "requestBody": { | ||
| 1376 | + "description": "", | ||
| 1377 | + "required": true, | ||
| 1378 | + "content": { | ||
| 1379 | + "application/json": { | ||
| 1380 | + "schema": { | ||
| 1381 | + "$ref": "#/components/schemas/NewWorkform" | ||
| 1382 | + } | ||
| 1383 | + } | ||
| 1384 | + } | ||
| 1385 | + }, | ||
| 1386 | + "parameters": [ | ||
| 1387 | + { | ||
| 1388 | + "name": "id", | ||
| 1389 | + "in": "path", | ||
| 1390 | + "description": "", | ||
| 1391 | + "deprecated": false, | ||
| 1392 | + "required": true, | ||
| 1393 | + "schema": { | ||
| 1394 | + "type": "string" | ||
| 1395 | + } | ||
| 1396 | + } | ||
| 1397 | + ] | ||
| 1398 | + }, | ||
| 1399 | + "delete": { | ||
| 1400 | + "deprecated": false, | ||
| 1401 | + "description": "Delete a record", | ||
| 1402 | + "responses": { | ||
| 1403 | + "200": { | ||
| 1404 | + "description": "deletes a single record based on the ID supplied", | ||
| 1405 | + "content": { | ||
| 1406 | + "application/json": { | ||
| 1407 | + "schema": { | ||
| 1408 | + "type": "integer", | ||
| 1409 | + "format": "int64" | ||
| 1410 | + } | ||
| 1411 | + } | ||
| 1412 | + } | ||
| 1413 | + }, | ||
| 1414 | + "403": { | ||
| 1415 | + "description": "Forbidden", | ||
| 1416 | + "content": { | ||
| 1417 | + "application/json": { | ||
| 1418 | + "schema": { | ||
| 1419 | + "$ref": "#/components/schemas/Error" | ||
| 1420 | + } | ||
| 1421 | + } | ||
| 1422 | + } | ||
| 1423 | + }, | ||
| 1424 | + "404": { | ||
| 1425 | + "description": "Not found", | ||
| 1426 | + "content": { | ||
| 1427 | + "application/json": { | ||
| 1428 | + "schema": { | ||
| 1429 | + "$ref": "#/components/schemas/Error" | ||
| 1430 | + } | ||
| 1431 | + } | ||
| 1432 | + } | ||
| 1433 | + }, | ||
| 1434 | + "default": { | ||
| 1435 | + "description": "unexpected error", | ||
| 1436 | + "content": { | ||
| 1437 | + "application/json": { | ||
| 1438 | + "schema": { | ||
| 1439 | + "$ref": "#/components/schemas/Error" | ||
| 1440 | + } | ||
| 1441 | + } | ||
| 1442 | + } | ||
| 1443 | + } | ||
| 1444 | + }, | ||
| 1445 | + "summary": "", | ||
| 1446 | + "tags": [ | ||
| 1447 | + "Workform" | ||
| 1448 | + ], | ||
| 1449 | + "parameters": [ | ||
| 1450 | + { | ||
| 1451 | + "name": "id", | ||
| 1452 | + "in": "path", | ||
| 1453 | + "description": "", | ||
| 1454 | + "deprecated": false, | ||
| 1455 | + "required": true, | ||
| 1456 | + "schema": { | ||
| 1457 | + "type": "string" | ||
| 1458 | + } | ||
| 1459 | + } | ||
| 1460 | + ] | ||
| 1461 | + } | ||
| 1462 | + }, | ||
| 1463 | + "/email/": { | ||
| 1464 | + "post": { | ||
| 1465 | + "deprecated": false, | ||
| 1466 | + "description": "Send an email", | ||
| 1467 | + "responses": { | ||
| 1468 | + "200": { | ||
| 1469 | + "description": "response", | ||
| 1470 | + "content": { | ||
| 1471 | + "application/json": { | ||
| 1472 | + "schema": { | ||
| 1473 | + "properties": { | ||
| 1474 | + "foo": { | ||
| 1475 | + "type": "string" | ||
| 1476 | + } | ||
| 1477 | + } | ||
| 1478 | + } | ||
| 1479 | + } | ||
| 1480 | + } | ||
| 1481 | + }, | ||
| 1482 | + "403": { | ||
| 1483 | + "description": "Forbidden", | ||
| 1484 | + "content": { | ||
| 1485 | + "application/json": { | ||
| 1486 | + "schema": { | ||
| 1487 | + "$ref": "#/components/schemas/Error" | ||
| 1488 | + } | ||
| 1489 | + } | ||
| 1490 | + } | ||
| 1491 | + }, | ||
| 1492 | + "404": { | ||
| 1493 | + "description": "Not found", | ||
| 1494 | + "content": { | ||
| 1495 | + "application/json": { | ||
| 1496 | + "schema": { | ||
| 1497 | + "$ref": "#/components/schemas/Error" | ||
| 1498 | + } | ||
| 1499 | + } | ||
| 1500 | + } | ||
| 1501 | + }, | ||
| 1502 | + "default": { | ||
| 1503 | + "description": "unexpected error", | ||
| 1504 | + "content": { | ||
| 1505 | + "application/json": { | ||
| 1506 | + "schema": { | ||
| 1507 | + "$ref": "#/components/schemas/Error" | ||
| 1508 | + } | ||
| 1509 | + } | ||
| 1510 | + } | ||
| 1511 | + } | ||
| 1512 | + }, | ||
| 1513 | + "summary": "", | ||
| 1514 | + "tags": [ | ||
| 1515 | + "Email - Email" | ||
| 1516 | + ], | ||
| 1517 | + "requestBody": { | ||
| 1518 | + "description": "", | ||
| 1519 | + "required": true, | ||
| 1520 | + "content": { | ||
| 1521 | + "application/json": { | ||
| 1522 | + "schema": { | ||
| 1523 | + "properties": { | ||
| 1524 | + "foo": { | ||
| 1525 | + "type": "string" | ||
| 1526 | + } | ||
| 1527 | + } | ||
| 1528 | + } | ||
| 1529 | + } | ||
| 1530 | + } | ||
| 1531 | + } | ||
| 1532 | + } | ||
| 1533 | + }, | ||
| 1534 | + "/upload/": { | ||
| 1535 | + "post": { | ||
| 1536 | + "deprecated": false, | ||
| 1537 | + "description": "Upload a file", | ||
| 1538 | + "responses": { | ||
| 1539 | + "200": { | ||
| 1540 | + "description": "response", | ||
| 1541 | + "content": { | ||
| 1542 | + "application/json": { | ||
| 1543 | + "schema": { | ||
| 1544 | + "properties": { | ||
| 1545 | + "foo": { | ||
| 1546 | + "type": "string" | ||
| 1547 | + } | ||
| 1548 | + } | ||
| 1549 | + } | ||
| 1550 | + } | ||
| 1551 | + } | ||
| 1552 | + }, | ||
| 1553 | + "403": { | ||
| 1554 | + "description": "Forbidden", | ||
| 1555 | + "content": { | ||
| 1556 | + "application/json": { | ||
| 1557 | + "schema": { | ||
| 1558 | + "$ref": "#/components/schemas/Error" | ||
| 1559 | + } | ||
| 1560 | + } | ||
| 1561 | + } | ||
| 1562 | + }, | ||
| 1563 | + "404": { | ||
| 1564 | + "description": "Not found", | ||
| 1565 | + "content": { | ||
| 1566 | + "application/json": { | ||
| 1567 | + "schema": { | ||
| 1568 | + "$ref": "#/components/schemas/Error" | ||
| 1569 | + } | ||
| 1570 | + } | ||
| 1571 | + } | ||
| 1572 | + }, | ||
| 1573 | + "default": { | ||
| 1574 | + "description": "unexpected error", | ||
| 1575 | + "content": { | ||
| 1576 | + "application/json": { | ||
| 1577 | + "schema": { | ||
| 1578 | + "$ref": "#/components/schemas/Error" | ||
| 1579 | + } | ||
| 1580 | + } | ||
| 1581 | + } | ||
| 1582 | + } | ||
| 1583 | + }, | ||
| 1584 | + "summary": "", | ||
| 1585 | + "tags": [ | ||
| 1586 | + "Upload - File" | ||
| 1587 | + ], | ||
| 1588 | + "requestBody": { | ||
| 1589 | + "description": "", | ||
| 1590 | + "required": true, | ||
| 1591 | + "content": { | ||
| 1592 | + "application/json": { | ||
| 1593 | + "schema": { | ||
| 1594 | + "properties": { | ||
| 1595 | + "foo": { | ||
| 1596 | + "type": "string" | ||
| 1597 | + } | ||
| 1598 | + } | ||
| 1599 | + } | ||
| 1600 | + } | ||
| 1601 | + } | ||
| 1602 | + } | ||
| 1603 | + } | ||
| 1604 | + }, | ||
| 1605 | + "/upload/files/count": { | ||
| 1606 | + "get": { | ||
| 1607 | + "deprecated": false, | ||
| 1608 | + "description": "Retrieve the total number of uploaded files", | ||
| 1609 | + "responses": { | ||
| 1610 | + "200": { | ||
| 1611 | + "description": "response", | ||
| 1612 | + "content": { | ||
| 1613 | + "application/json": { | ||
| 1614 | + "schema": { | ||
| 1615 | + "properties": { | ||
| 1616 | + "foo": { | ||
| 1617 | + "type": "string" | ||
| 1618 | + } | ||
| 1619 | + } | ||
| 1620 | + } | ||
| 1621 | + } | ||
| 1622 | + } | ||
| 1623 | + }, | ||
| 1624 | + "403": { | ||
| 1625 | + "description": "Forbidden", | ||
| 1626 | + "content": { | ||
| 1627 | + "application/json": { | ||
| 1628 | + "schema": { | ||
| 1629 | + "$ref": "#/components/schemas/Error" | ||
| 1630 | + } | ||
| 1631 | + } | ||
| 1632 | + } | ||
| 1633 | + }, | ||
| 1634 | + "404": { | ||
| 1635 | + "description": "Not found", | ||
| 1636 | + "content": { | ||
| 1637 | + "application/json": { | ||
| 1638 | + "schema": { | ||
| 1639 | + "$ref": "#/components/schemas/Error" | ||
| 1640 | + } | ||
| 1641 | + } | ||
| 1642 | + } | ||
| 1643 | + }, | ||
| 1644 | + "default": { | ||
| 1645 | + "description": "unexpected error", | ||
| 1646 | + "content": { | ||
| 1647 | + "application/json": { | ||
| 1648 | + "schema": { | ||
| 1649 | + "$ref": "#/components/schemas/Error" | ||
| 1650 | + } | ||
| 1651 | + } | ||
| 1652 | + } | ||
| 1653 | + } | ||
| 1654 | + }, | ||
| 1655 | + "summary": "", | ||
| 1656 | + "tags": [ | ||
| 1657 | + "Upload - File" | ||
| 1658 | + ], | ||
| 1659 | + "parameters": [] | ||
| 1660 | + } | ||
| 1661 | + }, | ||
| 1662 | + "/upload/files": { | ||
| 1663 | + "get": { | ||
| 1664 | + "deprecated": false, | ||
| 1665 | + "description": "Retrieve all file documents", | ||
| 1666 | + "responses": { | ||
| 1667 | + "200": { | ||
| 1668 | + "description": "response", | ||
| 1669 | + "content": { | ||
| 1670 | + "application/json": { | ||
| 1671 | + "schema": { | ||
| 1672 | + "properties": { | ||
| 1673 | + "foo": { | ||
| 1674 | + "type": "string" | ||
| 1675 | + } | ||
| 1676 | + } | ||
| 1677 | + } | ||
| 1678 | + } | ||
| 1679 | + } | ||
| 1680 | + }, | ||
| 1681 | + "403": { | ||
| 1682 | + "description": "Forbidden", | ||
| 1683 | + "content": { | ||
| 1684 | + "application/json": { | ||
| 1685 | + "schema": { | ||
| 1686 | + "$ref": "#/components/schemas/Error" | ||
| 1687 | + } | ||
| 1688 | + } | ||
| 1689 | + } | ||
| 1690 | + }, | ||
| 1691 | + "404": { | ||
| 1692 | + "description": "Not found", | ||
| 1693 | + "content": { | ||
| 1694 | + "application/json": { | ||
| 1695 | + "schema": { | ||
| 1696 | + "$ref": "#/components/schemas/Error" | ||
| 1697 | + } | ||
| 1698 | + } | ||
| 1699 | + } | ||
| 1700 | + }, | ||
| 1701 | + "default": { | ||
| 1702 | + "description": "unexpected error", | ||
| 1703 | + "content": { | ||
| 1704 | + "application/json": { | ||
| 1705 | + "schema": { | ||
| 1706 | + "$ref": "#/components/schemas/Error" | ||
| 1707 | + } | ||
| 1708 | + } | ||
| 1709 | + } | ||
| 1710 | + } | ||
| 1711 | + }, | ||
| 1712 | + "summary": "", | ||
| 1713 | + "tags": [ | ||
| 1714 | + "Upload - File" | ||
| 1715 | + ], | ||
| 1716 | + "parameters": [] | ||
| 1717 | + } | ||
| 1718 | + }, | ||
| 1719 | + "/upload/files/{id}": { | ||
| 1720 | + "get": { | ||
| 1721 | + "deprecated": false, | ||
| 1722 | + "description": "Retrieve a single file depending on its id", | ||
| 1723 | + "responses": { | ||
| 1724 | + "200": { | ||
| 1725 | + "description": "response", | ||
| 1726 | + "content": { | ||
| 1727 | + "application/json": { | ||
| 1728 | + "schema": { | ||
| 1729 | + "properties": { | ||
| 1730 | + "foo": { | ||
| 1731 | + "type": "string" | ||
| 1732 | + } | ||
| 1733 | + } | ||
| 1734 | + } | ||
| 1735 | + } | ||
| 1736 | + } | ||
| 1737 | + }, | ||
| 1738 | + "403": { | ||
| 1739 | + "description": "Forbidden", | ||
| 1740 | + "content": { | ||
| 1741 | + "application/json": { | ||
| 1742 | + "schema": { | ||
| 1743 | + "$ref": "#/components/schemas/Error" | ||
| 1744 | + } | ||
| 1745 | + } | ||
| 1746 | + } | ||
| 1747 | + }, | ||
| 1748 | + "404": { | ||
| 1749 | + "description": "Not found", | ||
| 1750 | + "content": { | ||
| 1751 | + "application/json": { | ||
| 1752 | + "schema": { | ||
| 1753 | + "$ref": "#/components/schemas/Error" | ||
| 1754 | + } | ||
| 1755 | + } | ||
| 1756 | + } | ||
| 1757 | + }, | ||
| 1758 | + "default": { | ||
| 1759 | + "description": "unexpected error", | ||
| 1760 | + "content": { | ||
| 1761 | + "application/json": { | ||
| 1762 | + "schema": { | ||
| 1763 | + "$ref": "#/components/schemas/Error" | ||
| 1764 | + } | ||
| 1765 | + } | ||
| 1766 | + } | ||
| 1767 | + } | ||
| 1768 | + }, | ||
| 1769 | + "summary": "", | ||
| 1770 | + "tags": [ | ||
| 1771 | + "Upload - File" | ||
| 1772 | + ], | ||
| 1773 | + "parameters": [ | ||
| 1774 | + { | ||
| 1775 | + "name": "id", | ||
| 1776 | + "in": "path", | ||
| 1777 | + "description": "", | ||
| 1778 | + "deprecated": false, | ||
| 1779 | + "required": true, | ||
| 1780 | + "schema": { | ||
| 1781 | + "type": "string" | ||
| 1782 | + } | ||
| 1783 | + } | ||
| 1784 | + ] | ||
| 1785 | + }, | ||
| 1786 | + "delete": { | ||
| 1787 | + "deprecated": false, | ||
| 1788 | + "description": "Delete an uploaded file", | ||
| 1789 | + "responses": { | ||
| 1790 | + "200": { | ||
| 1791 | + "description": "response", | ||
| 1792 | + "content": { | ||
| 1793 | + "application/json": { | ||
| 1794 | + "schema": { | ||
| 1795 | + "properties": { | ||
| 1796 | + "foo": { | ||
| 1797 | + "type": "string" | ||
| 1798 | + } | ||
| 1799 | + } | ||
| 1800 | + } | ||
| 1801 | + } | ||
| 1802 | + } | ||
| 1803 | + }, | ||
| 1804 | + "403": { | ||
| 1805 | + "description": "Forbidden", | ||
| 1806 | + "content": { | ||
| 1807 | + "application/json": { | ||
| 1808 | + "schema": { | ||
| 1809 | + "$ref": "#/components/schemas/Error" | ||
| 1810 | + } | ||
| 1811 | + } | ||
| 1812 | + } | ||
| 1813 | + }, | ||
| 1814 | + "404": { | ||
| 1815 | + "description": "Not found", | ||
| 1816 | + "content": { | ||
| 1817 | + "application/json": { | ||
| 1818 | + "schema": { | ||
| 1819 | + "$ref": "#/components/schemas/Error" | ||
| 1820 | + } | ||
| 1821 | + } | ||
| 1822 | + } | ||
| 1823 | + }, | ||
| 1824 | + "default": { | ||
| 1825 | + "description": "unexpected error", | ||
| 1826 | + "content": { | ||
| 1827 | + "application/json": { | ||
| 1828 | + "schema": { | ||
| 1829 | + "$ref": "#/components/schemas/Error" | ||
| 1830 | + } | ||
| 1831 | + } | ||
| 1832 | + } | ||
| 1833 | + } | ||
| 1834 | + }, | ||
| 1835 | + "summary": "", | ||
| 1836 | + "tags": [ | ||
| 1837 | + "Upload - File" | ||
| 1838 | + ], | ||
| 1839 | + "parameters": [ | ||
| 1840 | + { | ||
| 1841 | + "name": "id", | ||
| 1842 | + "in": "path", | ||
| 1843 | + "description": "", | ||
| 1844 | + "deprecated": false, | ||
| 1845 | + "required": true, | ||
| 1846 | + "schema": { | ||
| 1847 | + "type": "string" | ||
| 1848 | + } | ||
| 1849 | + } | ||
| 1850 | + ] | ||
| 1851 | + } | ||
| 1852 | + }, | ||
| 1853 | + "/upload/search/{id}": { | ||
| 1854 | + "get": { | ||
| 1855 | + "deprecated": false, | ||
| 1856 | + "description": "Search for an uploaded file", | ||
| 1857 | + "responses": { | ||
| 1858 | + "200": { | ||
| 1859 | + "description": "response", | ||
| 1860 | + "content": { | ||
| 1861 | + "application/json": { | ||
| 1862 | + "schema": { | ||
| 1863 | + "properties": { | ||
| 1864 | + "foo": { | ||
| 1865 | + "type": "string" | ||
| 1866 | + } | ||
| 1867 | + } | ||
| 1868 | + } | ||
| 1869 | + } | ||
| 1870 | + } | ||
| 1871 | + }, | ||
| 1872 | + "403": { | ||
| 1873 | + "description": "Forbidden", | ||
| 1874 | + "content": { | ||
| 1875 | + "application/json": { | ||
| 1876 | + "schema": { | ||
| 1877 | + "$ref": "#/components/schemas/Error" | ||
| 1878 | + } | ||
| 1879 | + } | ||
| 1880 | + } | ||
| 1881 | + }, | ||
| 1882 | + "404": { | ||
| 1883 | + "description": "Not found", | ||
| 1884 | + "content": { | ||
| 1885 | + "application/json": { | ||
| 1886 | + "schema": { | ||
| 1887 | + "$ref": "#/components/schemas/Error" | ||
| 1888 | + } | ||
| 1889 | + } | ||
| 1890 | + } | ||
| 1891 | + }, | ||
| 1892 | + "default": { | ||
| 1893 | + "description": "unexpected error", | ||
| 1894 | + "content": { | ||
| 1895 | + "application/json": { | ||
| 1896 | + "schema": { | ||
| 1897 | + "$ref": "#/components/schemas/Error" | ||
| 1898 | + } | ||
| 1899 | + } | ||
| 1900 | + } | ||
| 1901 | + } | ||
| 1902 | + }, | ||
| 1903 | + "summary": "", | ||
| 1904 | + "tags": [ | ||
| 1905 | + "Upload - File" | ||
| 1906 | + ], | ||
| 1907 | + "parameters": [ | ||
| 1908 | + { | ||
| 1909 | + "name": "id", | ||
| 1910 | + "in": "path", | ||
| 1911 | + "description": "", | ||
| 1912 | + "deprecated": false, | ||
| 1913 | + "required": true, | ||
| 1914 | + "schema": { | ||
| 1915 | + "type": "string" | ||
| 1916 | + } | ||
| 1917 | + } | ||
| 1918 | + ] | ||
| 1919 | + } | ||
| 1920 | + }, | ||
| 1921 | + "/users-permissions/init": { | ||
| 1922 | + "get": { | ||
| 1923 | + "deprecated": false, | ||
| 1924 | + "description": "Check if the first admin user has already been registered", | ||
| 1925 | + "responses": { | ||
| 1926 | + "200": { | ||
| 1927 | + "description": "response", | ||
| 1928 | + "content": { | ||
| 1929 | + "application/json": { | ||
| 1930 | + "schema": { | ||
| 1931 | + "properties": { | ||
| 1932 | + "foo": { | ||
| 1933 | + "type": "string" | ||
| 1934 | + } | ||
| 1935 | + } | ||
| 1936 | + } | ||
| 1937 | + } | ||
| 1938 | + } | ||
| 1939 | + }, | ||
| 1940 | + "403": { | ||
| 1941 | + "description": "Forbidden", | ||
| 1942 | + "content": { | ||
| 1943 | + "application/json": { | ||
| 1944 | + "schema": { | ||
| 1945 | + "$ref": "#/components/schemas/Error" | ||
| 1946 | + } | ||
| 1947 | + } | ||
| 1948 | + } | ||
| 1949 | + }, | ||
| 1950 | + "404": { | ||
| 1951 | + "description": "Not found", | ||
| 1952 | + "content": { | ||
| 1953 | + "application/json": { | ||
| 1954 | + "schema": { | ||
| 1955 | + "$ref": "#/components/schemas/Error" | ||
| 1956 | + } | ||
| 1957 | + } | ||
| 1958 | + } | ||
| 1959 | + }, | ||
| 1960 | + "default": { | ||
| 1961 | + "description": "unexpected error", | ||
| 1962 | + "content": { | ||
| 1963 | + "application/json": { | ||
| 1964 | + "schema": { | ||
| 1965 | + "$ref": "#/components/schemas/Error" | ||
| 1966 | + } | ||
| 1967 | + } | ||
| 1968 | + } | ||
| 1969 | + } | ||
| 1970 | + }, | ||
| 1971 | + "summary": "", | ||
| 1972 | + "tags": [ | ||
| 1973 | + "Users-Permissions - Role" | ||
| 1974 | + ], | ||
| 1975 | + "parameters": [] | ||
| 1976 | + } | ||
| 1977 | + }, | ||
| 1978 | + "/users-permissions/roles/{id}": { | ||
| 1979 | + "get": { | ||
| 1980 | + "deprecated": false, | ||
| 1981 | + "description": "Retrieve a role depending on its id", | ||
| 1982 | + "responses": { | ||
| 1983 | + "200": { | ||
| 1984 | + "description": "response", | ||
| 1985 | + "content": { | ||
| 1986 | + "application/json": { | ||
| 1987 | + "schema": { | ||
| 1988 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 1989 | + } | ||
| 1990 | + } | ||
| 1991 | + } | ||
| 1992 | + }, | ||
| 1993 | + "403": { | ||
| 1994 | + "description": "Forbidden", | ||
| 1995 | + "content": { | ||
| 1996 | + "application/json": { | ||
| 1997 | + "schema": { | ||
| 1998 | + "$ref": "#/components/schemas/Error" | ||
| 1999 | + } | ||
| 2000 | + } | ||
| 2001 | + } | ||
| 2002 | + }, | ||
| 2003 | + "404": { | ||
| 2004 | + "description": "Not found", | ||
| 2005 | + "content": { | ||
| 2006 | + "application/json": { | ||
| 2007 | + "schema": { | ||
| 2008 | + "$ref": "#/components/schemas/Error" | ||
| 2009 | + } | ||
| 2010 | + } | ||
| 2011 | + } | ||
| 2012 | + }, | ||
| 2013 | + "default": { | ||
| 2014 | + "description": "unexpected error", | ||
| 2015 | + "content": { | ||
| 2016 | + "application/json": { | ||
| 2017 | + "schema": { | ||
| 2018 | + "$ref": "#/components/schemas/Error" | ||
| 2019 | + } | ||
| 2020 | + } | ||
| 2021 | + } | ||
| 2022 | + } | ||
| 2023 | + }, | ||
| 2024 | + "summary": "", | ||
| 2025 | + "tags": [ | ||
| 2026 | + "Users-Permissions - Role" | ||
| 2027 | + ], | ||
| 2028 | + "parameters": [ | ||
| 2029 | + { | ||
| 2030 | + "name": "id", | ||
| 2031 | + "in": "path", | ||
| 2032 | + "description": "", | ||
| 2033 | + "deprecated": false, | ||
| 2034 | + "required": true, | ||
| 2035 | + "schema": { | ||
| 2036 | + "type": "string" | ||
| 2037 | + } | ||
| 2038 | + } | ||
| 2039 | + ] | ||
| 2040 | + } | ||
| 2041 | + }, | ||
| 2042 | + "/users-permissions/roles": { | ||
| 2043 | + "get": { | ||
| 2044 | + "deprecated": false, | ||
| 2045 | + "description": "Retrieve all role documents", | ||
| 2046 | + "responses": { | ||
| 2047 | + "200": { | ||
| 2048 | + "description": "response", | ||
| 2049 | + "content": { | ||
| 2050 | + "application/json": { | ||
| 2051 | + "schema": { | ||
| 2052 | + "type": "array", | ||
| 2053 | + "items": { | ||
| 2054 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 2055 | + } | ||
| 2056 | + } | ||
| 2057 | + } | ||
| 2058 | + } | ||
| 2059 | + }, | ||
| 2060 | + "403": { | ||
| 2061 | + "description": "Forbidden", | ||
| 2062 | + "content": { | ||
| 2063 | + "application/json": { | ||
| 2064 | + "schema": { | ||
| 2065 | + "$ref": "#/components/schemas/Error" | ||
| 2066 | + } | ||
| 2067 | + } | ||
| 2068 | + } | ||
| 2069 | + }, | ||
| 2070 | + "404": { | ||
| 2071 | + "description": "Not found", | ||
| 2072 | + "content": { | ||
| 2073 | + "application/json": { | ||
| 2074 | + "schema": { | ||
| 2075 | + "$ref": "#/components/schemas/Error" | ||
| 2076 | + } | ||
| 2077 | + } | ||
| 2078 | + } | ||
| 2079 | + }, | ||
| 2080 | + "default": { | ||
| 2081 | + "description": "unexpected error", | ||
| 2082 | + "content": { | ||
| 2083 | + "application/json": { | ||
| 2084 | + "schema": { | ||
| 2085 | + "$ref": "#/components/schemas/Error" | ||
| 2086 | + } | ||
| 2087 | + } | ||
| 2088 | + } | ||
| 2089 | + } | ||
| 2090 | + }, | ||
| 2091 | + "summary": "", | ||
| 2092 | + "tags": [ | ||
| 2093 | + "Users-Permissions - Role" | ||
| 2094 | + ], | ||
| 2095 | + "parameters": [ | ||
| 2096 | + { | ||
| 2097 | + "name": "_limit", | ||
| 2098 | + "in": "query", | ||
| 2099 | + "required": false, | ||
| 2100 | + "description": "Maximum number of results possible", | ||
| 2101 | + "schema": { | ||
| 2102 | + "type": "integer" | ||
| 2103 | + }, | ||
| 2104 | + "deprecated": false | ||
| 2105 | + }, | ||
| 2106 | + { | ||
| 2107 | + "name": "_sort", | ||
| 2108 | + "in": "query", | ||
| 2109 | + "required": false, | ||
| 2110 | + "description": "Sort according to a specific field.", | ||
| 2111 | + "schema": { | ||
| 2112 | + "type": "string" | ||
| 2113 | + }, | ||
| 2114 | + "deprecated": false | ||
| 2115 | + }, | ||
| 2116 | + { | ||
| 2117 | + "name": "_start", | ||
| 2118 | + "in": "query", | ||
| 2119 | + "required": false, | ||
| 2120 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 2121 | + "schema": { | ||
| 2122 | + "type": "integer" | ||
| 2123 | + }, | ||
| 2124 | + "deprecated": false | ||
| 2125 | + }, | ||
| 2126 | + { | ||
| 2127 | + "name": "=", | ||
| 2128 | + "in": "query", | ||
| 2129 | + "required": false, | ||
| 2130 | + "description": "Get entries that matches exactly your input", | ||
| 2131 | + "schema": { | ||
| 2132 | + "type": "string" | ||
| 2133 | + }, | ||
| 2134 | + "deprecated": false | ||
| 2135 | + }, | ||
| 2136 | + { | ||
| 2137 | + "name": "_ne", | ||
| 2138 | + "in": "query", | ||
| 2139 | + "required": false, | ||
| 2140 | + "description": "Get records that are not equals to something", | ||
| 2141 | + "schema": { | ||
| 2142 | + "type": "string" | ||
| 2143 | + }, | ||
| 2144 | + "deprecated": false | ||
| 2145 | + }, | ||
| 2146 | + { | ||
| 2147 | + "name": "_lt", | ||
| 2148 | + "in": "query", | ||
| 2149 | + "required": false, | ||
| 2150 | + "description": "Get record that are lower than a value", | ||
| 2151 | + "schema": { | ||
| 2152 | + "type": "string" | ||
| 2153 | + }, | ||
| 2154 | + "deprecated": false | ||
| 2155 | + }, | ||
| 2156 | + { | ||
| 2157 | + "name": "_lte", | ||
| 2158 | + "in": "query", | ||
| 2159 | + "required": false, | ||
| 2160 | + "description": "Get records that are lower than or equal to a value", | ||
| 2161 | + "schema": { | ||
| 2162 | + "type": "string" | ||
| 2163 | + }, | ||
| 2164 | + "deprecated": false | ||
| 2165 | + }, | ||
| 2166 | + { | ||
| 2167 | + "name": "_gt", | ||
| 2168 | + "in": "query", | ||
| 2169 | + "required": false, | ||
| 2170 | + "description": "Get records that are greater than a value", | ||
| 2171 | + "schema": { | ||
| 2172 | + "type": "string" | ||
| 2173 | + }, | ||
| 2174 | + "deprecated": false | ||
| 2175 | + }, | ||
| 2176 | + { | ||
| 2177 | + "name": "_gte", | ||
| 2178 | + "in": "query", | ||
| 2179 | + "required": false, | ||
| 2180 | + "description": "Get records that are greater than or equal a value", | ||
| 2181 | + "schema": { | ||
| 2182 | + "type": "string" | ||
| 2183 | + }, | ||
| 2184 | + "deprecated": false | ||
| 2185 | + }, | ||
| 2186 | + { | ||
| 2187 | + "name": "_contains", | ||
| 2188 | + "in": "query", | ||
| 2189 | + "required": false, | ||
| 2190 | + "description": "Get records that contains a value", | ||
| 2191 | + "schema": { | ||
| 2192 | + "type": "string" | ||
| 2193 | + }, | ||
| 2194 | + "deprecated": false | ||
| 2195 | + }, | ||
| 2196 | + { | ||
| 2197 | + "name": "_containss", | ||
| 2198 | + "in": "query", | ||
| 2199 | + "required": false, | ||
| 2200 | + "description": "Get records that contains (case sensitive) a value", | ||
| 2201 | + "schema": { | ||
| 2202 | + "type": "string" | ||
| 2203 | + }, | ||
| 2204 | + "deprecated": false | ||
| 2205 | + }, | ||
| 2206 | + { | ||
| 2207 | + "name": "_in", | ||
| 2208 | + "in": "query", | ||
| 2209 | + "required": false, | ||
| 2210 | + "description": "Get records that matches any value in the array of values", | ||
| 2211 | + "schema": { | ||
| 2212 | + "type": "array" | ||
| 2213 | + }, | ||
| 2214 | + "deprecated": false | ||
| 2215 | + }, | ||
| 2216 | + { | ||
| 2217 | + "name": "_nin", | ||
| 2218 | + "in": "query", | ||
| 2219 | + "required": false, | ||
| 2220 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 2221 | + "schema": { | ||
| 2222 | + "type": "array" | ||
| 2223 | + }, | ||
| 2224 | + "deprecated": false | ||
| 2225 | + } | ||
| 2226 | + ] | ||
| 2227 | + }, | ||
| 2228 | + "post": { | ||
| 2229 | + "deprecated": false, | ||
| 2230 | + "description": "Create a new role", | ||
| 2231 | + "responses": { | ||
| 2232 | + "200": { | ||
| 2233 | + "description": "response", | ||
| 2234 | + "content": { | ||
| 2235 | + "application/json": { | ||
| 2236 | + "schema": { | ||
| 2237 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 2238 | + } | ||
| 2239 | + } | ||
| 2240 | + } | ||
| 2241 | + }, | ||
| 2242 | + "403": { | ||
| 2243 | + "description": "Forbidden", | ||
| 2244 | + "content": { | ||
| 2245 | + "application/json": { | ||
| 2246 | + "schema": { | ||
| 2247 | + "$ref": "#/components/schemas/Error" | ||
| 2248 | + } | ||
| 2249 | + } | ||
| 2250 | + } | ||
| 2251 | + }, | ||
| 2252 | + "404": { | ||
| 2253 | + "description": "Not found", | ||
| 2254 | + "content": { | ||
| 2255 | + "application/json": { | ||
| 2256 | + "schema": { | ||
| 2257 | + "$ref": "#/components/schemas/Error" | ||
| 2258 | + } | ||
| 2259 | + } | ||
| 2260 | + } | ||
| 2261 | + }, | ||
| 2262 | + "default": { | ||
| 2263 | + "description": "unexpected error", | ||
| 2264 | + "content": { | ||
| 2265 | + "application/json": { | ||
| 2266 | + "schema": { | ||
| 2267 | + "$ref": "#/components/schemas/Error" | ||
| 2268 | + } | ||
| 2269 | + } | ||
| 2270 | + } | ||
| 2271 | + } | ||
| 2272 | + }, | ||
| 2273 | + "summary": "", | ||
| 2274 | + "tags": [ | ||
| 2275 | + "Users-Permissions - Role" | ||
| 2276 | + ], | ||
| 2277 | + "requestBody": { | ||
| 2278 | + "description": "", | ||
| 2279 | + "required": true, | ||
| 2280 | + "content": { | ||
| 2281 | + "application/json": { | ||
| 2282 | + "schema": { | ||
| 2283 | + "$ref": "#/components/schemas/NewUsers-PermissionsRole" | ||
| 2284 | + } | ||
| 2285 | + } | ||
| 2286 | + } | ||
| 2287 | + } | ||
| 2288 | + } | ||
| 2289 | + }, | ||
| 2290 | + "/users-permissions/roles/{role}": { | ||
| 2291 | + "put": { | ||
| 2292 | + "deprecated": false, | ||
| 2293 | + "description": "Update a role", | ||
| 2294 | + "responses": { | ||
| 2295 | + "200": { | ||
| 2296 | + "description": "response", | ||
| 2297 | + "content": { | ||
| 2298 | + "application/json": { | ||
| 2299 | + "schema": { | ||
| 2300 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 2301 | + } | ||
| 2302 | + } | ||
| 2303 | + } | ||
| 2304 | + }, | ||
| 2305 | + "403": { | ||
| 2306 | + "description": "Forbidden", | ||
| 2307 | + "content": { | ||
| 2308 | + "application/json": { | ||
| 2309 | + "schema": { | ||
| 2310 | + "$ref": "#/components/schemas/Error" | ||
| 2311 | + } | ||
| 2312 | + } | ||
| 2313 | + } | ||
| 2314 | + }, | ||
| 2315 | + "404": { | ||
| 2316 | + "description": "Not found", | ||
| 2317 | + "content": { | ||
| 2318 | + "application/json": { | ||
| 2319 | + "schema": { | ||
| 2320 | + "$ref": "#/components/schemas/Error" | ||
| 2321 | + } | ||
| 2322 | + } | ||
| 2323 | + } | ||
| 2324 | + }, | ||
| 2325 | + "default": { | ||
| 2326 | + "description": "unexpected error", | ||
| 2327 | + "content": { | ||
| 2328 | + "application/json": { | ||
| 2329 | + "schema": { | ||
| 2330 | + "$ref": "#/components/schemas/Error" | ||
| 2331 | + } | ||
| 2332 | + } | ||
| 2333 | + } | ||
| 2334 | + } | ||
| 2335 | + }, | ||
| 2336 | + "summary": "", | ||
| 2337 | + "tags": [ | ||
| 2338 | + "Users-Permissions - Role" | ||
| 2339 | + ], | ||
| 2340 | + "parameters": [ | ||
| 2341 | + { | ||
| 2342 | + "name": "role", | ||
| 2343 | + "in": "path", | ||
| 2344 | + "description": "", | ||
| 2345 | + "deprecated": false, | ||
| 2346 | + "required": true, | ||
| 2347 | + "schema": { | ||
| 2348 | + "type": "string" | ||
| 2349 | + } | ||
| 2350 | + } | ||
| 2351 | + ], | ||
| 2352 | + "requestBody": { | ||
| 2353 | + "description": "", | ||
| 2354 | + "required": true, | ||
| 2355 | + "content": { | ||
| 2356 | + "application/json": { | ||
| 2357 | + "schema": { | ||
| 2358 | + "$ref": "#/components/schemas/NewUsers-PermissionsRole" | ||
| 2359 | + } | ||
| 2360 | + } | ||
| 2361 | + } | ||
| 2362 | + } | ||
| 2363 | + }, | ||
| 2364 | + "delete": { | ||
| 2365 | + "deprecated": false, | ||
| 2366 | + "description": "Delete a role", | ||
| 2367 | + "responses": { | ||
| 2368 | + "200": { | ||
| 2369 | + "description": "response", | ||
| 2370 | + "content": { | ||
| 2371 | + "application/json": { | ||
| 2372 | + "schema": { | ||
| 2373 | + "properties": { | ||
| 2374 | + "foo": { | ||
| 2375 | + "type": "string" | ||
| 2376 | + } | ||
| 2377 | + } | ||
| 2378 | + } | ||
| 2379 | + } | ||
| 2380 | + } | ||
| 2381 | + }, | ||
| 2382 | + "403": { | ||
| 2383 | + "description": "Forbidden", | ||
| 2384 | + "content": { | ||
| 2385 | + "application/json": { | ||
| 2386 | + "schema": { | ||
| 2387 | + "$ref": "#/components/schemas/Error" | ||
| 2388 | + } | ||
| 2389 | + } | ||
| 2390 | + } | ||
| 2391 | + }, | ||
| 2392 | + "404": { | ||
| 2393 | + "description": "Not found", | ||
| 2394 | + "content": { | ||
| 2395 | + "application/json": { | ||
| 2396 | + "schema": { | ||
| 2397 | + "$ref": "#/components/schemas/Error" | ||
| 2398 | + } | ||
| 2399 | + } | ||
| 2400 | + } | ||
| 2401 | + }, | ||
| 2402 | + "default": { | ||
| 2403 | + "description": "unexpected error", | ||
| 2404 | + "content": { | ||
| 2405 | + "application/json": { | ||
| 2406 | + "schema": { | ||
| 2407 | + "$ref": "#/components/schemas/Error" | ||
| 2408 | + } | ||
| 2409 | + } | ||
| 2410 | + } | ||
| 2411 | + } | ||
| 2412 | + }, | ||
| 2413 | + "summary": "", | ||
| 2414 | + "tags": [ | ||
| 2415 | + "Users-Permissions - Role" | ||
| 2416 | + ], | ||
| 2417 | + "parameters": [ | ||
| 2418 | + { | ||
| 2419 | + "name": "role", | ||
| 2420 | + "in": "path", | ||
| 2421 | + "description": "", | ||
| 2422 | + "deprecated": false, | ||
| 2423 | + "required": true, | ||
| 2424 | + "schema": { | ||
| 2425 | + "type": "string" | ||
| 2426 | + } | ||
| 2427 | + } | ||
| 2428 | + ] | ||
| 2429 | + } | ||
| 2430 | + }, | ||
| 2431 | + "/users-permissions/search/{id}": { | ||
| 2432 | + "get": { | ||
| 2433 | + "deprecated": false, | ||
| 2434 | + "description": "Search for users", | ||
| 2435 | + "responses": { | ||
| 2436 | + "200": { | ||
| 2437 | + "description": "response", | ||
| 2438 | + "content": { | ||
| 2439 | + "application/json": { | ||
| 2440 | + "schema": { | ||
| 2441 | + "type": "array", | ||
| 2442 | + "items": { | ||
| 2443 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 2444 | + } | ||
| 2445 | + } | ||
| 2446 | + } | ||
| 2447 | + } | ||
| 2448 | + }, | ||
| 2449 | + "403": { | ||
| 2450 | + "description": "Forbidden", | ||
| 2451 | + "content": { | ||
| 2452 | + "application/json": { | ||
| 2453 | + "schema": { | ||
| 2454 | + "$ref": "#/components/schemas/Error" | ||
| 2455 | + } | ||
| 2456 | + } | ||
| 2457 | + } | ||
| 2458 | + }, | ||
| 2459 | + "404": { | ||
| 2460 | + "description": "Not found", | ||
| 2461 | + "content": { | ||
| 2462 | + "application/json": { | ||
| 2463 | + "schema": { | ||
| 2464 | + "$ref": "#/components/schemas/Error" | ||
| 2465 | + } | ||
| 2466 | + } | ||
| 2467 | + } | ||
| 2468 | + }, | ||
| 2469 | + "default": { | ||
| 2470 | + "description": "unexpected error", | ||
| 2471 | + "content": { | ||
| 2472 | + "application/json": { | ||
| 2473 | + "schema": { | ||
| 2474 | + "$ref": "#/components/schemas/Error" | ||
| 2475 | + } | ||
| 2476 | + } | ||
| 2477 | + } | ||
| 2478 | + } | ||
| 2479 | + }, | ||
| 2480 | + "summary": "", | ||
| 2481 | + "tags": [ | ||
| 2482 | + "Users-Permissions - User" | ||
| 2483 | + ], | ||
| 2484 | + "parameters": [ | ||
| 2485 | + { | ||
| 2486 | + "name": "id", | ||
| 2487 | + "in": "path", | ||
| 2488 | + "description": "", | ||
| 2489 | + "deprecated": false, | ||
| 2490 | + "required": true, | ||
| 2491 | + "schema": { | ||
| 2492 | + "type": "string" | ||
| 2493 | + } | ||
| 2494 | + }, | ||
| 2495 | + { | ||
| 2496 | + "name": "_limit", | ||
| 2497 | + "in": "query", | ||
| 2498 | + "required": false, | ||
| 2499 | + "description": "Maximum number of results possible", | ||
| 2500 | + "schema": { | ||
| 2501 | + "type": "integer" | ||
| 2502 | + }, | ||
| 2503 | + "deprecated": false | ||
| 2504 | + }, | ||
| 2505 | + { | ||
| 2506 | + "name": "_sort", | ||
| 2507 | + "in": "query", | ||
| 2508 | + "required": false, | ||
| 2509 | + "description": "Sort according to a specific field.", | ||
| 2510 | + "schema": { | ||
| 2511 | + "type": "string" | ||
| 2512 | + }, | ||
| 2513 | + "deprecated": false | ||
| 2514 | + }, | ||
| 2515 | + { | ||
| 2516 | + "name": "_start", | ||
| 2517 | + "in": "query", | ||
| 2518 | + "required": false, | ||
| 2519 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 2520 | + "schema": { | ||
| 2521 | + "type": "integer" | ||
| 2522 | + }, | ||
| 2523 | + "deprecated": false | ||
| 2524 | + }, | ||
| 2525 | + { | ||
| 2526 | + "name": "=", | ||
| 2527 | + "in": "query", | ||
| 2528 | + "required": false, | ||
| 2529 | + "description": "Get entries that matches exactly your input", | ||
| 2530 | + "schema": { | ||
| 2531 | + "type": "string" | ||
| 2532 | + }, | ||
| 2533 | + "deprecated": false | ||
| 2534 | + }, | ||
| 2535 | + { | ||
| 2536 | + "name": "_ne", | ||
| 2537 | + "in": "query", | ||
| 2538 | + "required": false, | ||
| 2539 | + "description": "Get records that are not equals to something", | ||
| 2540 | + "schema": { | ||
| 2541 | + "type": "string" | ||
| 2542 | + }, | ||
| 2543 | + "deprecated": false | ||
| 2544 | + }, | ||
| 2545 | + { | ||
| 2546 | + "name": "_lt", | ||
| 2547 | + "in": "query", | ||
| 2548 | + "required": false, | ||
| 2549 | + "description": "Get record that are lower than a value", | ||
| 2550 | + "schema": { | ||
| 2551 | + "type": "string" | ||
| 2552 | + }, | ||
| 2553 | + "deprecated": false | ||
| 2554 | + }, | ||
| 2555 | + { | ||
| 2556 | + "name": "_lte", | ||
| 2557 | + "in": "query", | ||
| 2558 | + "required": false, | ||
| 2559 | + "description": "Get records that are lower than or equal to a value", | ||
| 2560 | + "schema": { | ||
| 2561 | + "type": "string" | ||
| 2562 | + }, | ||
| 2563 | + "deprecated": false | ||
| 2564 | + }, | ||
| 2565 | + { | ||
| 2566 | + "name": "_gt", | ||
| 2567 | + "in": "query", | ||
| 2568 | + "required": false, | ||
| 2569 | + "description": "Get records that are greater than a value", | ||
| 2570 | + "schema": { | ||
| 2571 | + "type": "string" | ||
| 2572 | + }, | ||
| 2573 | + "deprecated": false | ||
| 2574 | + }, | ||
| 2575 | + { | ||
| 2576 | + "name": "_gte", | ||
| 2577 | + "in": "query", | ||
| 2578 | + "required": false, | ||
| 2579 | + "description": "Get records that are greater than or equal a value", | ||
| 2580 | + "schema": { | ||
| 2581 | + "type": "string" | ||
| 2582 | + }, | ||
| 2583 | + "deprecated": false | ||
| 2584 | + }, | ||
| 2585 | + { | ||
| 2586 | + "name": "_contains", | ||
| 2587 | + "in": "query", | ||
| 2588 | + "required": false, | ||
| 2589 | + "description": "Get records that contains a value", | ||
| 2590 | + "schema": { | ||
| 2591 | + "type": "string" | ||
| 2592 | + }, | ||
| 2593 | + "deprecated": false | ||
| 2594 | + }, | ||
| 2595 | + { | ||
| 2596 | + "name": "_containss", | ||
| 2597 | + "in": "query", | ||
| 2598 | + "required": false, | ||
| 2599 | + "description": "Get records that contains (case sensitive) a value", | ||
| 2600 | + "schema": { | ||
| 2601 | + "type": "string" | ||
| 2602 | + }, | ||
| 2603 | + "deprecated": false | ||
| 2604 | + }, | ||
| 2605 | + { | ||
| 2606 | + "name": "_in", | ||
| 2607 | + "in": "query", | ||
| 2608 | + "required": false, | ||
| 2609 | + "description": "Get records that matches any value in the array of values", | ||
| 2610 | + "schema": { | ||
| 2611 | + "type": "array" | ||
| 2612 | + }, | ||
| 2613 | + "deprecated": false | ||
| 2614 | + }, | ||
| 2615 | + { | ||
| 2616 | + "name": "_nin", | ||
| 2617 | + "in": "query", | ||
| 2618 | + "required": false, | ||
| 2619 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 2620 | + "schema": { | ||
| 2621 | + "type": "array" | ||
| 2622 | + }, | ||
| 2623 | + "deprecated": false | ||
| 2624 | + } | ||
| 2625 | + ] | ||
| 2626 | + } | ||
| 2627 | + }, | ||
| 2628 | + "/connect/*": { | ||
| 2629 | + "get": { | ||
| 2630 | + "deprecated": false, | ||
| 2631 | + "description": "Connect a provider", | ||
| 2632 | + "responses": { | ||
| 2633 | + "200": { | ||
| 2634 | + "description": "response", | ||
| 2635 | + "content": { | ||
| 2636 | + "application/json": { | ||
| 2637 | + "schema": { | ||
| 2638 | + "properties": { | ||
| 2639 | + "foo": { | ||
| 2640 | + "type": "string" | ||
| 2641 | + } | ||
| 2642 | + } | ||
| 2643 | + } | ||
| 2644 | + } | ||
| 2645 | + } | ||
| 2646 | + }, | ||
| 2647 | + "403": { | ||
| 2648 | + "description": "Forbidden", | ||
| 2649 | + "content": { | ||
| 2650 | + "application/json": { | ||
| 2651 | + "schema": { | ||
| 2652 | + "$ref": "#/components/schemas/Error" | ||
| 2653 | + } | ||
| 2654 | + } | ||
| 2655 | + } | ||
| 2656 | + }, | ||
| 2657 | + "404": { | ||
| 2658 | + "description": "Not found", | ||
| 2659 | + "content": { | ||
| 2660 | + "application/json": { | ||
| 2661 | + "schema": { | ||
| 2662 | + "$ref": "#/components/schemas/Error" | ||
| 2663 | + } | ||
| 2664 | + } | ||
| 2665 | + } | ||
| 2666 | + }, | ||
| 2667 | + "default": { | ||
| 2668 | + "description": "unexpected error", | ||
| 2669 | + "content": { | ||
| 2670 | + "application/json": { | ||
| 2671 | + "schema": { | ||
| 2672 | + "$ref": "#/components/schemas/Error" | ||
| 2673 | + } | ||
| 2674 | + } | ||
| 2675 | + } | ||
| 2676 | + } | ||
| 2677 | + }, | ||
| 2678 | + "summary": "", | ||
| 2679 | + "tags": [ | ||
| 2680 | + "Users-Permissions - User" | ||
| 2681 | + ], | ||
| 2682 | + "parameters": [] | ||
| 2683 | + } | ||
| 2684 | + }, | ||
| 2685 | + "/auth/local": { | ||
| 2686 | + "post": { | ||
| 2687 | + "deprecated": false, | ||
| 2688 | + "description": "Login a user using the identifiers email and password", | ||
| 2689 | + "responses": { | ||
| 2690 | + "200": { | ||
| 2691 | + "description": "response", | ||
| 2692 | + "content": { | ||
| 2693 | + "application/json": { | ||
| 2694 | + "schema": { | ||
| 2695 | + "properties": { | ||
| 2696 | + "foo": { | ||
| 2697 | + "type": "string" | ||
| 2698 | + } | ||
| 2699 | + } | ||
| 2700 | + } | ||
| 2701 | + } | ||
| 2702 | + } | ||
| 2703 | + }, | ||
| 2704 | + "403": { | ||
| 2705 | + "description": "Forbidden", | ||
| 2706 | + "content": { | ||
| 2707 | + "application/json": { | ||
| 2708 | + "schema": { | ||
| 2709 | + "$ref": "#/components/schemas/Error" | ||
| 2710 | + } | ||
| 2711 | + } | ||
| 2712 | + } | ||
| 2713 | + }, | ||
| 2714 | + "404": { | ||
| 2715 | + "description": "Not found", | ||
| 2716 | + "content": { | ||
| 2717 | + "application/json": { | ||
| 2718 | + "schema": { | ||
| 2719 | + "$ref": "#/components/schemas/Error" | ||
| 2720 | + } | ||
| 2721 | + } | ||
| 2722 | + } | ||
| 2723 | + }, | ||
| 2724 | + "default": { | ||
| 2725 | + "description": "unexpected error", | ||
| 2726 | + "content": { | ||
| 2727 | + "application/json": { | ||
| 2728 | + "schema": { | ||
| 2729 | + "$ref": "#/components/schemas/Error" | ||
| 2730 | + } | ||
| 2731 | + } | ||
| 2732 | + } | ||
| 2733 | + } | ||
| 2734 | + }, | ||
| 2735 | + "summary": "", | ||
| 2736 | + "tags": [ | ||
| 2737 | + "Users-Permissions - User" | ||
| 2738 | + ], | ||
| 2739 | + "requestBody": { | ||
| 2740 | + "description": "", | ||
| 2741 | + "required": true, | ||
| 2742 | + "content": { | ||
| 2743 | + "application/json": { | ||
| 2744 | + "schema": { | ||
| 2745 | + "properties": { | ||
| 2746 | + "foo": { | ||
| 2747 | + "type": "string" | ||
| 2748 | + } | ||
| 2749 | + } | ||
| 2750 | + } | ||
| 2751 | + } | ||
| 2752 | + } | ||
| 2753 | + } | ||
| 2754 | + } | ||
| 2755 | + }, | ||
| 2756 | + "/auth/local/register": { | ||
| 2757 | + "post": { | ||
| 2758 | + "deprecated": false, | ||
| 2759 | + "description": "Register a new user with the default role", | ||
| 2760 | + "responses": { | ||
| 2761 | + "200": { | ||
| 2762 | + "description": "response", | ||
| 2763 | + "content": { | ||
| 2764 | + "application/json": { | ||
| 2765 | + "schema": { | ||
| 2766 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 2767 | + } | ||
| 2768 | + } | ||
| 2769 | + } | ||
| 2770 | + }, | ||
| 2771 | + "403": { | ||
| 2772 | + "description": "Forbidden", | ||
| 2773 | + "content": { | ||
| 2774 | + "application/json": { | ||
| 2775 | + "schema": { | ||
| 2776 | + "$ref": "#/components/schemas/Error" | ||
| 2777 | + } | ||
| 2778 | + } | ||
| 2779 | + } | ||
| 2780 | + }, | ||
| 2781 | + "404": { | ||
| 2782 | + "description": "Not found", | ||
| 2783 | + "content": { | ||
| 2784 | + "application/json": { | ||
| 2785 | + "schema": { | ||
| 2786 | + "$ref": "#/components/schemas/Error" | ||
| 2787 | + } | ||
| 2788 | + } | ||
| 2789 | + } | ||
| 2790 | + }, | ||
| 2791 | + "default": { | ||
| 2792 | + "description": "unexpected error", | ||
| 2793 | + "content": { | ||
| 2794 | + "application/json": { | ||
| 2795 | + "schema": { | ||
| 2796 | + "$ref": "#/components/schemas/Error" | ||
| 2797 | + } | ||
| 2798 | + } | ||
| 2799 | + } | ||
| 2800 | + } | ||
| 2801 | + }, | ||
| 2802 | + "summary": "", | ||
| 2803 | + "tags": [ | ||
| 2804 | + "Users-Permissions - User" | ||
| 2805 | + ], | ||
| 2806 | + "requestBody": { | ||
| 2807 | + "description": "", | ||
| 2808 | + "required": true, | ||
| 2809 | + "content": { | ||
| 2810 | + "application/json": { | ||
| 2811 | + "schema": { | ||
| 2812 | + "$ref": "#/components/schemas/NewUsers-PermissionsUser" | ||
| 2813 | + } | ||
| 2814 | + } | ||
| 2815 | + } | ||
| 2816 | + } | ||
| 2817 | + } | ||
| 2818 | + }, | ||
| 2819 | + "/auth/{provider}/callback": { | ||
| 2820 | + "get": { | ||
| 2821 | + "deprecated": false, | ||
| 2822 | + "description": "Successfull redirection after approving a provider", | ||
| 2823 | + "responses": { | ||
| 2824 | + "200": { | ||
| 2825 | + "description": "response", | ||
| 2826 | + "content": { | ||
| 2827 | + "application/json": { | ||
| 2828 | + "schema": { | ||
| 2829 | + "properties": { | ||
| 2830 | + "foo": { | ||
| 2831 | + "type": "string" | ||
| 2832 | + } | ||
| 2833 | + } | ||
| 2834 | + } | ||
| 2835 | + } | ||
| 2836 | + } | ||
| 2837 | + }, | ||
| 2838 | + "403": { | ||
| 2839 | + "description": "Forbidden", | ||
| 2840 | + "content": { | ||
| 2841 | + "application/json": { | ||
| 2842 | + "schema": { | ||
| 2843 | + "$ref": "#/components/schemas/Error" | ||
| 2844 | + } | ||
| 2845 | + } | ||
| 2846 | + } | ||
| 2847 | + }, | ||
| 2848 | + "404": { | ||
| 2849 | + "description": "Not found", | ||
| 2850 | + "content": { | ||
| 2851 | + "application/json": { | ||
| 2852 | + "schema": { | ||
| 2853 | + "$ref": "#/components/schemas/Error" | ||
| 2854 | + } | ||
| 2855 | + } | ||
| 2856 | + } | ||
| 2857 | + }, | ||
| 2858 | + "default": { | ||
| 2859 | + "description": "unexpected error", | ||
| 2860 | + "content": { | ||
| 2861 | + "application/json": { | ||
| 2862 | + "schema": { | ||
| 2863 | + "$ref": "#/components/schemas/Error" | ||
| 2864 | + } | ||
| 2865 | + } | ||
| 2866 | + } | ||
| 2867 | + } | ||
| 2868 | + }, | ||
| 2869 | + "summary": "", | ||
| 2870 | + "tags": [ | ||
| 2871 | + "Users-Permissions - User" | ||
| 2872 | + ], | ||
| 2873 | + "parameters": [ | ||
| 2874 | + { | ||
| 2875 | + "name": "provider", | ||
| 2876 | + "in": "path", | ||
| 2877 | + "description": "", | ||
| 2878 | + "deprecated": false, | ||
| 2879 | + "required": true, | ||
| 2880 | + "schema": { | ||
| 2881 | + "type": "string" | ||
| 2882 | + } | ||
| 2883 | + } | ||
| 2884 | + ] | ||
| 2885 | + } | ||
| 2886 | + }, | ||
| 2887 | + "/auth/forgot-password": { | ||
| 2888 | + "post": { | ||
| 2889 | + "deprecated": false, | ||
| 2890 | + "description": "Send the reset password email link", | ||
| 2891 | + "responses": { | ||
| 2892 | + "200": { | ||
| 2893 | + "description": "response", | ||
| 2894 | + "content": { | ||
| 2895 | + "application/json": { | ||
| 2896 | + "schema": { | ||
| 2897 | + "properties": { | ||
| 2898 | + "foo": { | ||
| 2899 | + "type": "string" | ||
| 2900 | + } | ||
| 2901 | + } | ||
| 2902 | + } | ||
| 2903 | + } | ||
| 2904 | + } | ||
| 2905 | + }, | ||
| 2906 | + "403": { | ||
| 2907 | + "description": "Forbidden", | ||
| 2908 | + "content": { | ||
| 2909 | + "application/json": { | ||
| 2910 | + "schema": { | ||
| 2911 | + "$ref": "#/components/schemas/Error" | ||
| 2912 | + } | ||
| 2913 | + } | ||
| 2914 | + } | ||
| 2915 | + }, | ||
| 2916 | + "404": { | ||
| 2917 | + "description": "Not found", | ||
| 2918 | + "content": { | ||
| 2919 | + "application/json": { | ||
| 2920 | + "schema": { | ||
| 2921 | + "$ref": "#/components/schemas/Error" | ||
| 2922 | + } | ||
| 2923 | + } | ||
| 2924 | + } | ||
| 2925 | + }, | ||
| 2926 | + "default": { | ||
| 2927 | + "description": "unexpected error", | ||
| 2928 | + "content": { | ||
| 2929 | + "application/json": { | ||
| 2930 | + "schema": { | ||
| 2931 | + "$ref": "#/components/schemas/Error" | ||
| 2932 | + } | ||
| 2933 | + } | ||
| 2934 | + } | ||
| 2935 | + } | ||
| 2936 | + }, | ||
| 2937 | + "summary": "", | ||
| 2938 | + "tags": [ | ||
| 2939 | + "Users-Permissions - User" | ||
| 2940 | + ], | ||
| 2941 | + "requestBody": { | ||
| 2942 | + "description": "", | ||
| 2943 | + "required": true, | ||
| 2944 | + "content": { | ||
| 2945 | + "application/json": { | ||
| 2946 | + "schema": { | ||
| 2947 | + "properties": { | ||
| 2948 | + "foo": { | ||
| 2949 | + "type": "string" | ||
| 2950 | + } | ||
| 2951 | + } | ||
| 2952 | + } | ||
| 2953 | + } | ||
| 2954 | + } | ||
| 2955 | + } | ||
| 2956 | + } | ||
| 2957 | + }, | ||
| 2958 | + "/auth/reset-password": { | ||
| 2959 | + "post": { | ||
| 2960 | + "deprecated": false, | ||
| 2961 | + "description": "Change a user's password", | ||
| 2962 | + "responses": { | ||
| 2963 | + "200": { | ||
| 2964 | + "description": "response", | ||
| 2965 | + "content": { | ||
| 2966 | + "application/json": { | ||
| 2967 | + "schema": { | ||
| 2968 | + "properties": { | ||
| 2969 | + "foo": { | ||
| 2970 | + "type": "string" | ||
| 2971 | + } | ||
| 2972 | + } | ||
| 2973 | + } | ||
| 2974 | + } | ||
| 2975 | + } | ||
| 2976 | + }, | ||
| 2977 | + "403": { | ||
| 2978 | + "description": "Forbidden", | ||
| 2979 | + "content": { | ||
| 2980 | + "application/json": { | ||
| 2981 | + "schema": { | ||
| 2982 | + "$ref": "#/components/schemas/Error" | ||
| 2983 | + } | ||
| 2984 | + } | ||
| 2985 | + } | ||
| 2986 | + }, | ||
| 2987 | + "404": { | ||
| 2988 | + "description": "Not found", | ||
| 2989 | + "content": { | ||
| 2990 | + "application/json": { | ||
| 2991 | + "schema": { | ||
| 2992 | + "$ref": "#/components/schemas/Error" | ||
| 2993 | + } | ||
| 2994 | + } | ||
| 2995 | + } | ||
| 2996 | + }, | ||
| 2997 | + "default": { | ||
| 2998 | + "description": "unexpected error", | ||
| 2999 | + "content": { | ||
| 3000 | + "application/json": { | ||
| 3001 | + "schema": { | ||
| 3002 | + "$ref": "#/components/schemas/Error" | ||
| 3003 | + } | ||
| 3004 | + } | ||
| 3005 | + } | ||
| 3006 | + } | ||
| 3007 | + }, | ||
| 3008 | + "summary": "", | ||
| 3009 | + "tags": [ | ||
| 3010 | + "Users-Permissions - User" | ||
| 3011 | + ], | ||
| 3012 | + "requestBody": { | ||
| 3013 | + "description": "", | ||
| 3014 | + "required": true, | ||
| 3015 | + "content": { | ||
| 3016 | + "application/json": { | ||
| 3017 | + "schema": { | ||
| 3018 | + "properties": { | ||
| 3019 | + "foo": { | ||
| 3020 | + "type": "string" | ||
| 3021 | + } | ||
| 3022 | + } | ||
| 3023 | + } | ||
| 3024 | + } | ||
| 3025 | + } | ||
| 3026 | + } | ||
| 3027 | + } | ||
| 3028 | + }, | ||
| 3029 | + "/auth/email-confirmation": { | ||
| 3030 | + "get": { | ||
| 3031 | + "deprecated": false, | ||
| 3032 | + "description": "Validate a user account", | ||
| 3033 | + "responses": { | ||
| 3034 | + "200": { | ||
| 3035 | + "description": "response", | ||
| 3036 | + "content": { | ||
| 3037 | + "application/json": { | ||
| 3038 | + "schema": { | ||
| 3039 | + "properties": { | ||
| 3040 | + "foo": { | ||
| 3041 | + "type": "string" | ||
| 3042 | + } | ||
| 3043 | + } | ||
| 3044 | + } | ||
| 3045 | + } | ||
| 3046 | + } | ||
| 3047 | + }, | ||
| 3048 | + "403": { | ||
| 3049 | + "description": "Forbidden", | ||
| 3050 | + "content": { | ||
| 3051 | + "application/json": { | ||
| 3052 | + "schema": { | ||
| 3053 | + "$ref": "#/components/schemas/Error" | ||
| 3054 | + } | ||
| 3055 | + } | ||
| 3056 | + } | ||
| 3057 | + }, | ||
| 3058 | + "404": { | ||
| 3059 | + "description": "Not found", | ||
| 3060 | + "content": { | ||
| 3061 | + "application/json": { | ||
| 3062 | + "schema": { | ||
| 3063 | + "$ref": "#/components/schemas/Error" | ||
| 3064 | + } | ||
| 3065 | + } | ||
| 3066 | + } | ||
| 3067 | + }, | ||
| 3068 | + "default": { | ||
| 3069 | + "description": "unexpected error", | ||
| 3070 | + "content": { | ||
| 3071 | + "application/json": { | ||
| 3072 | + "schema": { | ||
| 3073 | + "$ref": "#/components/schemas/Error" | ||
| 3074 | + } | ||
| 3075 | + } | ||
| 3076 | + } | ||
| 3077 | + } | ||
| 3078 | + }, | ||
| 3079 | + "summary": "", | ||
| 3080 | + "tags": [ | ||
| 3081 | + "Users-Permissions - User" | ||
| 3082 | + ], | ||
| 3083 | + "parameters": [] | ||
| 3084 | + } | ||
| 3085 | + }, | ||
| 3086 | + "/auth/send-email-confirmation": { | ||
| 3087 | + "post": { | ||
| 3088 | + "deprecated": false, | ||
| 3089 | + "description": "Send a confirmation email to user", | ||
| 3090 | + "responses": { | ||
| 3091 | + "200": { | ||
| 3092 | + "description": "response", | ||
| 3093 | + "content": { | ||
| 3094 | + "application/json": { | ||
| 3095 | + "schema": { | ||
| 3096 | + "properties": { | ||
| 3097 | + "foo": { | ||
| 3098 | + "type": "string" | ||
| 3099 | + } | ||
| 3100 | + } | ||
| 3101 | + } | ||
| 3102 | + } | ||
| 3103 | + } | ||
| 3104 | + }, | ||
| 3105 | + "403": { | ||
| 3106 | + "description": "Forbidden", | ||
| 3107 | + "content": { | ||
| 3108 | + "application/json": { | ||
| 3109 | + "schema": { | ||
| 3110 | + "$ref": "#/components/schemas/Error" | ||
| 3111 | + } | ||
| 3112 | + } | ||
| 3113 | + } | ||
| 3114 | + }, | ||
| 3115 | + "404": { | ||
| 3116 | + "description": "Not found", | ||
| 3117 | + "content": { | ||
| 3118 | + "application/json": { | ||
| 3119 | + "schema": { | ||
| 3120 | + "$ref": "#/components/schemas/Error" | ||
| 3121 | + } | ||
| 3122 | + } | ||
| 3123 | + } | ||
| 3124 | + }, | ||
| 3125 | + "default": { | ||
| 3126 | + "description": "unexpected error", | ||
| 3127 | + "content": { | ||
| 3128 | + "application/json": { | ||
| 3129 | + "schema": { | ||
| 3130 | + "$ref": "#/components/schemas/Error" | ||
| 3131 | + } | ||
| 3132 | + } | ||
| 3133 | + } | ||
| 3134 | + } | ||
| 3135 | + }, | ||
| 3136 | + "summary": "", | ||
| 3137 | + "tags": [ | ||
| 3138 | + "Users-Permissions - User" | ||
| 3139 | + ], | ||
| 3140 | + "requestBody": { | ||
| 3141 | + "description": "", | ||
| 3142 | + "required": true, | ||
| 3143 | + "content": { | ||
| 3144 | + "application/json": { | ||
| 3145 | + "schema": { | ||
| 3146 | + "properties": { | ||
| 3147 | + "foo": { | ||
| 3148 | + "type": "string" | ||
| 3149 | + } | ||
| 3150 | + } | ||
| 3151 | + } | ||
| 3152 | + } | ||
| 3153 | + } | ||
| 3154 | + } | ||
| 3155 | + } | ||
| 3156 | + }, | ||
| 3157 | + "/users": { | ||
| 3158 | + "get": { | ||
| 3159 | + "deprecated": false, | ||
| 3160 | + "description": "Retrieve all user documents", | ||
| 3161 | + "responses": { | ||
| 3162 | + "200": { | ||
| 3163 | + "description": "response", | ||
| 3164 | + "content": { | ||
| 3165 | + "application/json": { | ||
| 3166 | + "schema": { | ||
| 3167 | + "type": "array", | ||
| 3168 | + "items": { | ||
| 3169 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 3170 | + } | ||
| 3171 | + } | ||
| 3172 | + } | ||
| 3173 | + } | ||
| 3174 | + }, | ||
| 3175 | + "403": { | ||
| 3176 | + "description": "Forbidden", | ||
| 3177 | + "content": { | ||
| 3178 | + "application/json": { | ||
| 3179 | + "schema": { | ||
| 3180 | + "$ref": "#/components/schemas/Error" | ||
| 3181 | + } | ||
| 3182 | + } | ||
| 3183 | + } | ||
| 3184 | + }, | ||
| 3185 | + "404": { | ||
| 3186 | + "description": "Not found", | ||
| 3187 | + "content": { | ||
| 3188 | + "application/json": { | ||
| 3189 | + "schema": { | ||
| 3190 | + "$ref": "#/components/schemas/Error" | ||
| 3191 | + } | ||
| 3192 | + } | ||
| 3193 | + } | ||
| 3194 | + }, | ||
| 3195 | + "default": { | ||
| 3196 | + "description": "unexpected error", | ||
| 3197 | + "content": { | ||
| 3198 | + "application/json": { | ||
| 3199 | + "schema": { | ||
| 3200 | + "$ref": "#/components/schemas/Error" | ||
| 3201 | + } | ||
| 3202 | + } | ||
| 3203 | + } | ||
| 3204 | + } | ||
| 3205 | + }, | ||
| 3206 | + "summary": "", | ||
| 3207 | + "tags": [ | ||
| 3208 | + "Users-Permissions - User" | ||
| 3209 | + ], | ||
| 3210 | + "parameters": [ | ||
| 3211 | + { | ||
| 3212 | + "name": "_limit", | ||
| 3213 | + "in": "query", | ||
| 3214 | + "required": false, | ||
| 3215 | + "description": "Maximum number of results possible", | ||
| 3216 | + "schema": { | ||
| 3217 | + "type": "integer" | ||
| 3218 | + }, | ||
| 3219 | + "deprecated": false | ||
| 3220 | + }, | ||
| 3221 | + { | ||
| 3222 | + "name": "_sort", | ||
| 3223 | + "in": "query", | ||
| 3224 | + "required": false, | ||
| 3225 | + "description": "Sort according to a specific field.", | ||
| 3226 | + "schema": { | ||
| 3227 | + "type": "string" | ||
| 3228 | + }, | ||
| 3229 | + "deprecated": false | ||
| 3230 | + }, | ||
| 3231 | + { | ||
| 3232 | + "name": "_start", | ||
| 3233 | + "in": "query", | ||
| 3234 | + "required": false, | ||
| 3235 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 3236 | + "schema": { | ||
| 3237 | + "type": "integer" | ||
| 3238 | + }, | ||
| 3239 | + "deprecated": false | ||
| 3240 | + }, | ||
| 3241 | + { | ||
| 3242 | + "name": "=", | ||
| 3243 | + "in": "query", | ||
| 3244 | + "required": false, | ||
| 3245 | + "description": "Get entries that matches exactly your input", | ||
| 3246 | + "schema": { | ||
| 3247 | + "type": "string" | ||
| 3248 | + }, | ||
| 3249 | + "deprecated": false | ||
| 3250 | + }, | ||
| 3251 | + { | ||
| 3252 | + "name": "_ne", | ||
| 3253 | + "in": "query", | ||
| 3254 | + "required": false, | ||
| 3255 | + "description": "Get records that are not equals to something", | ||
| 3256 | + "schema": { | ||
| 3257 | + "type": "string" | ||
| 3258 | + }, | ||
| 3259 | + "deprecated": false | ||
| 3260 | + }, | ||
| 3261 | + { | ||
| 3262 | + "name": "_lt", | ||
| 3263 | + "in": "query", | ||
| 3264 | + "required": false, | ||
| 3265 | + "description": "Get record that are lower than a value", | ||
| 3266 | + "schema": { | ||
| 3267 | + "type": "string" | ||
| 3268 | + }, | ||
| 3269 | + "deprecated": false | ||
| 3270 | + }, | ||
| 3271 | + { | ||
| 3272 | + "name": "_lte", | ||
| 3273 | + "in": "query", | ||
| 3274 | + "required": false, | ||
| 3275 | + "description": "Get records that are lower than or equal to a value", | ||
| 3276 | + "schema": { | ||
| 3277 | + "type": "string" | ||
| 3278 | + }, | ||
| 3279 | + "deprecated": false | ||
| 3280 | + }, | ||
| 3281 | + { | ||
| 3282 | + "name": "_gt", | ||
| 3283 | + "in": "query", | ||
| 3284 | + "required": false, | ||
| 3285 | + "description": "Get records that are greater than a value", | ||
| 3286 | + "schema": { | ||
| 3287 | + "type": "string" | ||
| 3288 | + }, | ||
| 3289 | + "deprecated": false | ||
| 3290 | + }, | ||
| 3291 | + { | ||
| 3292 | + "name": "_gte", | ||
| 3293 | + "in": "query", | ||
| 3294 | + "required": false, | ||
| 3295 | + "description": "Get records that are greater than or equal a value", | ||
| 3296 | + "schema": { | ||
| 3297 | + "type": "string" | ||
| 3298 | + }, | ||
| 3299 | + "deprecated": false | ||
| 3300 | + }, | ||
| 3301 | + { | ||
| 3302 | + "name": "_contains", | ||
| 3303 | + "in": "query", | ||
| 3304 | + "required": false, | ||
| 3305 | + "description": "Get records that contains a value", | ||
| 3306 | + "schema": { | ||
| 3307 | + "type": "string" | ||
| 3308 | + }, | ||
| 3309 | + "deprecated": false | ||
| 3310 | + }, | ||
| 3311 | + { | ||
| 3312 | + "name": "_containss", | ||
| 3313 | + "in": "query", | ||
| 3314 | + "required": false, | ||
| 3315 | + "description": "Get records that contains (case sensitive) a value", | ||
| 3316 | + "schema": { | ||
| 3317 | + "type": "string" | ||
| 3318 | + }, | ||
| 3319 | + "deprecated": false | ||
| 3320 | + }, | ||
| 3321 | + { | ||
| 3322 | + "name": "_in", | ||
| 3323 | + "in": "query", | ||
| 3324 | + "required": false, | ||
| 3325 | + "description": "Get records that matches any value in the array of values", | ||
| 3326 | + "schema": { | ||
| 3327 | + "type": "array" | ||
| 3328 | + }, | ||
| 3329 | + "deprecated": false | ||
| 3330 | + }, | ||
| 3331 | + { | ||
| 3332 | + "name": "_nin", | ||
| 3333 | + "in": "query", | ||
| 3334 | + "required": false, | ||
| 3335 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 3336 | + "schema": { | ||
| 3337 | + "type": "array" | ||
| 3338 | + }, | ||
| 3339 | + "deprecated": false | ||
| 3340 | + } | ||
| 3341 | + ] | ||
| 3342 | + } | ||
| 3343 | + }, | ||
| 3344 | + "/users/me": { | ||
| 3345 | + "get": { | ||
| 3346 | + "deprecated": false, | ||
| 3347 | + "description": "Retrieve the logged in user information", | ||
| 3348 | + "responses": { | ||
| 3349 | + "200": { | ||
| 3350 | + "description": "response", | ||
| 3351 | + "content": { | ||
| 3352 | + "application/json": { | ||
| 3353 | + "schema": { | ||
| 3354 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 3355 | + } | ||
| 3356 | + } | ||
| 3357 | + } | ||
| 3358 | + }, | ||
| 3359 | + "403": { | ||
| 3360 | + "description": "Forbidden", | ||
| 3361 | + "content": { | ||
| 3362 | + "application/json": { | ||
| 3363 | + "schema": { | ||
| 3364 | + "$ref": "#/components/schemas/Error" | ||
| 3365 | + } | ||
| 3366 | + } | ||
| 3367 | + } | ||
| 3368 | + }, | ||
| 3369 | + "404": { | ||
| 3370 | + "description": "Not found", | ||
| 3371 | + "content": { | ||
| 3372 | + "application/json": { | ||
| 3373 | + "schema": { | ||
| 3374 | + "$ref": "#/components/schemas/Error" | ||
| 3375 | + } | ||
| 3376 | + } | ||
| 3377 | + } | ||
| 3378 | + }, | ||
| 3379 | + "default": { | ||
| 3380 | + "description": "unexpected error", | ||
| 3381 | + "content": { | ||
| 3382 | + "application/json": { | ||
| 3383 | + "schema": { | ||
| 3384 | + "$ref": "#/components/schemas/Error" | ||
| 3385 | + } | ||
| 3386 | + } | ||
| 3387 | + } | ||
| 3388 | + } | ||
| 3389 | + }, | ||
| 3390 | + "summary": "", | ||
| 3391 | + "tags": [ | ||
| 3392 | + "Users-Permissions - User" | ||
| 3393 | + ], | ||
| 3394 | + "parameters": [] | ||
| 3395 | + } | ||
| 3396 | + }, | ||
| 3397 | + "/users/{id}": { | ||
| 3398 | + "get": { | ||
| 3399 | + "deprecated": false, | ||
| 3400 | + "description": "Retrieve a single user depending on his id", | ||
| 3401 | + "responses": { | ||
| 3402 | + "200": { | ||
| 3403 | + "description": "response", | ||
| 3404 | + "content": { | ||
| 3405 | + "application/json": { | ||
| 3406 | + "schema": { | ||
| 3407 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 3408 | + } | ||
| 3409 | + } | ||
| 3410 | + } | ||
| 3411 | + }, | ||
| 3412 | + "403": { | ||
| 3413 | + "description": "Forbidden", | ||
| 3414 | + "content": { | ||
| 3415 | + "application/json": { | ||
| 3416 | + "schema": { | ||
| 3417 | + "$ref": "#/components/schemas/Error" | ||
| 3418 | + } | ||
| 3419 | + } | ||
| 3420 | + } | ||
| 3421 | + }, | ||
| 3422 | + "404": { | ||
| 3423 | + "description": "Not found", | ||
| 3424 | + "content": { | ||
| 3425 | + "application/json": { | ||
| 3426 | + "schema": { | ||
| 3427 | + "$ref": "#/components/schemas/Error" | ||
| 3428 | + } | ||
| 3429 | + } | ||
| 3430 | + } | ||
| 3431 | + }, | ||
| 3432 | + "default": { | ||
| 3433 | + "description": "unexpected error", | ||
| 3434 | + "content": { | ||
| 3435 | + "application/json": { | ||
| 3436 | + "schema": { | ||
| 3437 | + "$ref": "#/components/schemas/Error" | ||
| 3438 | + } | ||
| 3439 | + } | ||
| 3440 | + } | ||
| 3441 | + } | ||
| 3442 | + }, | ||
| 3443 | + "summary": "", | ||
| 3444 | + "tags": [ | ||
| 3445 | + "Users-Permissions - User" | ||
| 3446 | + ], | ||
| 3447 | + "parameters": [ | ||
| 3448 | + { | ||
| 3449 | + "name": "id", | ||
| 3450 | + "in": "path", | ||
| 3451 | + "description": "", | ||
| 3452 | + "deprecated": false, | ||
| 3453 | + "required": true, | ||
| 3454 | + "schema": { | ||
| 3455 | + "type": "string" | ||
| 3456 | + } | ||
| 3457 | + } | ||
| 3458 | + ] | ||
| 3459 | + }, | ||
| 3460 | + "put": { | ||
| 3461 | + "deprecated": false, | ||
| 3462 | + "description": "Update an existing user", | ||
| 3463 | + "responses": { | ||
| 3464 | + "200": { | ||
| 3465 | + "description": "response", | ||
| 3466 | + "content": { | ||
| 3467 | + "application/json": { | ||
| 3468 | + "schema": { | ||
| 3469 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 3470 | + } | ||
| 3471 | + } | ||
| 3472 | + } | ||
| 3473 | + }, | ||
| 3474 | + "403": { | ||
| 3475 | + "description": "Forbidden", | ||
| 3476 | + "content": { | ||
| 3477 | + "application/json": { | ||
| 3478 | + "schema": { | ||
| 3479 | + "$ref": "#/components/schemas/Error" | ||
| 3480 | + } | ||
| 3481 | + } | ||
| 3482 | + } | ||
| 3483 | + }, | ||
| 3484 | + "404": { | ||
| 3485 | + "description": "Not found", | ||
| 3486 | + "content": { | ||
| 3487 | + "application/json": { | ||
| 3488 | + "schema": { | ||
| 3489 | + "$ref": "#/components/schemas/Error" | ||
| 3490 | + } | ||
| 3491 | + } | ||
| 3492 | + } | ||
| 3493 | + }, | ||
| 3494 | + "default": { | ||
| 3495 | + "description": "unexpected error", | ||
| 3496 | + "content": { | ||
| 3497 | + "application/json": { | ||
| 3498 | + "schema": { | ||
| 3499 | + "$ref": "#/components/schemas/Error" | ||
| 3500 | + } | ||
| 3501 | + } | ||
| 3502 | + } | ||
| 3503 | + } | ||
| 3504 | + }, | ||
| 3505 | + "summary": "", | ||
| 3506 | + "tags": [ | ||
| 3507 | + "Users-Permissions - User" | ||
| 3508 | + ], | ||
| 3509 | + "parameters": [ | ||
| 3510 | + { | ||
| 3511 | + "name": "id", | ||
| 3512 | + "in": "path", | ||
| 3513 | + "description": "", | ||
| 3514 | + "deprecated": false, | ||
| 3515 | + "required": true, | ||
| 3516 | + "schema": { | ||
| 3517 | + "type": "string" | ||
| 3518 | + } | ||
| 3519 | + } | ||
| 3520 | + ], | ||
| 3521 | + "requestBody": { | ||
| 3522 | + "description": "", | ||
| 3523 | + "required": true, | ||
| 3524 | + "content": { | ||
| 3525 | + "application/json": { | ||
| 3526 | + "schema": { | ||
| 3527 | + "$ref": "#/components/schemas/NewUsers-PermissionsUser" | ||
| 3528 | + } | ||
| 3529 | + } | ||
| 3530 | + } | ||
| 3531 | + } | ||
| 3532 | + }, | ||
| 3533 | + "delete": { | ||
| 3534 | + "deprecated": false, | ||
| 3535 | + "description": "Delete an existing user", | ||
| 3536 | + "responses": { | ||
| 3537 | + "200": { | ||
| 3538 | + "description": "response", | ||
| 3539 | + "content": { | ||
| 3540 | + "application/json": { | ||
| 3541 | + "schema": { | ||
| 3542 | + "properties": { | ||
| 3543 | + "foo": { | ||
| 3544 | + "type": "string" | ||
| 3545 | + } | ||
| 3546 | + } | ||
| 3547 | + } | ||
| 3548 | + } | ||
| 3549 | + } | ||
| 3550 | + }, | ||
| 3551 | + "403": { | ||
| 3552 | + "description": "Forbidden", | ||
| 3553 | + "content": { | ||
| 3554 | + "application/json": { | ||
| 3555 | + "schema": { | ||
| 3556 | + "$ref": "#/components/schemas/Error" | ||
| 3557 | + } | ||
| 3558 | + } | ||
| 3559 | + } | ||
| 3560 | + }, | ||
| 3561 | + "404": { | ||
| 3562 | + "description": "Not found", | ||
| 3563 | + "content": { | ||
| 3564 | + "application/json": { | ||
| 3565 | + "schema": { | ||
| 3566 | + "$ref": "#/components/schemas/Error" | ||
| 3567 | + } | ||
| 3568 | + } | ||
| 3569 | + } | ||
| 3570 | + }, | ||
| 3571 | + "default": { | ||
| 3572 | + "description": "unexpected error", | ||
| 3573 | + "content": { | ||
| 3574 | + "application/json": { | ||
| 3575 | + "schema": { | ||
| 3576 | + "$ref": "#/components/schemas/Error" | ||
| 3577 | + } | ||
| 3578 | + } | ||
| 3579 | + } | ||
| 3580 | + } | ||
| 3581 | + }, | ||
| 3582 | + "summary": "", | ||
| 3583 | + "tags": [ | ||
| 3584 | + "Users-Permissions - User" | ||
| 3585 | + ], | ||
| 3586 | + "parameters": [ | ||
| 3587 | + { | ||
| 3588 | + "name": "id", | ||
| 3589 | + "in": "path", | ||
| 3590 | + "description": "", | ||
| 3591 | + "deprecated": false, | ||
| 3592 | + "required": true, | ||
| 3593 | + "schema": { | ||
| 3594 | + "type": "string" | ||
| 3595 | + } | ||
| 3596 | + } | ||
| 3597 | + ] | ||
| 3598 | + } | ||
| 3599 | + } | ||
| 3600 | + }, | ||
| 3601 | + "components": { | ||
| 3602 | + "schemas": { | ||
| 3603 | + "Work": { | ||
| 3604 | + "required": [ | ||
| 3605 | + "id" | ||
| 3606 | + ], | ||
| 3607 | + "properties": { | ||
| 3608 | + "id": { | ||
| 3609 | + "type": "string" | ||
| 3610 | + }, | ||
| 3611 | + "title": { | ||
| 3612 | + "type": "string" | ||
| 3613 | + }, | ||
| 3614 | + "description": { | ||
| 3615 | + "type": "string" | ||
| 3616 | + }, | ||
| 3617 | + "cover_image_url": { | ||
| 3618 | + "type": "string" | ||
| 3619 | + }, | ||
| 3620 | + "pages": { | ||
| 3621 | + "type": "object" | ||
| 3622 | + }, | ||
| 3623 | + "is_publish": { | ||
| 3624 | + "type": "boolean" | ||
| 3625 | + }, | ||
| 3626 | + "is_template": { | ||
| 3627 | + "type": "boolean" | ||
| 3628 | + } | ||
| 3629 | + } | ||
| 3630 | + }, | ||
| 3631 | + "NewWork": { | ||
| 3632 | + "properties": { | ||
| 3633 | + "title": { | ||
| 3634 | + "type": "string" | ||
| 3635 | + }, | ||
| 3636 | + "description": { | ||
| 3637 | + "type": "string" | ||
| 3638 | + }, | ||
| 3639 | + "cover_image_url": { | ||
| 3640 | + "type": "string" | ||
| 3641 | + }, | ||
| 3642 | + "pages": { | ||
| 3643 | + "type": "object" | ||
| 3644 | + }, | ||
| 3645 | + "is_publish": { | ||
| 3646 | + "type": "boolean" | ||
| 3647 | + }, | ||
| 3648 | + "is_template": { | ||
| 3649 | + "type": "boolean" | ||
| 3650 | + } | ||
| 3651 | + } | ||
| 3652 | + }, | ||
| 3653 | + "Workform": { | ||
| 3654 | + "required": [ | ||
| 3655 | + "id" | ||
| 3656 | + ], | ||
| 3657 | + "properties": { | ||
| 3658 | + "id": { | ||
| 3659 | + "type": "string" | ||
| 3660 | + }, | ||
| 3661 | + "form": { | ||
| 3662 | + "type": "object" | ||
| 3663 | + }, | ||
| 3664 | + "work": { | ||
| 3665 | + "required": [ | ||
| 3666 | + "id" | ||
| 3667 | + ], | ||
| 3668 | + "properties": { | ||
| 3669 | + "id": { | ||
| 3670 | + "type": "string" | ||
| 3671 | + }, | ||
| 3672 | + "title": { | ||
| 3673 | + "type": "string" | ||
| 3674 | + }, | ||
| 3675 | + "description": { | ||
| 3676 | + "type": "string" | ||
| 3677 | + }, | ||
| 3678 | + "cover_image_url": { | ||
| 3679 | + "type": "string" | ||
| 3680 | + }, | ||
| 3681 | + "pages": { | ||
| 3682 | + "type": "object" | ||
| 3683 | + }, | ||
| 3684 | + "is_publish": { | ||
| 3685 | + "type": "boolean" | ||
| 3686 | + }, | ||
| 3687 | + "is_template": { | ||
| 3688 | + "type": "boolean" | ||
| 3689 | + } | ||
| 3690 | + } | ||
| 3691 | + } | ||
| 3692 | + } | ||
| 3693 | + }, | ||
| 3694 | + "NewWorkform": { | ||
| 3695 | + "properties": { | ||
| 3696 | + "form": { | ||
| 3697 | + "type": "object" | ||
| 3698 | + }, | ||
| 3699 | + "work": { | ||
| 3700 | + "type": "string" | ||
| 3701 | + } | ||
| 3702 | + } | ||
| 3703 | + }, | ||
| 3704 | + "Users-PermissionsRole": { | ||
| 3705 | + "required": [ | ||
| 3706 | + "id", | ||
| 3707 | + "name" | ||
| 3708 | + ], | ||
| 3709 | + "properties": { | ||
| 3710 | + "id": { | ||
| 3711 | + "type": "string" | ||
| 3712 | + }, | ||
| 3713 | + "name": { | ||
| 3714 | + "type": "string", | ||
| 3715 | + "minLength": 3 | ||
| 3716 | + }, | ||
| 3717 | + "description": { | ||
| 3718 | + "type": "string" | ||
| 3719 | + }, | ||
| 3720 | + "type": { | ||
| 3721 | + "type": "string" | ||
| 3722 | + }, | ||
| 3723 | + "permissions": { | ||
| 3724 | + "type": "array", | ||
| 3725 | + "items": { | ||
| 3726 | + "required": [ | ||
| 3727 | + "id", | ||
| 3728 | + "type", | ||
| 3729 | + "controller", | ||
| 3730 | + "action", | ||
| 3731 | + "enabled" | ||
| 3732 | + ], | ||
| 3733 | + "properties": { | ||
| 3734 | + "id": { | ||
| 3735 | + "type": "string" | ||
| 3736 | + }, | ||
| 3737 | + "type": { | ||
| 3738 | + "type": "string" | ||
| 3739 | + }, | ||
| 3740 | + "controller": { | ||
| 3741 | + "type": "string" | ||
| 3742 | + }, | ||
| 3743 | + "action": { | ||
| 3744 | + "type": "string" | ||
| 3745 | + }, | ||
| 3746 | + "enabled": { | ||
| 3747 | + "type": "boolean" | ||
| 3748 | + }, | ||
| 3749 | + "policy": { | ||
| 3750 | + "type": "string" | ||
| 3751 | + }, | ||
| 3752 | + "role": { | ||
| 3753 | + "type": "string" | ||
| 3754 | + } | ||
| 3755 | + } | ||
| 3756 | + } | ||
| 3757 | + }, | ||
| 3758 | + "users": { | ||
| 3759 | + "type": "array", | ||
| 3760 | + "items": { | ||
| 3761 | + "required": [ | ||
| 3762 | + "id", | ||
| 3763 | + "username", | ||
| 3764 | + "email" | ||
| 3765 | + ], | ||
| 3766 | + "properties": { | ||
| 3767 | + "id": { | ||
| 3768 | + "type": "string" | ||
| 3769 | + }, | ||
| 3770 | + "username": { | ||
| 3771 | + "type": "string" | ||
| 3772 | + }, | ||
| 3773 | + "email": { | ||
| 3774 | + "type": "string" | ||
| 3775 | + }, | ||
| 3776 | + "provider": { | ||
| 3777 | + "type": "string" | ||
| 3778 | + }, | ||
| 3779 | + "password": { | ||
| 3780 | + "type": "string" | ||
| 3781 | + }, | ||
| 3782 | + "resetPasswordToken": { | ||
| 3783 | + "type": "string" | ||
| 3784 | + }, | ||
| 3785 | + "confirmed": { | ||
| 3786 | + "type": "boolean" | ||
| 3787 | + }, | ||
| 3788 | + "blocked": { | ||
| 3789 | + "type": "boolean" | ||
| 3790 | + }, | ||
| 3791 | + "role": { | ||
| 3792 | + "type": "string" | ||
| 3793 | + } | ||
| 3794 | + } | ||
| 3795 | + } | ||
| 3796 | + } | ||
| 3797 | + } | ||
| 3798 | + }, | ||
| 3799 | + "NewUsers-PermissionsRole": { | ||
| 3800 | + "required": [ | ||
| 3801 | + "name" | ||
| 3802 | + ], | ||
| 3803 | + "properties": { | ||
| 3804 | + "name": { | ||
| 3805 | + "type": "string", | ||
| 3806 | + "minLength": 3 | ||
| 3807 | + }, | ||
| 3808 | + "description": { | ||
| 3809 | + "type": "string" | ||
| 3810 | + }, | ||
| 3811 | + "type": { | ||
| 3812 | + "type": "string" | ||
| 3813 | + }, | ||
| 3814 | + "permissions": { | ||
| 3815 | + "type": "array", | ||
| 3816 | + "items": { | ||
| 3817 | + "type": "string" | ||
| 3818 | + } | ||
| 3819 | + }, | ||
| 3820 | + "users": { | ||
| 3821 | + "type": "array", | ||
| 3822 | + "items": { | ||
| 3823 | + "type": "string" | ||
| 3824 | + } | ||
| 3825 | + } | ||
| 3826 | + } | ||
| 3827 | + }, | ||
| 3828 | + "Users-PermissionsUser": { | ||
| 3829 | + "required": [ | ||
| 3830 | + "id", | ||
| 3831 | + "username", | ||
| 3832 | + "email" | ||
| 3833 | + ], | ||
| 3834 | + "properties": { | ||
| 3835 | + "id": { | ||
| 3836 | + "type": "string" | ||
| 3837 | + }, | ||
| 3838 | + "username": { | ||
| 3839 | + "type": "string", | ||
| 3840 | + "minLength": 3 | ||
| 3841 | + }, | ||
| 3842 | + "email": { | ||
| 3843 | + "type": "string", | ||
| 3844 | + "minLength": 6 | ||
| 3845 | + }, | ||
| 3846 | + "provider": { | ||
| 3847 | + "type": "string" | ||
| 3848 | + }, | ||
| 3849 | + "confirmed": { | ||
| 3850 | + "type": "boolean", | ||
| 3851 | + "default": false | ||
| 3852 | + }, | ||
| 3853 | + "blocked": { | ||
| 3854 | + "type": "boolean", | ||
| 3855 | + "default": false | ||
| 3856 | + }, | ||
| 3857 | + "role": { | ||
| 3858 | + "required": [ | ||
| 3859 | + "id", | ||
| 3860 | + "name" | ||
| 3861 | + ], | ||
| 3862 | + "properties": { | ||
| 3863 | + "id": { | ||
| 3864 | + "type": "string" | ||
| 3865 | + }, | ||
| 3866 | + "name": { | ||
| 3867 | + "type": "string" | ||
| 3868 | + }, | ||
| 3869 | + "description": { | ||
| 3870 | + "type": "string" | ||
| 3871 | + }, | ||
| 3872 | + "type": { | ||
| 3873 | + "type": "string" | ||
| 3874 | + }, | ||
| 3875 | + "permissions": { | ||
| 3876 | + "type": "array", | ||
| 3877 | + "items": { | ||
| 3878 | + "type": "string" | ||
| 3879 | + } | ||
| 3880 | + }, | ||
| 3881 | + "users": { | ||
| 3882 | + "type": "array", | ||
| 3883 | + "items": { | ||
| 3884 | + "type": "string" | ||
| 3885 | + } | ||
| 3886 | + } | ||
| 3887 | + } | ||
| 3888 | + } | ||
| 3889 | + } | ||
| 3890 | + }, | ||
| 3891 | + "NewUsers-PermissionsUser": { | ||
| 3892 | + "required": [ | ||
| 3893 | + "username", | ||
| 3894 | + "email" | ||
| 3895 | + ], | ||
| 3896 | + "properties": { | ||
| 3897 | + "username": { | ||
| 3898 | + "type": "string", | ||
| 3899 | + "minLength": 3 | ||
| 3900 | + }, | ||
| 3901 | + "email": { | ||
| 3902 | + "type": "string", | ||
| 3903 | + "minLength": 6 | ||
| 3904 | + }, | ||
| 3905 | + "provider": { | ||
| 3906 | + "type": "string" | ||
| 3907 | + }, | ||
| 3908 | + "password": { | ||
| 3909 | + "type": "string", | ||
| 3910 | + "minLength": 6 | ||
| 3911 | + }, | ||
| 3912 | + "resetPasswordToken": { | ||
| 3913 | + "type": "string" | ||
| 3914 | + }, | ||
| 3915 | + "confirmed": { | ||
| 3916 | + "type": "boolean", | ||
| 3917 | + "default": false | ||
| 3918 | + }, | ||
| 3919 | + "blocked": { | ||
| 3920 | + "type": "boolean", | ||
| 3921 | + "default": false | ||
| 3922 | + }, | ||
| 3923 | + "role": { | ||
| 3924 | + "type": "string" | ||
| 3925 | + } | ||
| 3926 | + } | ||
| 3927 | + }, | ||
| 3928 | + "Error": { | ||
| 3929 | + "required": [ | ||
| 3930 | + "code", | ||
| 3931 | + "message" | ||
| 3932 | + ], | ||
| 3933 | + "properties": { | ||
| 3934 | + "code": { | ||
| 3935 | + "type": "integer", | ||
| 3936 | + "format": "int32" | ||
| 3937 | + }, | ||
| 3938 | + "message": { | ||
| 3939 | + "type": "string" | ||
| 3940 | + } | ||
| 3941 | + } | ||
| 3942 | + } | ||
| 3943 | + }, | ||
| 3944 | + "securitySchemes": { | ||
| 3945 | + "bearerAuth": { | ||
| 3946 | + "type": "http", | ||
| 3947 | + "scheme": "bearer", | ||
| 3948 | + "bearerFormat": "JWT" | ||
| 3949 | + } | ||
| 3950 | + } | ||
| 3951 | + }, | ||
| 3952 | + "tags": [ | ||
| 3953 | + { | ||
| 3954 | + "name": "Work" | ||
| 3955 | + }, | ||
| 3956 | + { | ||
| 3957 | + "name": "Workform" | ||
| 3958 | + }, | ||
| 3959 | + { | ||
| 3960 | + "name": "Email - Email" | ||
| 3961 | + }, | ||
| 3962 | + { | ||
| 3963 | + "name": "Upload - File" | ||
| 3964 | + }, | ||
| 3965 | + { | ||
| 3966 | + "name": "Users-Permissions - Role" | ||
| 3967 | + }, | ||
| 3968 | + { | ||
| 3969 | + "name": "Users-Permissions - User" | ||
| 3970 | + } | ||
| 3971 | + ] | ||
| 3972 | +} | ||
| 0 | \ No newline at end of file | 3973 | \ No newline at end of file |
back-end/h5-api/extensions/documentation/public/index.html
0 → 100644
| 1 | +<!-- HTML for static distribution bundle build --><!DOCTYPE html><html lang="en"><head> | ||
| 2 | + <meta charset="UTF-8"> | ||
| 3 | + <title>Swagger UI</title> | ||
| 4 | + <link rel="stylesheet" type="text/css" href="/plugins/documentation/swagger-ui.css"> | ||
| 5 | + <link rel="icon" type="image/png" href="/plugins/documentation/favicon-32x32.png" sizes="32x32"> | ||
| 6 | + <link rel="icon" type="image/png" href="/plugins/documentation/favicon-16x16.png" sizes="16x16"> | ||
| 7 | + <style> | ||
| 8 | + html | ||
| 9 | + { | ||
| 10 | + box-sizing: border-box; | ||
| 11 | + overflow: -moz-scrollbars-vertical; | ||
| 12 | + overflow-y: scroll; | ||
| 13 | + } | ||
| 14 | + | ||
| 15 | + *, | ||
| 16 | + *:before, | ||
| 17 | + *:after | ||
| 18 | + { | ||
| 19 | + box-sizing: inherit; | ||
| 20 | + } | ||
| 21 | + | ||
| 22 | + body | ||
| 23 | + { | ||
| 24 | + margin:0; | ||
| 25 | + background: #fafafa; | ||
| 26 | + } | ||
| 27 | + </style> | ||
| 28 | + </head> | ||
| 29 | + | ||
| 30 | + <body> | ||
| 31 | + <div id="swagger-ui"></div> | ||
| 32 | + | ||
| 33 | + <script src="/plugins/documentation/swagger-ui-bundle.js"> </script> | ||
| 34 | + <script src="/plugins/documentation/swagger-ui-standalone-preset.js"> </script> | ||
| 35 | + | ||
| 36 | + | ||
| 37 | + | ||
| 38 | + | ||
| 39 | + | ||
| 40 | + | ||
| 41 | + | ||
| 42 | + | ||
| 43 | + | ||
| 44 | + | ||
| 45 | + | ||
| 46 | + | ||
| 47 | + | ||
| 48 | + | ||
| 49 | + | ||
| 50 | + | ||
| 51 | + | ||
| 52 | + | ||
| 53 | + | ||
| 54 | + | ||
| 55 | + | ||
| 56 | + | ||
| 57 | + | ||
| 58 | + | ||
| 59 | + | ||
| 60 | + | ||
| 61 | + | ||
| 62 | + | ||
| 63 | + | ||
| 64 | + | ||
| 65 | + | ||
| 66 | + | ||
| 67 | + | ||
| 68 | + | ||
| 69 | + | ||
| 70 | + | ||
| 71 | + | ||
| 72 | + | ||
| 73 | + | ||
| 74 | + | ||
| 75 | + | ||
| 76 | + | ||
| 77 | + | ||
| 78 | + | ||
| 79 | + | ||
| 80 | + | ||
| 81 | + | ||
| 82 | + | ||
| 83 | + | ||
| 84 | + | ||
| 85 | + | ||
| 86 | + | ||
| 87 | + | ||
| 88 | + | ||
| 89 | + | ||
| 90 | + | ||
| 91 | + | ||
| 92 | + | ||
| 93 | + | ||
| 94 | + | ||
| 95 | + | ||
| 96 | + | ||
| 97 | + | ||
| 98 | + | ||
| 99 | + | ||
| 100 | + | ||
| 101 | + | ||
| 102 | + | ||
| 103 | + | ||
| 104 | + | ||
| 105 | + | ||
| 106 | + | ||
| 107 | + | ||
| 108 | + | ||
| 109 | + | ||
| 110 | + | ||
| 111 | + | ||
| 112 | + | ||
| 113 | + | ||
| 114 | + | ||
| 115 | + | ||
| 116 | + | ||
| 117 | + | ||
| 118 | + | ||
| 119 | + | ||
| 120 | + | ||
| 121 | + | ||
| 122 | + | ||
| 123 | + | ||
| 124 | + | ||
| 125 | + | ||
| 126 | + | ||
| 127 | + | ||
| 128 | + | ||
| 129 | + | ||
| 130 | + | ||
| 131 | + | ||
| 132 | + | ||
| 133 | + | ||
| 134 | + | ||
| 135 | + | ||
| 136 | + | ||
| 137 | + | ||
| 138 | + | ||
| 139 | + | ||
| 140 | + | ||
| 141 | + | ||
| 142 | + | ||
| 143 | + | ||
| 144 | + | ||
| 145 | + | ||
| 146 | + | ||
| 147 | + | ||
| 148 | + | ||
| 149 | + | ||
| 150 | + | ||
| 151 | + | ||
| 152 | + | ||
| 153 | + | ||
| 154 | + | ||
| 155 | + | ||
| 156 | + | ||
| 157 | + | ||
| 158 | + | ||
| 159 | + | ||
| 160 | + | ||
| 161 | + | ||
| 162 | + | ||
| 163 | + | ||
| 164 | + | ||
| 165 | + | ||
| 166 | + | ||
| 167 | + | ||
| 168 | + | ||
| 169 | + | ||
| 170 | + | ||
| 171 | + | ||
| 172 | + | ||
| 173 | + | ||
| 174 | + | ||
| 175 | + | ||
| 176 | + | ||
| 177 | + | ||
| 178 | + | ||
| 179 | + | ||
| 180 | + | ||
| 181 | + | ||
| 182 | + | ||
| 183 | + | ||
| 184 | + | ||
| 185 | + | ||
| 186 | + | ||
| 187 | + | ||
| 188 | + | ||
| 189 | + | ||
| 190 | + | ||
| 191 | + | ||
| 192 | + | ||
| 193 | + | ||
| 194 | + | ||
| 195 | + | ||
| 196 | + | ||
| 197 | + | ||
| 198 | + | ||
| 199 | + | ||
| 200 | + | ||
| 201 | + | ||
| 202 | + | ||
| 203 | + | ||
| 204 | + | ||
| 205 | + | ||
| 206 | + | ||
| 207 | + | ||
| 208 | + | ||
| 209 | + | ||
| 210 | + | ||
| 211 | + | ||
| 212 | + | ||
| 213 | + | ||
| 214 | + | ||
| 215 | + | ||
| 216 | + | ||
| 217 | + | ||
| 218 | + | ||
| 219 | + | ||
| 220 | + | ||
| 221 | + | ||
| 222 | + | ||
| 223 | + | ||
| 224 | + | ||
| 225 | + | ||
| 226 | + | ||
| 227 | + | ||
| 228 | + | ||
| 229 | + | ||
| 230 | + | ||
| 231 | + | ||
| 232 | + | ||
| 233 | + | ||
| 234 | + | ||
| 235 | + | ||
| 236 | + | ||
| 237 | + | ||
| 238 | + | ||
| 239 | + | ||
| 240 | + | ||
| 241 | + | ||
| 242 | + | ||
| 243 | + | ||
| 244 | + | ||
| 245 | + | ||
| 246 | + | ||
| 247 | + | ||
| 248 | + | ||
| 249 | + | ||
| 250 | + | ||
| 251 | + | ||
| 252 | + | ||
| 253 | + | ||
| 254 | + | ||
| 255 | + | ||
| 256 | + | ||
| 257 | + | ||
| 258 | + | ||
| 259 | + | ||
| 260 | + | ||
| 261 | + | ||
| 262 | + | ||
| 263 | + | ||
| 264 | + | ||
| 265 | + | ||
| 266 | + | ||
| 267 | + | ||
| 268 | + | ||
| 269 | + | ||
| 270 | + | ||
| 271 | + | ||
| 272 | + | ||
| 273 | + | ||
| 274 | + | ||
| 275 | + | ||
| 276 | + | ||
| 277 | + | ||
| 278 | + | ||
| 279 | + | ||
| 280 | + | ||
| 281 | + | ||
| 282 | + | ||
| 283 | + | ||
| 284 | + | ||
| 285 | + | ||
| 286 | + | ||
| 287 | + | ||
| 288 | + | ||
| 289 | + | ||
| 290 | + | ||
| 291 | + | ||
| 292 | + | ||
| 293 | + | ||
| 294 | + | ||
| 295 | + | ||
| 296 | + | ||
| 297 | + | ||
| 298 | + | ||
| 299 | + | ||
| 300 | + | ||
| 301 | + | ||
| 302 | + | ||
| 303 | + | ||
| 304 | + | ||
| 305 | + | ||
| 306 | + | ||
| 307 | + | ||
| 308 | + | ||
| 309 | + | ||
| 310 | + | ||
| 311 | + | ||
| 312 | + | ||
| 313 | + | ||
| 314 | + | ||
| 315 | + | ||
| 316 | + | ||
| 317 | + | ||
| 318 | + | ||
| 319 | + | ||
| 320 | + | ||
| 321 | + | ||
| 322 | + | ||
| 323 | + | ||
| 324 | + | ||
| 325 | + | ||
| 326 | + | ||
| 327 | + | ||
| 328 | + | ||
| 329 | + | ||
| 330 | + | ||
| 331 | + | ||
| 332 | + | ||
| 333 | + | ||
| 334 | + | ||
| 335 | + | ||
| 336 | + | ||
| 337 | + | ||
| 338 | + | ||
| 339 | + | ||
| 340 | + | ||
| 341 | + | ||
| 342 | + | ||
| 343 | + | ||
| 344 | + | ||
| 345 | + | ||
| 346 | + | ||
| 347 | + | ||
| 348 | + | ||
| 349 | + | ||
| 350 | + | ||
| 351 | + | ||
| 352 | + | ||
| 353 | + | ||
| 354 | + | ||
| 355 | + | ||
| 356 | + | ||
| 357 | + | ||
| 358 | + | ||
| 359 | + | ||
| 360 | + | ||
| 361 | + | ||
| 362 | + | ||
| 363 | + | ||
| 364 | + | ||
| 365 | + | ||
| 366 | + | ||
| 367 | + | ||
| 368 | + | ||
| 369 | + | ||
| 370 | + | ||
| 371 | + | ||
| 372 | + | ||
| 373 | + | ||
| 374 | + | ||
| 375 | + | ||
| 376 | + | ||
| 377 | + | ||
| 378 | + | ||
| 379 | + | ||
| 380 | + | ||
| 381 | + | ||
| 382 | + | ||
| 383 | + | ||
| 384 | + | ||
| 385 | + | ||
| 386 | + | ||
| 387 | + | ||
| 388 | + | ||
| 389 | + | ||
| 390 | + | ||
| 391 | + | ||
| 392 | + | ||
| 393 | + | ||
| 394 | + | ||
| 395 | + | ||
| 396 | + | ||
| 397 | + | ||
| 398 | + | ||
| 399 | + | ||
| 400 | + | ||
| 401 | + | ||
| 402 | + | ||
| 403 | + | ||
| 404 | + | ||
| 405 | + | ||
| 406 | + | ||
| 407 | + | ||
| 408 | + | ||
| 409 | + | ||
| 410 | + | ||
| 411 | + | ||
| 412 | + | ||
| 413 | + | ||
| 414 | + | ||
| 415 | + | ||
| 416 | + | ||
| 417 | + | ||
| 418 | + | ||
| 419 | + | ||
| 420 | + | ||
| 421 | + | ||
| 422 | + | ||
| 423 | + | ||
| 424 | + | ||
| 425 | + | ||
| 426 | + | ||
| 427 | + | ||
| 428 | + | ||
| 429 | + | ||
| 430 | + | ||
| 431 | + | ||
| 432 | + | ||
| 433 | + | ||
| 434 | + | ||
| 435 | + | ||
| 436 | + | ||
| 437 | + | ||
| 438 | + | ||
| 439 | + | ||
| 440 | + | ||
| 441 | + | ||
| 442 | + | ||
| 443 | + | ||
| 444 | + | ||
| 445 | + | ||
| 446 | + | ||
| 447 | + | ||
| 448 | + | ||
| 449 | + | ||
| 450 | + <script class="custom-swagger-ui"> | ||
| 451 | + window.onload = function() { | ||
| 452 | + | ||
| 453 | + // Build a system | ||
| 454 | + const ui = SwaggerUIBundle({ | ||
| 455 | + url: "https://petstore.swagger.io/v2/swagger.json", | ||
| 456 | + spec: {"openapi":"3.0.0","info":{"version":"1.0.0","title":"DOCUMENTATION","description":"","termsOfService":"YOUR_TERMS_OF_SERVICE_URL","contact":{"name":"TEAM","email":"contact-email@something.io","url":"mywebsite.io"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"x-generation-date":"12/16/2019 8:50:56 AM"},"x-strapi-config":{"path":"/documentation","showGeneratedFiles":true},"servers":[{"url":"http://localhost:1337","description":"Development server"},{"url":"YOUR_STAGING_SERVER","description":"Staging server"},{"url":"YOUR_PRODUCTION_SERVER","description":"Production server"}],"externalDocs":{"description":"Find out more","url":"https://strapi.io/documentation/3.0.0-beta.x/"},"security":[{"bearerAuth":[]}],"paths":{"/works/cors-proxy":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[]}},"/works":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Work"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[{"name":"_limit","in":"query","required":false,"description":"Maximum number of results possible","schema":{"type":"integer"},"deprecated":false},{"name":"_sort","in":"query","required":false,"description":"Sort according to a specific field.","schema":{"type":"string"},"deprecated":false},{"name":"_start","in":"query","required":false,"description":"Skip a specific number of entries (especially useful for pagination)","schema":{"type":"integer"},"deprecated":false},{"name":"=","in":"query","required":false,"description":"Get entries that matches exactly your input","schema":{"type":"string"},"deprecated":false},{"name":"_ne","in":"query","required":false,"description":"Get records that are not equals to something","schema":{"type":"string"},"deprecated":false},{"name":"_lt","in":"query","required":false,"description":"Get record that are lower than a value","schema":{"type":"string"},"deprecated":false},{"name":"_lte","in":"query","required":false,"description":"Get records that are lower than or equal to a value","schema":{"type":"string"},"deprecated":false},{"name":"_gt","in":"query","required":false,"description":"Get records that are greater than a value","schema":{"type":"string"},"deprecated":false},{"name":"_gte","in":"query","required":false,"description":"Get records that are greater than or equal a value","schema":{"type":"string"},"deprecated":false},{"name":"_contains","in":"query","required":false,"description":"Get records that contains a value","schema":{"type":"string"},"deprecated":false},{"name":"_containss","in":"query","required":false,"description":"Get records that contains (case sensitive) a value","schema":{"type":"string"},"deprecated":false},{"name":"_in","in":"query","required":false,"description":"Get records that matches any value in the array of values","schema":{"type":"array"},"deprecated":false},{"name":"_nin","in":"query","required":false,"description":"Get records that doesn't match any value in the array of values","schema":{"type":"array"},"deprecated":false}]},"post":{"deprecated":false,"description":"Create a new record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Work"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWork"}}}}}},"/works/count":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[]}},"/works/{id}":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Work"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"put":{"deprecated":false,"description":"Update a record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Work"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWork"}}}},"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"delete":{"deprecated":false,"description":"Delete a record","responses":{"200":{"description":"deletes a single record based on the ID supplied","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/works/preview/{id}":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/works/form/submit/{id}":{"post":{"deprecated":false,"description":"Create a new record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/works/form/query/{id}":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/works/set-as-template/{id}":{"post":{"deprecated":false,"description":"Create a new record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/works/use-template/{id}":{"post":{"deprecated":false,"description":"Create a new record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Work"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/workforms":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Workform"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"parameters":[{"name":"_limit","in":"query","required":false,"description":"Maximum number of results possible","schema":{"type":"integer"},"deprecated":false},{"name":"_sort","in":"query","required":false,"description":"Sort according to a specific field.","schema":{"type":"string"},"deprecated":false},{"name":"_start","in":"query","required":false,"description":"Skip a specific number of entries (especially useful for pagination)","schema":{"type":"integer"},"deprecated":false},{"name":"=","in":"query","required":false,"description":"Get entries that matches exactly your input","schema":{"type":"string"},"deprecated":false},{"name":"_ne","in":"query","required":false,"description":"Get records that are not equals to something","schema":{"type":"string"},"deprecated":false},{"name":"_lt","in":"query","required":false,"description":"Get record that are lower than a value","schema":{"type":"string"},"deprecated":false},{"name":"_lte","in":"query","required":false,"description":"Get records that are lower than or equal to a value","schema":{"type":"string"},"deprecated":false},{"name":"_gt","in":"query","required":false,"description":"Get records that are greater than a value","schema":{"type":"string"},"deprecated":false},{"name":"_gte","in":"query","required":false,"description":"Get records that are greater than or equal a value","schema":{"type":"string"},"deprecated":false},{"name":"_contains","in":"query","required":false,"description":"Get records that contains a value","schema":{"type":"string"},"deprecated":false},{"name":"_containss","in":"query","required":false,"description":"Get records that contains (case sensitive) a value","schema":{"type":"string"},"deprecated":false},{"name":"_in","in":"query","required":false,"description":"Get records that matches any value in the array of values","schema":{"type":"array"},"deprecated":false},{"name":"_nin","in":"query","required":false,"description":"Get records that doesn't match any value in the array of values","schema":{"type":"array"},"deprecated":false}]},"post":{"deprecated":false,"description":"Create a new record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workform"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWorkform"}}}}}},"/workforms/count":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"parameters":[]}},"/workforms/{id}":{"get":{"deprecated":false,"description":"","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workform"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"put":{"deprecated":false,"description":"Update a record","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workform"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWorkform"}}}},"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"delete":{"deprecated":false,"description":"Delete a record","responses":{"200":{"description":"deletes a single record based on the ID supplied","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Workform"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/email/":{"post":{"deprecated":false,"description":"Send an email","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Email - Email"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/upload/":{"post":{"deprecated":false,"description":"Upload a file","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/upload/files/count":{"get":{"deprecated":false,"description":"Retrieve the total number of uploaded files","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[]}},"/upload/files":{"get":{"deprecated":false,"description":"Retrieve all file documents","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[]}},"/upload/files/{id}":{"get":{"deprecated":false,"description":"Retrieve a single file depending on its id","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"delete":{"deprecated":false,"description":"Delete an uploaded file","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/upload/search/{id}":{"get":{"deprecated":false,"description":"Search for an uploaded file","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Upload - File"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/users-permissions/init":{"get":{"deprecated":false,"description":"Check if the first admin user has already been registered","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"parameters":[]}},"/users-permissions/roles/{id}":{"get":{"deprecated":false,"description":"Retrieve a role depending on its id","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsRole"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/users-permissions/roles":{"get":{"deprecated":false,"description":"Retrieve all role documents","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Users-PermissionsRole"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"parameters":[{"name":"_limit","in":"query","required":false,"description":"Maximum number of results possible","schema":{"type":"integer"},"deprecated":false},{"name":"_sort","in":"query","required":false,"description":"Sort according to a specific field.","schema":{"type":"string"},"deprecated":false},{"name":"_start","in":"query","required":false,"description":"Skip a specific number of entries (especially useful for pagination)","schema":{"type":"integer"},"deprecated":false},{"name":"=","in":"query","required":false,"description":"Get entries that matches exactly your input","schema":{"type":"string"},"deprecated":false},{"name":"_ne","in":"query","required":false,"description":"Get records that are not equals to something","schema":{"type":"string"},"deprecated":false},{"name":"_lt","in":"query","required":false,"description":"Get record that are lower than a value","schema":{"type":"string"},"deprecated":false},{"name":"_lte","in":"query","required":false,"description":"Get records that are lower than or equal to a value","schema":{"type":"string"},"deprecated":false},{"name":"_gt","in":"query","required":false,"description":"Get records that are greater than a value","schema":{"type":"string"},"deprecated":false},{"name":"_gte","in":"query","required":false,"description":"Get records that are greater than or equal a value","schema":{"type":"string"},"deprecated":false},{"name":"_contains","in":"query","required":false,"description":"Get records that contains a value","schema":{"type":"string"},"deprecated":false},{"name":"_containss","in":"query","required":false,"description":"Get records that contains (case sensitive) a value","schema":{"type":"string"},"deprecated":false},{"name":"_in","in":"query","required":false,"description":"Get records that matches any value in the array of values","schema":{"type":"array"},"deprecated":false},{"name":"_nin","in":"query","required":false,"description":"Get records that doesn't match any value in the array of values","schema":{"type":"array"},"deprecated":false}]},"post":{"deprecated":false,"description":"Create a new role","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsRole"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUsers-PermissionsRole"}}}}}},"/users-permissions/roles/{role}":{"put":{"deprecated":false,"description":"Update a role","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsRole"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"parameters":[{"name":"role","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUsers-PermissionsRole"}}}}},"delete":{"deprecated":false,"description":"Delete a role","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - Role"],"parameters":[{"name":"role","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/users-permissions/search/{id}":{"get":{"deprecated":false,"description":"Search for users","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}},{"name":"_limit","in":"query","required":false,"description":"Maximum number of results possible","schema":{"type":"integer"},"deprecated":false},{"name":"_sort","in":"query","required":false,"description":"Sort according to a specific field.","schema":{"type":"string"},"deprecated":false},{"name":"_start","in":"query","required":false,"description":"Skip a specific number of entries (especially useful for pagination)","schema":{"type":"integer"},"deprecated":false},{"name":"=","in":"query","required":false,"description":"Get entries that matches exactly your input","schema":{"type":"string"},"deprecated":false},{"name":"_ne","in":"query","required":false,"description":"Get records that are not equals to something","schema":{"type":"string"},"deprecated":false},{"name":"_lt","in":"query","required":false,"description":"Get record that are lower than a value","schema":{"type":"string"},"deprecated":false},{"name":"_lte","in":"query","required":false,"description":"Get records that are lower than or equal to a value","schema":{"type":"string"},"deprecated":false},{"name":"_gt","in":"query","required":false,"description":"Get records that are greater than a value","schema":{"type":"string"},"deprecated":false},{"name":"_gte","in":"query","required":false,"description":"Get records that are greater than or equal a value","schema":{"type":"string"},"deprecated":false},{"name":"_contains","in":"query","required":false,"description":"Get records that contains a value","schema":{"type":"string"},"deprecated":false},{"name":"_containss","in":"query","required":false,"description":"Get records that contains (case sensitive) a value","schema":{"type":"string"},"deprecated":false},{"name":"_in","in":"query","required":false,"description":"Get records that matches any value in the array of values","schema":{"type":"array"},"deprecated":false},{"name":"_nin","in":"query","required":false,"description":"Get records that doesn't match any value in the array of values","schema":{"type":"array"},"deprecated":false}]}},"/connect/*":{"get":{"deprecated":false,"description":"Connect a provider","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[]}},"/auth/local":{"post":{"deprecated":false,"description":"Login a user using the identifiers email and password","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/auth/local/register":{"post":{"deprecated":false,"description":"Register a new user with the default role","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUsers-PermissionsUser"}}}}}},"/auth/{provider}/callback":{"get":{"deprecated":false,"description":"Successfull redirection after approving a provider","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"provider","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}},"/auth/forgot-password":{"post":{"deprecated":false,"description":"Send the reset password email link","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/auth/reset-password":{"post":{"deprecated":false,"description":"Change a user's password","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/auth/email-confirmation":{"get":{"deprecated":false,"description":"Validate a user account","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[]}},"/auth/send-email-confirmation":{"post":{"deprecated":false,"description":"Send a confirmation email to user","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}}}},"/users":{"get":{"deprecated":false,"description":"Retrieve all user documents","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"_limit","in":"query","required":false,"description":"Maximum number of results possible","schema":{"type":"integer"},"deprecated":false},{"name":"_sort","in":"query","required":false,"description":"Sort according to a specific field.","schema":{"type":"string"},"deprecated":false},{"name":"_start","in":"query","required":false,"description":"Skip a specific number of entries (especially useful for pagination)","schema":{"type":"integer"},"deprecated":false},{"name":"=","in":"query","required":false,"description":"Get entries that matches exactly your input","schema":{"type":"string"},"deprecated":false},{"name":"_ne","in":"query","required":false,"description":"Get records that are not equals to something","schema":{"type":"string"},"deprecated":false},{"name":"_lt","in":"query","required":false,"description":"Get record that are lower than a value","schema":{"type":"string"},"deprecated":false},{"name":"_lte","in":"query","required":false,"description":"Get records that are lower than or equal to a value","schema":{"type":"string"},"deprecated":false},{"name":"_gt","in":"query","required":false,"description":"Get records that are greater than a value","schema":{"type":"string"},"deprecated":false},{"name":"_gte","in":"query","required":false,"description":"Get records that are greater than or equal a value","schema":{"type":"string"},"deprecated":false},{"name":"_contains","in":"query","required":false,"description":"Get records that contains a value","schema":{"type":"string"},"deprecated":false},{"name":"_containss","in":"query","required":false,"description":"Get records that contains (case sensitive) a value","schema":{"type":"string"},"deprecated":false},{"name":"_in","in":"query","required":false,"description":"Get records that matches any value in the array of values","schema":{"type":"array"},"deprecated":false},{"name":"_nin","in":"query","required":false,"description":"Get records that doesn't match any value in the array of values","schema":{"type":"array"},"deprecated":false}]}},"/users/me":{"get":{"deprecated":false,"description":"Retrieve the logged in user information","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[]}},"/users/{id}":{"get":{"deprecated":false,"description":"Retrieve a single user depending on his id","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]},"put":{"deprecated":false,"description":"Update an existing user","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users-PermissionsUser"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUsers-PermissionsUser"}}}}},"delete":{"deprecated":false,"description":"Delete an existing user","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"properties":{"foo":{"type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"","tags":["Users-Permissions - User"],"parameters":[{"name":"id","in":"path","description":"","deprecated":false,"required":true,"schema":{"type":"string"}}]}}},"components":{"schemas":{"Work":{"required":["id"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"cover_image_url":{"type":"string"},"pages":{"type":"object"},"is_publish":{"type":"boolean"},"is_template":{"type":"boolean"}}},"NewWork":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"cover_image_url":{"type":"string"},"pages":{"type":"object"},"is_publish":{"type":"boolean"},"is_template":{"type":"boolean"}}},"Workform":{"required":["id"],"properties":{"id":{"type":"string"},"form":{"type":"object"},"work":{"required":["id"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"cover_image_url":{"type":"string"},"pages":{"type":"object"},"is_publish":{"type":"boolean"},"is_template":{"type":"boolean"}}}}},"NewWorkform":{"properties":{"form":{"type":"object"},"work":{"type":"string"}}},"Users-PermissionsRole":{"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":3},"description":{"type":"string"},"type":{"type":"string"},"permissions":{"type":"array","items":{"required":["id","type","controller","action","enabled"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"action":{"type":"string"},"enabled":{"type":"boolean"},"policy":{"type":"string"},"role":{"type":"string"}}}},"users":{"type":"array","items":{"required":["id","username","email"],"properties":{"id":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"provider":{"type":"string"},"password":{"type":"string"},"resetPasswordToken":{"type":"string"},"confirmed":{"type":"boolean"},"blocked":{"type":"boolean"},"role":{"type":"string"}}}}}},"NewUsers-PermissionsRole":{"required":["name"],"properties":{"name":{"type":"string","minLength":3},"description":{"type":"string"},"type":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}}}},"Users-PermissionsUser":{"required":["id","username","email"],"properties":{"id":{"type":"string"},"username":{"type":"string","minLength":3},"email":{"type":"string","minLength":6},"provider":{"type":"string"},"confirmed":{"type":"boolean","default":false},"blocked":{"type":"boolean","default":false},"role":{"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}}}}}},"NewUsers-PermissionsUser":{"required":["username","email"],"properties":{"username":{"type":"string","minLength":3},"email":{"type":"string","minLength":6},"provider":{"type":"string"},"password":{"type":"string","minLength":6},"resetPasswordToken":{"type":"string"},"confirmed":{"type":"boolean","default":false},"blocked":{"type":"boolean","default":false},"role":{"type":"string"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"Work"},{"name":"Workform"},{"name":"Email - Email"},{"name":"Upload - File"},{"name":"Users-Permissions - Role"},{"name":"Users-Permissions - User"}]}, | ||
| 457 | + dom_id: '#swagger-ui', | ||
| 458 | + docExpansion: "none", | ||
| 459 | + deepLinking: true, | ||
| 460 | + presets: [ | ||
| 461 | + SwaggerUIBundle.presets.apis, | ||
| 462 | + SwaggerUIStandalonePreset | ||
| 463 | + ], | ||
| 464 | + plugins: [ | ||
| 465 | + SwaggerUIBundle.plugins.DownloadUrl | ||
| 466 | + ], | ||
| 467 | + layout: "StandaloneLayout" | ||
| 468 | + }) | ||
| 469 | + | ||
| 470 | + window.ui = ui | ||
| 471 | + } | ||
| 472 | + </script> | ||
| 473 | + </body></html> | ||
| 0 | \ No newline at end of file | 474 | \ No newline at end of file |
back-end/h5-api/extensions/email/documentation/1.0.0/email-Email.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/email/": { | ||
| 4 | + "post": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "Send an email", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "properties": { | ||
| 14 | + "foo": { | ||
| 15 | + "type": "string" | ||
| 16 | + } | ||
| 17 | + } | ||
| 18 | + } | ||
| 19 | + } | ||
| 20 | + } | ||
| 21 | + }, | ||
| 22 | + "403": { | ||
| 23 | + "description": "Forbidden", | ||
| 24 | + "content": { | ||
| 25 | + "application/json": { | ||
| 26 | + "schema": { | ||
| 27 | + "$ref": "#/components/schemas/Error" | ||
| 28 | + } | ||
| 29 | + } | ||
| 30 | + } | ||
| 31 | + }, | ||
| 32 | + "404": { | ||
| 33 | + "description": "Not found", | ||
| 34 | + "content": { | ||
| 35 | + "application/json": { | ||
| 36 | + "schema": { | ||
| 37 | + "$ref": "#/components/schemas/Error" | ||
| 38 | + } | ||
| 39 | + } | ||
| 40 | + } | ||
| 41 | + }, | ||
| 42 | + "default": { | ||
| 43 | + "description": "unexpected error", | ||
| 44 | + "content": { | ||
| 45 | + "application/json": { | ||
| 46 | + "schema": { | ||
| 47 | + "$ref": "#/components/schemas/Error" | ||
| 48 | + } | ||
| 49 | + } | ||
| 50 | + } | ||
| 51 | + } | ||
| 52 | + }, | ||
| 53 | + "summary": "", | ||
| 54 | + "tags": [ | ||
| 55 | + "Email - Email" | ||
| 56 | + ], | ||
| 57 | + "requestBody": { | ||
| 58 | + "description": "", | ||
| 59 | + "required": true, | ||
| 60 | + "content": { | ||
| 61 | + "application/json": { | ||
| 62 | + "schema": { | ||
| 63 | + "properties": { | ||
| 64 | + "foo": { | ||
| 65 | + "type": "string" | ||
| 66 | + } | ||
| 67 | + } | ||
| 68 | + } | ||
| 69 | + } | ||
| 70 | + } | ||
| 71 | + } | ||
| 72 | + } | ||
| 73 | + } | ||
| 74 | + }, | ||
| 75 | + "tags": [ | ||
| 76 | + { | ||
| 77 | + "name": "Email - Email" | ||
| 78 | + } | ||
| 79 | + ] | ||
| 80 | +} | ||
| 0 | \ No newline at end of file | 81 | \ No newline at end of file |
back-end/h5-api/extensions/upload/documentation/1.0.0/upload-File.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/upload/": { | ||
| 4 | + "post": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "Upload a file", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "properties": { | ||
| 14 | + "foo": { | ||
| 15 | + "type": "string" | ||
| 16 | + } | ||
| 17 | + } | ||
| 18 | + } | ||
| 19 | + } | ||
| 20 | + } | ||
| 21 | + }, | ||
| 22 | + "403": { | ||
| 23 | + "description": "Forbidden", | ||
| 24 | + "content": { | ||
| 25 | + "application/json": { | ||
| 26 | + "schema": { | ||
| 27 | + "$ref": "#/components/schemas/Error" | ||
| 28 | + } | ||
| 29 | + } | ||
| 30 | + } | ||
| 31 | + }, | ||
| 32 | + "404": { | ||
| 33 | + "description": "Not found", | ||
| 34 | + "content": { | ||
| 35 | + "application/json": { | ||
| 36 | + "schema": { | ||
| 37 | + "$ref": "#/components/schemas/Error" | ||
| 38 | + } | ||
| 39 | + } | ||
| 40 | + } | ||
| 41 | + }, | ||
| 42 | + "default": { | ||
| 43 | + "description": "unexpected error", | ||
| 44 | + "content": { | ||
| 45 | + "application/json": { | ||
| 46 | + "schema": { | ||
| 47 | + "$ref": "#/components/schemas/Error" | ||
| 48 | + } | ||
| 49 | + } | ||
| 50 | + } | ||
| 51 | + } | ||
| 52 | + }, | ||
| 53 | + "summary": "", | ||
| 54 | + "tags": [ | ||
| 55 | + "Upload - File" | ||
| 56 | + ], | ||
| 57 | + "requestBody": { | ||
| 58 | + "description": "", | ||
| 59 | + "required": true, | ||
| 60 | + "content": { | ||
| 61 | + "application/json": { | ||
| 62 | + "schema": { | ||
| 63 | + "properties": { | ||
| 64 | + "foo": { | ||
| 65 | + "type": "string" | ||
| 66 | + } | ||
| 67 | + } | ||
| 68 | + } | ||
| 69 | + } | ||
| 70 | + } | ||
| 71 | + } | ||
| 72 | + } | ||
| 73 | + }, | ||
| 74 | + "/upload/files/count": { | ||
| 75 | + "get": { | ||
| 76 | + "deprecated": false, | ||
| 77 | + "description": "Retrieve the total number of uploaded files", | ||
| 78 | + "responses": { | ||
| 79 | + "200": { | ||
| 80 | + "description": "response", | ||
| 81 | + "content": { | ||
| 82 | + "application/json": { | ||
| 83 | + "schema": { | ||
| 84 | + "properties": { | ||
| 85 | + "foo": { | ||
| 86 | + "type": "string" | ||
| 87 | + } | ||
| 88 | + } | ||
| 89 | + } | ||
| 90 | + } | ||
| 91 | + } | ||
| 92 | + }, | ||
| 93 | + "403": { | ||
| 94 | + "description": "Forbidden", | ||
| 95 | + "content": { | ||
| 96 | + "application/json": { | ||
| 97 | + "schema": { | ||
| 98 | + "$ref": "#/components/schemas/Error" | ||
| 99 | + } | ||
| 100 | + } | ||
| 101 | + } | ||
| 102 | + }, | ||
| 103 | + "404": { | ||
| 104 | + "description": "Not found", | ||
| 105 | + "content": { | ||
| 106 | + "application/json": { | ||
| 107 | + "schema": { | ||
| 108 | + "$ref": "#/components/schemas/Error" | ||
| 109 | + } | ||
| 110 | + } | ||
| 111 | + } | ||
| 112 | + }, | ||
| 113 | + "default": { | ||
| 114 | + "description": "unexpected error", | ||
| 115 | + "content": { | ||
| 116 | + "application/json": { | ||
| 117 | + "schema": { | ||
| 118 | + "$ref": "#/components/schemas/Error" | ||
| 119 | + } | ||
| 120 | + } | ||
| 121 | + } | ||
| 122 | + } | ||
| 123 | + }, | ||
| 124 | + "summary": "", | ||
| 125 | + "tags": [ | ||
| 126 | + "Upload - File" | ||
| 127 | + ], | ||
| 128 | + "parameters": [] | ||
| 129 | + } | ||
| 130 | + }, | ||
| 131 | + "/upload/files": { | ||
| 132 | + "get": { | ||
| 133 | + "deprecated": false, | ||
| 134 | + "description": "Retrieve all file documents", | ||
| 135 | + "responses": { | ||
| 136 | + "200": { | ||
| 137 | + "description": "response", | ||
| 138 | + "content": { | ||
| 139 | + "application/json": { | ||
| 140 | + "schema": { | ||
| 141 | + "properties": { | ||
| 142 | + "foo": { | ||
| 143 | + "type": "string" | ||
| 144 | + } | ||
| 145 | + } | ||
| 146 | + } | ||
| 147 | + } | ||
| 148 | + } | ||
| 149 | + }, | ||
| 150 | + "403": { | ||
| 151 | + "description": "Forbidden", | ||
| 152 | + "content": { | ||
| 153 | + "application/json": { | ||
| 154 | + "schema": { | ||
| 155 | + "$ref": "#/components/schemas/Error" | ||
| 156 | + } | ||
| 157 | + } | ||
| 158 | + } | ||
| 159 | + }, | ||
| 160 | + "404": { | ||
| 161 | + "description": "Not found", | ||
| 162 | + "content": { | ||
| 163 | + "application/json": { | ||
| 164 | + "schema": { | ||
| 165 | + "$ref": "#/components/schemas/Error" | ||
| 166 | + } | ||
| 167 | + } | ||
| 168 | + } | ||
| 169 | + }, | ||
| 170 | + "default": { | ||
| 171 | + "description": "unexpected error", | ||
| 172 | + "content": { | ||
| 173 | + "application/json": { | ||
| 174 | + "schema": { | ||
| 175 | + "$ref": "#/components/schemas/Error" | ||
| 176 | + } | ||
| 177 | + } | ||
| 178 | + } | ||
| 179 | + } | ||
| 180 | + }, | ||
| 181 | + "summary": "", | ||
| 182 | + "tags": [ | ||
| 183 | + "Upload - File" | ||
| 184 | + ], | ||
| 185 | + "parameters": [] | ||
| 186 | + } | ||
| 187 | + }, | ||
| 188 | + "/upload/files/{id}": { | ||
| 189 | + "get": { | ||
| 190 | + "deprecated": false, | ||
| 191 | + "description": "Retrieve a single file depending on its id", | ||
| 192 | + "responses": { | ||
| 193 | + "200": { | ||
| 194 | + "description": "response", | ||
| 195 | + "content": { | ||
| 196 | + "application/json": { | ||
| 197 | + "schema": { | ||
| 198 | + "properties": { | ||
| 199 | + "foo": { | ||
| 200 | + "type": "string" | ||
| 201 | + } | ||
| 202 | + } | ||
| 203 | + } | ||
| 204 | + } | ||
| 205 | + } | ||
| 206 | + }, | ||
| 207 | + "403": { | ||
| 208 | + "description": "Forbidden", | ||
| 209 | + "content": { | ||
| 210 | + "application/json": { | ||
| 211 | + "schema": { | ||
| 212 | + "$ref": "#/components/schemas/Error" | ||
| 213 | + } | ||
| 214 | + } | ||
| 215 | + } | ||
| 216 | + }, | ||
| 217 | + "404": { | ||
| 218 | + "description": "Not found", | ||
| 219 | + "content": { | ||
| 220 | + "application/json": { | ||
| 221 | + "schema": { | ||
| 222 | + "$ref": "#/components/schemas/Error" | ||
| 223 | + } | ||
| 224 | + } | ||
| 225 | + } | ||
| 226 | + }, | ||
| 227 | + "default": { | ||
| 228 | + "description": "unexpected error", | ||
| 229 | + "content": { | ||
| 230 | + "application/json": { | ||
| 231 | + "schema": { | ||
| 232 | + "$ref": "#/components/schemas/Error" | ||
| 233 | + } | ||
| 234 | + } | ||
| 235 | + } | ||
| 236 | + } | ||
| 237 | + }, | ||
| 238 | + "summary": "", | ||
| 239 | + "tags": [ | ||
| 240 | + "Upload - File" | ||
| 241 | + ], | ||
| 242 | + "parameters": [ | ||
| 243 | + { | ||
| 244 | + "name": "id", | ||
| 245 | + "in": "path", | ||
| 246 | + "description": "", | ||
| 247 | + "deprecated": false, | ||
| 248 | + "required": true, | ||
| 249 | + "schema": { | ||
| 250 | + "type": "string" | ||
| 251 | + } | ||
| 252 | + } | ||
| 253 | + ] | ||
| 254 | + }, | ||
| 255 | + "delete": { | ||
| 256 | + "deprecated": false, | ||
| 257 | + "description": "Delete an uploaded file", | ||
| 258 | + "responses": { | ||
| 259 | + "200": { | ||
| 260 | + "description": "response", | ||
| 261 | + "content": { | ||
| 262 | + "application/json": { | ||
| 263 | + "schema": { | ||
| 264 | + "properties": { | ||
| 265 | + "foo": { | ||
| 266 | + "type": "string" | ||
| 267 | + } | ||
| 268 | + } | ||
| 269 | + } | ||
| 270 | + } | ||
| 271 | + } | ||
| 272 | + }, | ||
| 273 | + "403": { | ||
| 274 | + "description": "Forbidden", | ||
| 275 | + "content": { | ||
| 276 | + "application/json": { | ||
| 277 | + "schema": { | ||
| 278 | + "$ref": "#/components/schemas/Error" | ||
| 279 | + } | ||
| 280 | + } | ||
| 281 | + } | ||
| 282 | + }, | ||
| 283 | + "404": { | ||
| 284 | + "description": "Not found", | ||
| 285 | + "content": { | ||
| 286 | + "application/json": { | ||
| 287 | + "schema": { | ||
| 288 | + "$ref": "#/components/schemas/Error" | ||
| 289 | + } | ||
| 290 | + } | ||
| 291 | + } | ||
| 292 | + }, | ||
| 293 | + "default": { | ||
| 294 | + "description": "unexpected error", | ||
| 295 | + "content": { | ||
| 296 | + "application/json": { | ||
| 297 | + "schema": { | ||
| 298 | + "$ref": "#/components/schemas/Error" | ||
| 299 | + } | ||
| 300 | + } | ||
| 301 | + } | ||
| 302 | + } | ||
| 303 | + }, | ||
| 304 | + "summary": "", | ||
| 305 | + "tags": [ | ||
| 306 | + "Upload - File" | ||
| 307 | + ], | ||
| 308 | + "parameters": [ | ||
| 309 | + { | ||
| 310 | + "name": "id", | ||
| 311 | + "in": "path", | ||
| 312 | + "description": "", | ||
| 313 | + "deprecated": false, | ||
| 314 | + "required": true, | ||
| 315 | + "schema": { | ||
| 316 | + "type": "string" | ||
| 317 | + } | ||
| 318 | + } | ||
| 319 | + ] | ||
| 320 | + } | ||
| 321 | + }, | ||
| 322 | + "/upload/search/{id}": { | ||
| 323 | + "get": { | ||
| 324 | + "deprecated": false, | ||
| 325 | + "description": "Search for an uploaded file", | ||
| 326 | + "responses": { | ||
| 327 | + "200": { | ||
| 328 | + "description": "response", | ||
| 329 | + "content": { | ||
| 330 | + "application/json": { | ||
| 331 | + "schema": { | ||
| 332 | + "properties": { | ||
| 333 | + "foo": { | ||
| 334 | + "type": "string" | ||
| 335 | + } | ||
| 336 | + } | ||
| 337 | + } | ||
| 338 | + } | ||
| 339 | + } | ||
| 340 | + }, | ||
| 341 | + "403": { | ||
| 342 | + "description": "Forbidden", | ||
| 343 | + "content": { | ||
| 344 | + "application/json": { | ||
| 345 | + "schema": { | ||
| 346 | + "$ref": "#/components/schemas/Error" | ||
| 347 | + } | ||
| 348 | + } | ||
| 349 | + } | ||
| 350 | + }, | ||
| 351 | + "404": { | ||
| 352 | + "description": "Not found", | ||
| 353 | + "content": { | ||
| 354 | + "application/json": { | ||
| 355 | + "schema": { | ||
| 356 | + "$ref": "#/components/schemas/Error" | ||
| 357 | + } | ||
| 358 | + } | ||
| 359 | + } | ||
| 360 | + }, | ||
| 361 | + "default": { | ||
| 362 | + "description": "unexpected error", | ||
| 363 | + "content": { | ||
| 364 | + "application/json": { | ||
| 365 | + "schema": { | ||
| 366 | + "$ref": "#/components/schemas/Error" | ||
| 367 | + } | ||
| 368 | + } | ||
| 369 | + } | ||
| 370 | + } | ||
| 371 | + }, | ||
| 372 | + "summary": "", | ||
| 373 | + "tags": [ | ||
| 374 | + "Upload - File" | ||
| 375 | + ], | ||
| 376 | + "parameters": [ | ||
| 377 | + { | ||
| 378 | + "name": "id", | ||
| 379 | + "in": "path", | ||
| 380 | + "description": "", | ||
| 381 | + "deprecated": false, | ||
| 382 | + "required": true, | ||
| 383 | + "schema": { | ||
| 384 | + "type": "string" | ||
| 385 | + } | ||
| 386 | + } | ||
| 387 | + ] | ||
| 388 | + } | ||
| 389 | + } | ||
| 390 | + }, | ||
| 391 | + "tags": [ | ||
| 392 | + { | ||
| 393 | + "name": "Upload - File" | ||
| 394 | + } | ||
| 395 | + ] | ||
| 396 | +} | ||
| 0 | \ No newline at end of file | 397 | \ No newline at end of file |
back-end/h5-api/extensions/users-permissions/documentation/1.0.0/users-permissions-Role.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/users-permissions/init": { | ||
| 4 | + "get": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "Check if the first admin user has already been registered", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "properties": { | ||
| 14 | + "foo": { | ||
| 15 | + "type": "string" | ||
| 16 | + } | ||
| 17 | + } | ||
| 18 | + } | ||
| 19 | + } | ||
| 20 | + } | ||
| 21 | + }, | ||
| 22 | + "403": { | ||
| 23 | + "description": "Forbidden", | ||
| 24 | + "content": { | ||
| 25 | + "application/json": { | ||
| 26 | + "schema": { | ||
| 27 | + "$ref": "#/components/schemas/Error" | ||
| 28 | + } | ||
| 29 | + } | ||
| 30 | + } | ||
| 31 | + }, | ||
| 32 | + "404": { | ||
| 33 | + "description": "Not found", | ||
| 34 | + "content": { | ||
| 35 | + "application/json": { | ||
| 36 | + "schema": { | ||
| 37 | + "$ref": "#/components/schemas/Error" | ||
| 38 | + } | ||
| 39 | + } | ||
| 40 | + } | ||
| 41 | + }, | ||
| 42 | + "default": { | ||
| 43 | + "description": "unexpected error", | ||
| 44 | + "content": { | ||
| 45 | + "application/json": { | ||
| 46 | + "schema": { | ||
| 47 | + "$ref": "#/components/schemas/Error" | ||
| 48 | + } | ||
| 49 | + } | ||
| 50 | + } | ||
| 51 | + } | ||
| 52 | + }, | ||
| 53 | + "summary": "", | ||
| 54 | + "tags": [ | ||
| 55 | + "Users-Permissions - Role" | ||
| 56 | + ], | ||
| 57 | + "parameters": [] | ||
| 58 | + } | ||
| 59 | + }, | ||
| 60 | + "/users-permissions/roles/{id}": { | ||
| 61 | + "get": { | ||
| 62 | + "deprecated": false, | ||
| 63 | + "description": "Retrieve a role depending on its id", | ||
| 64 | + "responses": { | ||
| 65 | + "200": { | ||
| 66 | + "description": "response", | ||
| 67 | + "content": { | ||
| 68 | + "application/json": { | ||
| 69 | + "schema": { | ||
| 70 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 71 | + } | ||
| 72 | + } | ||
| 73 | + } | ||
| 74 | + }, | ||
| 75 | + "403": { | ||
| 76 | + "description": "Forbidden", | ||
| 77 | + "content": { | ||
| 78 | + "application/json": { | ||
| 79 | + "schema": { | ||
| 80 | + "$ref": "#/components/schemas/Error" | ||
| 81 | + } | ||
| 82 | + } | ||
| 83 | + } | ||
| 84 | + }, | ||
| 85 | + "404": { | ||
| 86 | + "description": "Not found", | ||
| 87 | + "content": { | ||
| 88 | + "application/json": { | ||
| 89 | + "schema": { | ||
| 90 | + "$ref": "#/components/schemas/Error" | ||
| 91 | + } | ||
| 92 | + } | ||
| 93 | + } | ||
| 94 | + }, | ||
| 95 | + "default": { | ||
| 96 | + "description": "unexpected error", | ||
| 97 | + "content": { | ||
| 98 | + "application/json": { | ||
| 99 | + "schema": { | ||
| 100 | + "$ref": "#/components/schemas/Error" | ||
| 101 | + } | ||
| 102 | + } | ||
| 103 | + } | ||
| 104 | + } | ||
| 105 | + }, | ||
| 106 | + "summary": "", | ||
| 107 | + "tags": [ | ||
| 108 | + "Users-Permissions - Role" | ||
| 109 | + ], | ||
| 110 | + "parameters": [ | ||
| 111 | + { | ||
| 112 | + "name": "id", | ||
| 113 | + "in": "path", | ||
| 114 | + "description": "", | ||
| 115 | + "deprecated": false, | ||
| 116 | + "required": true, | ||
| 117 | + "schema": { | ||
| 118 | + "type": "string" | ||
| 119 | + } | ||
| 120 | + } | ||
| 121 | + ] | ||
| 122 | + } | ||
| 123 | + }, | ||
| 124 | + "/users-permissions/roles": { | ||
| 125 | + "get": { | ||
| 126 | + "deprecated": false, | ||
| 127 | + "description": "Retrieve all role documents", | ||
| 128 | + "responses": { | ||
| 129 | + "200": { | ||
| 130 | + "description": "response", | ||
| 131 | + "content": { | ||
| 132 | + "application/json": { | ||
| 133 | + "schema": { | ||
| 134 | + "type": "array", | ||
| 135 | + "items": { | ||
| 136 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 137 | + } | ||
| 138 | + } | ||
| 139 | + } | ||
| 140 | + } | ||
| 141 | + }, | ||
| 142 | + "403": { | ||
| 143 | + "description": "Forbidden", | ||
| 144 | + "content": { | ||
| 145 | + "application/json": { | ||
| 146 | + "schema": { | ||
| 147 | + "$ref": "#/components/schemas/Error" | ||
| 148 | + } | ||
| 149 | + } | ||
| 150 | + } | ||
| 151 | + }, | ||
| 152 | + "404": { | ||
| 153 | + "description": "Not found", | ||
| 154 | + "content": { | ||
| 155 | + "application/json": { | ||
| 156 | + "schema": { | ||
| 157 | + "$ref": "#/components/schemas/Error" | ||
| 158 | + } | ||
| 159 | + } | ||
| 160 | + } | ||
| 161 | + }, | ||
| 162 | + "default": { | ||
| 163 | + "description": "unexpected error", | ||
| 164 | + "content": { | ||
| 165 | + "application/json": { | ||
| 166 | + "schema": { | ||
| 167 | + "$ref": "#/components/schemas/Error" | ||
| 168 | + } | ||
| 169 | + } | ||
| 170 | + } | ||
| 171 | + } | ||
| 172 | + }, | ||
| 173 | + "summary": "", | ||
| 174 | + "tags": [ | ||
| 175 | + "Users-Permissions - Role" | ||
| 176 | + ], | ||
| 177 | + "parameters": [ | ||
| 178 | + { | ||
| 179 | + "name": "_limit", | ||
| 180 | + "in": "query", | ||
| 181 | + "required": false, | ||
| 182 | + "description": "Maximum number of results possible", | ||
| 183 | + "schema": { | ||
| 184 | + "type": "integer" | ||
| 185 | + }, | ||
| 186 | + "deprecated": false | ||
| 187 | + }, | ||
| 188 | + { | ||
| 189 | + "name": "_sort", | ||
| 190 | + "in": "query", | ||
| 191 | + "required": false, | ||
| 192 | + "description": "Sort according to a specific field.", | ||
| 193 | + "schema": { | ||
| 194 | + "type": "string" | ||
| 195 | + }, | ||
| 196 | + "deprecated": false | ||
| 197 | + }, | ||
| 198 | + { | ||
| 199 | + "name": "_start", | ||
| 200 | + "in": "query", | ||
| 201 | + "required": false, | ||
| 202 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 203 | + "schema": { | ||
| 204 | + "type": "integer" | ||
| 205 | + }, | ||
| 206 | + "deprecated": false | ||
| 207 | + }, | ||
| 208 | + { | ||
| 209 | + "name": "=", | ||
| 210 | + "in": "query", | ||
| 211 | + "required": false, | ||
| 212 | + "description": "Get entries that matches exactly your input", | ||
| 213 | + "schema": { | ||
| 214 | + "type": "string" | ||
| 215 | + }, | ||
| 216 | + "deprecated": false | ||
| 217 | + }, | ||
| 218 | + { | ||
| 219 | + "name": "_ne", | ||
| 220 | + "in": "query", | ||
| 221 | + "required": false, | ||
| 222 | + "description": "Get records that are not equals to something", | ||
| 223 | + "schema": { | ||
| 224 | + "type": "string" | ||
| 225 | + }, | ||
| 226 | + "deprecated": false | ||
| 227 | + }, | ||
| 228 | + { | ||
| 229 | + "name": "_lt", | ||
| 230 | + "in": "query", | ||
| 231 | + "required": false, | ||
| 232 | + "description": "Get record that are lower than a value", | ||
| 233 | + "schema": { | ||
| 234 | + "type": "string" | ||
| 235 | + }, | ||
| 236 | + "deprecated": false | ||
| 237 | + }, | ||
| 238 | + { | ||
| 239 | + "name": "_lte", | ||
| 240 | + "in": "query", | ||
| 241 | + "required": false, | ||
| 242 | + "description": "Get records that are lower than or equal to a value", | ||
| 243 | + "schema": { | ||
| 244 | + "type": "string" | ||
| 245 | + }, | ||
| 246 | + "deprecated": false | ||
| 247 | + }, | ||
| 248 | + { | ||
| 249 | + "name": "_gt", | ||
| 250 | + "in": "query", | ||
| 251 | + "required": false, | ||
| 252 | + "description": "Get records that are greater than a value", | ||
| 253 | + "schema": { | ||
| 254 | + "type": "string" | ||
| 255 | + }, | ||
| 256 | + "deprecated": false | ||
| 257 | + }, | ||
| 258 | + { | ||
| 259 | + "name": "_gte", | ||
| 260 | + "in": "query", | ||
| 261 | + "required": false, | ||
| 262 | + "description": "Get records that are greater than or equal a value", | ||
| 263 | + "schema": { | ||
| 264 | + "type": "string" | ||
| 265 | + }, | ||
| 266 | + "deprecated": false | ||
| 267 | + }, | ||
| 268 | + { | ||
| 269 | + "name": "_contains", | ||
| 270 | + "in": "query", | ||
| 271 | + "required": false, | ||
| 272 | + "description": "Get records that contains a value", | ||
| 273 | + "schema": { | ||
| 274 | + "type": "string" | ||
| 275 | + }, | ||
| 276 | + "deprecated": false | ||
| 277 | + }, | ||
| 278 | + { | ||
| 279 | + "name": "_containss", | ||
| 280 | + "in": "query", | ||
| 281 | + "required": false, | ||
| 282 | + "description": "Get records that contains (case sensitive) a value", | ||
| 283 | + "schema": { | ||
| 284 | + "type": "string" | ||
| 285 | + }, | ||
| 286 | + "deprecated": false | ||
| 287 | + }, | ||
| 288 | + { | ||
| 289 | + "name": "_in", | ||
| 290 | + "in": "query", | ||
| 291 | + "required": false, | ||
| 292 | + "description": "Get records that matches any value in the array of values", | ||
| 293 | + "schema": { | ||
| 294 | + "type": "array" | ||
| 295 | + }, | ||
| 296 | + "deprecated": false | ||
| 297 | + }, | ||
| 298 | + { | ||
| 299 | + "name": "_nin", | ||
| 300 | + "in": "query", | ||
| 301 | + "required": false, | ||
| 302 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 303 | + "schema": { | ||
| 304 | + "type": "array" | ||
| 305 | + }, | ||
| 306 | + "deprecated": false | ||
| 307 | + } | ||
| 308 | + ] | ||
| 309 | + }, | ||
| 310 | + "post": { | ||
| 311 | + "deprecated": false, | ||
| 312 | + "description": "Create a new role", | ||
| 313 | + "responses": { | ||
| 314 | + "200": { | ||
| 315 | + "description": "response", | ||
| 316 | + "content": { | ||
| 317 | + "application/json": { | ||
| 318 | + "schema": { | ||
| 319 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 320 | + } | ||
| 321 | + } | ||
| 322 | + } | ||
| 323 | + }, | ||
| 324 | + "403": { | ||
| 325 | + "description": "Forbidden", | ||
| 326 | + "content": { | ||
| 327 | + "application/json": { | ||
| 328 | + "schema": { | ||
| 329 | + "$ref": "#/components/schemas/Error" | ||
| 330 | + } | ||
| 331 | + } | ||
| 332 | + } | ||
| 333 | + }, | ||
| 334 | + "404": { | ||
| 335 | + "description": "Not found", | ||
| 336 | + "content": { | ||
| 337 | + "application/json": { | ||
| 338 | + "schema": { | ||
| 339 | + "$ref": "#/components/schemas/Error" | ||
| 340 | + } | ||
| 341 | + } | ||
| 342 | + } | ||
| 343 | + }, | ||
| 344 | + "default": { | ||
| 345 | + "description": "unexpected error", | ||
| 346 | + "content": { | ||
| 347 | + "application/json": { | ||
| 348 | + "schema": { | ||
| 349 | + "$ref": "#/components/schemas/Error" | ||
| 350 | + } | ||
| 351 | + } | ||
| 352 | + } | ||
| 353 | + } | ||
| 354 | + }, | ||
| 355 | + "summary": "", | ||
| 356 | + "tags": [ | ||
| 357 | + "Users-Permissions - Role" | ||
| 358 | + ], | ||
| 359 | + "requestBody": { | ||
| 360 | + "description": "", | ||
| 361 | + "required": true, | ||
| 362 | + "content": { | ||
| 363 | + "application/json": { | ||
| 364 | + "schema": { | ||
| 365 | + "$ref": "#/components/schemas/NewUsers-PermissionsRole" | ||
| 366 | + } | ||
| 367 | + } | ||
| 368 | + } | ||
| 369 | + } | ||
| 370 | + } | ||
| 371 | + }, | ||
| 372 | + "/users-permissions/roles/{role}": { | ||
| 373 | + "put": { | ||
| 374 | + "deprecated": false, | ||
| 375 | + "description": "Update a role", | ||
| 376 | + "responses": { | ||
| 377 | + "200": { | ||
| 378 | + "description": "response", | ||
| 379 | + "content": { | ||
| 380 | + "application/json": { | ||
| 381 | + "schema": { | ||
| 382 | + "$ref": "#/components/schemas/Users-PermissionsRole" | ||
| 383 | + } | ||
| 384 | + } | ||
| 385 | + } | ||
| 386 | + }, | ||
| 387 | + "403": { | ||
| 388 | + "description": "Forbidden", | ||
| 389 | + "content": { | ||
| 390 | + "application/json": { | ||
| 391 | + "schema": { | ||
| 392 | + "$ref": "#/components/schemas/Error" | ||
| 393 | + } | ||
| 394 | + } | ||
| 395 | + } | ||
| 396 | + }, | ||
| 397 | + "404": { | ||
| 398 | + "description": "Not found", | ||
| 399 | + "content": { | ||
| 400 | + "application/json": { | ||
| 401 | + "schema": { | ||
| 402 | + "$ref": "#/components/schemas/Error" | ||
| 403 | + } | ||
| 404 | + } | ||
| 405 | + } | ||
| 406 | + }, | ||
| 407 | + "default": { | ||
| 408 | + "description": "unexpected error", | ||
| 409 | + "content": { | ||
| 410 | + "application/json": { | ||
| 411 | + "schema": { | ||
| 412 | + "$ref": "#/components/schemas/Error" | ||
| 413 | + } | ||
| 414 | + } | ||
| 415 | + } | ||
| 416 | + } | ||
| 417 | + }, | ||
| 418 | + "summary": "", | ||
| 419 | + "tags": [ | ||
| 420 | + "Users-Permissions - Role" | ||
| 421 | + ], | ||
| 422 | + "parameters": [ | ||
| 423 | + { | ||
| 424 | + "name": "role", | ||
| 425 | + "in": "path", | ||
| 426 | + "description": "", | ||
| 427 | + "deprecated": false, | ||
| 428 | + "required": true, | ||
| 429 | + "schema": { | ||
| 430 | + "type": "string" | ||
| 431 | + } | ||
| 432 | + } | ||
| 433 | + ], | ||
| 434 | + "requestBody": { | ||
| 435 | + "description": "", | ||
| 436 | + "required": true, | ||
| 437 | + "content": { | ||
| 438 | + "application/json": { | ||
| 439 | + "schema": { | ||
| 440 | + "$ref": "#/components/schemas/NewUsers-PermissionsRole" | ||
| 441 | + } | ||
| 442 | + } | ||
| 443 | + } | ||
| 444 | + } | ||
| 445 | + }, | ||
| 446 | + "delete": { | ||
| 447 | + "deprecated": false, | ||
| 448 | + "description": "Delete a role", | ||
| 449 | + "responses": { | ||
| 450 | + "200": { | ||
| 451 | + "description": "response", | ||
| 452 | + "content": { | ||
| 453 | + "application/json": { | ||
| 454 | + "schema": { | ||
| 455 | + "properties": { | ||
| 456 | + "foo": { | ||
| 457 | + "type": "string" | ||
| 458 | + } | ||
| 459 | + } | ||
| 460 | + } | ||
| 461 | + } | ||
| 462 | + } | ||
| 463 | + }, | ||
| 464 | + "403": { | ||
| 465 | + "description": "Forbidden", | ||
| 466 | + "content": { | ||
| 467 | + "application/json": { | ||
| 468 | + "schema": { | ||
| 469 | + "$ref": "#/components/schemas/Error" | ||
| 470 | + } | ||
| 471 | + } | ||
| 472 | + } | ||
| 473 | + }, | ||
| 474 | + "404": { | ||
| 475 | + "description": "Not found", | ||
| 476 | + "content": { | ||
| 477 | + "application/json": { | ||
| 478 | + "schema": { | ||
| 479 | + "$ref": "#/components/schemas/Error" | ||
| 480 | + } | ||
| 481 | + } | ||
| 482 | + } | ||
| 483 | + }, | ||
| 484 | + "default": { | ||
| 485 | + "description": "unexpected error", | ||
| 486 | + "content": { | ||
| 487 | + "application/json": { | ||
| 488 | + "schema": { | ||
| 489 | + "$ref": "#/components/schemas/Error" | ||
| 490 | + } | ||
| 491 | + } | ||
| 492 | + } | ||
| 493 | + } | ||
| 494 | + }, | ||
| 495 | + "summary": "", | ||
| 496 | + "tags": [ | ||
| 497 | + "Users-Permissions - Role" | ||
| 498 | + ], | ||
| 499 | + "parameters": [ | ||
| 500 | + { | ||
| 501 | + "name": "role", | ||
| 502 | + "in": "path", | ||
| 503 | + "description": "", | ||
| 504 | + "deprecated": false, | ||
| 505 | + "required": true, | ||
| 506 | + "schema": { | ||
| 507 | + "type": "string" | ||
| 508 | + } | ||
| 509 | + } | ||
| 510 | + ] | ||
| 511 | + } | ||
| 512 | + } | ||
| 513 | + }, | ||
| 514 | + "components": { | ||
| 515 | + "schemas": { | ||
| 516 | + "Users-PermissionsRole": { | ||
| 517 | + "required": [ | ||
| 518 | + "id", | ||
| 519 | + "name" | ||
| 520 | + ], | ||
| 521 | + "properties": { | ||
| 522 | + "id": { | ||
| 523 | + "type": "string" | ||
| 524 | + }, | ||
| 525 | + "name": { | ||
| 526 | + "type": "string", | ||
| 527 | + "minLength": 3 | ||
| 528 | + }, | ||
| 529 | + "description": { | ||
| 530 | + "type": "string" | ||
| 531 | + }, | ||
| 532 | + "type": { | ||
| 533 | + "type": "string" | ||
| 534 | + }, | ||
| 535 | + "permissions": { | ||
| 536 | + "type": "array", | ||
| 537 | + "items": { | ||
| 538 | + "required": [ | ||
| 539 | + "id", | ||
| 540 | + "type", | ||
| 541 | + "controller", | ||
| 542 | + "action", | ||
| 543 | + "enabled" | ||
| 544 | + ], | ||
| 545 | + "properties": { | ||
| 546 | + "id": { | ||
| 547 | + "type": "string" | ||
| 548 | + }, | ||
| 549 | + "type": { | ||
| 550 | + "type": "string" | ||
| 551 | + }, | ||
| 552 | + "controller": { | ||
| 553 | + "type": "string" | ||
| 554 | + }, | ||
| 555 | + "action": { | ||
| 556 | + "type": "string" | ||
| 557 | + }, | ||
| 558 | + "enabled": { | ||
| 559 | + "type": "boolean" | ||
| 560 | + }, | ||
| 561 | + "policy": { | ||
| 562 | + "type": "string" | ||
| 563 | + }, | ||
| 564 | + "role": { | ||
| 565 | + "type": "string" | ||
| 566 | + } | ||
| 567 | + } | ||
| 568 | + } | ||
| 569 | + }, | ||
| 570 | + "users": { | ||
| 571 | + "type": "array", | ||
| 572 | + "items": { | ||
| 573 | + "required": [ | ||
| 574 | + "id", | ||
| 575 | + "username", | ||
| 576 | + "email" | ||
| 577 | + ], | ||
| 578 | + "properties": { | ||
| 579 | + "id": { | ||
| 580 | + "type": "string" | ||
| 581 | + }, | ||
| 582 | + "username": { | ||
| 583 | + "type": "string" | ||
| 584 | + }, | ||
| 585 | + "email": { | ||
| 586 | + "type": "string" | ||
| 587 | + }, | ||
| 588 | + "provider": { | ||
| 589 | + "type": "string" | ||
| 590 | + }, | ||
| 591 | + "password": { | ||
| 592 | + "type": "string" | ||
| 593 | + }, | ||
| 594 | + "resetPasswordToken": { | ||
| 595 | + "type": "string" | ||
| 596 | + }, | ||
| 597 | + "confirmed": { | ||
| 598 | + "type": "boolean" | ||
| 599 | + }, | ||
| 600 | + "blocked": { | ||
| 601 | + "type": "boolean" | ||
| 602 | + }, | ||
| 603 | + "role": { | ||
| 604 | + "type": "string" | ||
| 605 | + } | ||
| 606 | + } | ||
| 607 | + } | ||
| 608 | + } | ||
| 609 | + } | ||
| 610 | + }, | ||
| 611 | + "NewUsers-PermissionsRole": { | ||
| 612 | + "required": [ | ||
| 613 | + "name" | ||
| 614 | + ], | ||
| 615 | + "properties": { | ||
| 616 | + "name": { | ||
| 617 | + "type": "string", | ||
| 618 | + "minLength": 3 | ||
| 619 | + }, | ||
| 620 | + "description": { | ||
| 621 | + "type": "string" | ||
| 622 | + }, | ||
| 623 | + "type": { | ||
| 624 | + "type": "string" | ||
| 625 | + }, | ||
| 626 | + "permissions": { | ||
| 627 | + "type": "array", | ||
| 628 | + "items": { | ||
| 629 | + "type": "string" | ||
| 630 | + } | ||
| 631 | + }, | ||
| 632 | + "users": { | ||
| 633 | + "type": "array", | ||
| 634 | + "items": { | ||
| 635 | + "type": "string" | ||
| 636 | + } | ||
| 637 | + } | ||
| 638 | + } | ||
| 639 | + } | ||
| 640 | + } | ||
| 641 | + }, | ||
| 642 | + "tags": [ | ||
| 643 | + { | ||
| 644 | + "name": "Users-Permissions - Role" | ||
| 645 | + } | ||
| 646 | + ] | ||
| 647 | +} | ||
| 0 | \ No newline at end of file | 648 | \ No newline at end of file |
back-end/h5-api/extensions/users-permissions/documentation/1.0.0/users-permissions-User.json
0 → 100644
| 1 | +{ | ||
| 2 | + "paths": { | ||
| 3 | + "/users-permissions/search/{id}": { | ||
| 4 | + "get": { | ||
| 5 | + "deprecated": false, | ||
| 6 | + "description": "Search for users", | ||
| 7 | + "responses": { | ||
| 8 | + "200": { | ||
| 9 | + "description": "response", | ||
| 10 | + "content": { | ||
| 11 | + "application/json": { | ||
| 12 | + "schema": { | ||
| 13 | + "type": "array", | ||
| 14 | + "items": { | ||
| 15 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 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 | + "Users-Permissions - User" | ||
| 55 | + ], | ||
| 56 | + "parameters": [ | ||
| 57 | + { | ||
| 58 | + "name": "id", | ||
| 59 | + "in": "path", | ||
| 60 | + "description": "", | ||
| 61 | + "deprecated": false, | ||
| 62 | + "required": true, | ||
| 63 | + "schema": { | ||
| 64 | + "type": "string" | ||
| 65 | + } | ||
| 66 | + }, | ||
| 67 | + { | ||
| 68 | + "name": "_limit", | ||
| 69 | + "in": "query", | ||
| 70 | + "required": false, | ||
| 71 | + "description": "Maximum number of results possible", | ||
| 72 | + "schema": { | ||
| 73 | + "type": "integer" | ||
| 74 | + }, | ||
| 75 | + "deprecated": false | ||
| 76 | + }, | ||
| 77 | + { | ||
| 78 | + "name": "_sort", | ||
| 79 | + "in": "query", | ||
| 80 | + "required": false, | ||
| 81 | + "description": "Sort according to a specific field.", | ||
| 82 | + "schema": { | ||
| 83 | + "type": "string" | ||
| 84 | + }, | ||
| 85 | + "deprecated": false | ||
| 86 | + }, | ||
| 87 | + { | ||
| 88 | + "name": "_start", | ||
| 89 | + "in": "query", | ||
| 90 | + "required": false, | ||
| 91 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 92 | + "schema": { | ||
| 93 | + "type": "integer" | ||
| 94 | + }, | ||
| 95 | + "deprecated": false | ||
| 96 | + }, | ||
| 97 | + { | ||
| 98 | + "name": "=", | ||
| 99 | + "in": "query", | ||
| 100 | + "required": false, | ||
| 101 | + "description": "Get entries that matches exactly your input", | ||
| 102 | + "schema": { | ||
| 103 | + "type": "string" | ||
| 104 | + }, | ||
| 105 | + "deprecated": false | ||
| 106 | + }, | ||
| 107 | + { | ||
| 108 | + "name": "_ne", | ||
| 109 | + "in": "query", | ||
| 110 | + "required": false, | ||
| 111 | + "description": "Get records that are not equals to something", | ||
| 112 | + "schema": { | ||
| 113 | + "type": "string" | ||
| 114 | + }, | ||
| 115 | + "deprecated": false | ||
| 116 | + }, | ||
| 117 | + { | ||
| 118 | + "name": "_lt", | ||
| 119 | + "in": "query", | ||
| 120 | + "required": false, | ||
| 121 | + "description": "Get record that are lower than a value", | ||
| 122 | + "schema": { | ||
| 123 | + "type": "string" | ||
| 124 | + }, | ||
| 125 | + "deprecated": false | ||
| 126 | + }, | ||
| 127 | + { | ||
| 128 | + "name": "_lte", | ||
| 129 | + "in": "query", | ||
| 130 | + "required": false, | ||
| 131 | + "description": "Get records that are lower than or equal to a value", | ||
| 132 | + "schema": { | ||
| 133 | + "type": "string" | ||
| 134 | + }, | ||
| 135 | + "deprecated": false | ||
| 136 | + }, | ||
| 137 | + { | ||
| 138 | + "name": "_gt", | ||
| 139 | + "in": "query", | ||
| 140 | + "required": false, | ||
| 141 | + "description": "Get records that are greater than a value", | ||
| 142 | + "schema": { | ||
| 143 | + "type": "string" | ||
| 144 | + }, | ||
| 145 | + "deprecated": false | ||
| 146 | + }, | ||
| 147 | + { | ||
| 148 | + "name": "_gte", | ||
| 149 | + "in": "query", | ||
| 150 | + "required": false, | ||
| 151 | + "description": "Get records that are greater than or equal a value", | ||
| 152 | + "schema": { | ||
| 153 | + "type": "string" | ||
| 154 | + }, | ||
| 155 | + "deprecated": false | ||
| 156 | + }, | ||
| 157 | + { | ||
| 158 | + "name": "_contains", | ||
| 159 | + "in": "query", | ||
| 160 | + "required": false, | ||
| 161 | + "description": "Get records that contains a value", | ||
| 162 | + "schema": { | ||
| 163 | + "type": "string" | ||
| 164 | + }, | ||
| 165 | + "deprecated": false | ||
| 166 | + }, | ||
| 167 | + { | ||
| 168 | + "name": "_containss", | ||
| 169 | + "in": "query", | ||
| 170 | + "required": false, | ||
| 171 | + "description": "Get records that contains (case sensitive) a value", | ||
| 172 | + "schema": { | ||
| 173 | + "type": "string" | ||
| 174 | + }, | ||
| 175 | + "deprecated": false | ||
| 176 | + }, | ||
| 177 | + { | ||
| 178 | + "name": "_in", | ||
| 179 | + "in": "query", | ||
| 180 | + "required": false, | ||
| 181 | + "description": "Get records that matches any value in the array of values", | ||
| 182 | + "schema": { | ||
| 183 | + "type": "array" | ||
| 184 | + }, | ||
| 185 | + "deprecated": false | ||
| 186 | + }, | ||
| 187 | + { | ||
| 188 | + "name": "_nin", | ||
| 189 | + "in": "query", | ||
| 190 | + "required": false, | ||
| 191 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 192 | + "schema": { | ||
| 193 | + "type": "array" | ||
| 194 | + }, | ||
| 195 | + "deprecated": false | ||
| 196 | + } | ||
| 197 | + ] | ||
| 198 | + } | ||
| 199 | + }, | ||
| 200 | + "/connect/*": { | ||
| 201 | + "get": { | ||
| 202 | + "deprecated": false, | ||
| 203 | + "description": "Connect a provider", | ||
| 204 | + "responses": { | ||
| 205 | + "200": { | ||
| 206 | + "description": "response", | ||
| 207 | + "content": { | ||
| 208 | + "application/json": { | ||
| 209 | + "schema": { | ||
| 210 | + "properties": { | ||
| 211 | + "foo": { | ||
| 212 | + "type": "string" | ||
| 213 | + } | ||
| 214 | + } | ||
| 215 | + } | ||
| 216 | + } | ||
| 217 | + } | ||
| 218 | + }, | ||
| 219 | + "403": { | ||
| 220 | + "description": "Forbidden", | ||
| 221 | + "content": { | ||
| 222 | + "application/json": { | ||
| 223 | + "schema": { | ||
| 224 | + "$ref": "#/components/schemas/Error" | ||
| 225 | + } | ||
| 226 | + } | ||
| 227 | + } | ||
| 228 | + }, | ||
| 229 | + "404": { | ||
| 230 | + "description": "Not found", | ||
| 231 | + "content": { | ||
| 232 | + "application/json": { | ||
| 233 | + "schema": { | ||
| 234 | + "$ref": "#/components/schemas/Error" | ||
| 235 | + } | ||
| 236 | + } | ||
| 237 | + } | ||
| 238 | + }, | ||
| 239 | + "default": { | ||
| 240 | + "description": "unexpected error", | ||
| 241 | + "content": { | ||
| 242 | + "application/json": { | ||
| 243 | + "schema": { | ||
| 244 | + "$ref": "#/components/schemas/Error" | ||
| 245 | + } | ||
| 246 | + } | ||
| 247 | + } | ||
| 248 | + } | ||
| 249 | + }, | ||
| 250 | + "summary": "", | ||
| 251 | + "tags": [ | ||
| 252 | + "Users-Permissions - User" | ||
| 253 | + ], | ||
| 254 | + "parameters": [] | ||
| 255 | + } | ||
| 256 | + }, | ||
| 257 | + "/auth/local": { | ||
| 258 | + "post": { | ||
| 259 | + "deprecated": false, | ||
| 260 | + "description": "Login a user using the identifiers email and password", | ||
| 261 | + "responses": { | ||
| 262 | + "200": { | ||
| 263 | + "description": "response", | ||
| 264 | + "content": { | ||
| 265 | + "application/json": { | ||
| 266 | + "schema": { | ||
| 267 | + "properties": { | ||
| 268 | + "foo": { | ||
| 269 | + "type": "string" | ||
| 270 | + } | ||
| 271 | + } | ||
| 272 | + } | ||
| 273 | + } | ||
| 274 | + } | ||
| 275 | + }, | ||
| 276 | + "403": { | ||
| 277 | + "description": "Forbidden", | ||
| 278 | + "content": { | ||
| 279 | + "application/json": { | ||
| 280 | + "schema": { | ||
| 281 | + "$ref": "#/components/schemas/Error" | ||
| 282 | + } | ||
| 283 | + } | ||
| 284 | + } | ||
| 285 | + }, | ||
| 286 | + "404": { | ||
| 287 | + "description": "Not found", | ||
| 288 | + "content": { | ||
| 289 | + "application/json": { | ||
| 290 | + "schema": { | ||
| 291 | + "$ref": "#/components/schemas/Error" | ||
| 292 | + } | ||
| 293 | + } | ||
| 294 | + } | ||
| 295 | + }, | ||
| 296 | + "default": { | ||
| 297 | + "description": "unexpected error", | ||
| 298 | + "content": { | ||
| 299 | + "application/json": { | ||
| 300 | + "schema": { | ||
| 301 | + "$ref": "#/components/schemas/Error" | ||
| 302 | + } | ||
| 303 | + } | ||
| 304 | + } | ||
| 305 | + } | ||
| 306 | + }, | ||
| 307 | + "summary": "", | ||
| 308 | + "tags": [ | ||
| 309 | + "Users-Permissions - User" | ||
| 310 | + ], | ||
| 311 | + "requestBody": { | ||
| 312 | + "description": "", | ||
| 313 | + "required": true, | ||
| 314 | + "content": { | ||
| 315 | + "application/json": { | ||
| 316 | + "schema": { | ||
| 317 | + "properties": { | ||
| 318 | + "foo": { | ||
| 319 | + "type": "string" | ||
| 320 | + } | ||
| 321 | + } | ||
| 322 | + } | ||
| 323 | + } | ||
| 324 | + } | ||
| 325 | + } | ||
| 326 | + } | ||
| 327 | + }, | ||
| 328 | + "/auth/local/register": { | ||
| 329 | + "post": { | ||
| 330 | + "deprecated": false, | ||
| 331 | + "description": "Register a new user with the default role", | ||
| 332 | + "responses": { | ||
| 333 | + "200": { | ||
| 334 | + "description": "response", | ||
| 335 | + "content": { | ||
| 336 | + "application/json": { | ||
| 337 | + "schema": { | ||
| 338 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 339 | + } | ||
| 340 | + } | ||
| 341 | + } | ||
| 342 | + }, | ||
| 343 | + "403": { | ||
| 344 | + "description": "Forbidden", | ||
| 345 | + "content": { | ||
| 346 | + "application/json": { | ||
| 347 | + "schema": { | ||
| 348 | + "$ref": "#/components/schemas/Error" | ||
| 349 | + } | ||
| 350 | + } | ||
| 351 | + } | ||
| 352 | + }, | ||
| 353 | + "404": { | ||
| 354 | + "description": "Not found", | ||
| 355 | + "content": { | ||
| 356 | + "application/json": { | ||
| 357 | + "schema": { | ||
| 358 | + "$ref": "#/components/schemas/Error" | ||
| 359 | + } | ||
| 360 | + } | ||
| 361 | + } | ||
| 362 | + }, | ||
| 363 | + "default": { | ||
| 364 | + "description": "unexpected error", | ||
| 365 | + "content": { | ||
| 366 | + "application/json": { | ||
| 367 | + "schema": { | ||
| 368 | + "$ref": "#/components/schemas/Error" | ||
| 369 | + } | ||
| 370 | + } | ||
| 371 | + } | ||
| 372 | + } | ||
| 373 | + }, | ||
| 374 | + "summary": "", | ||
| 375 | + "tags": [ | ||
| 376 | + "Users-Permissions - User" | ||
| 377 | + ], | ||
| 378 | + "requestBody": { | ||
| 379 | + "description": "", | ||
| 380 | + "required": true, | ||
| 381 | + "content": { | ||
| 382 | + "application/json": { | ||
| 383 | + "schema": { | ||
| 384 | + "$ref": "#/components/schemas/NewUsers-PermissionsUser" | ||
| 385 | + } | ||
| 386 | + } | ||
| 387 | + } | ||
| 388 | + } | ||
| 389 | + } | ||
| 390 | + }, | ||
| 391 | + "/auth/{provider}/callback": { | ||
| 392 | + "get": { | ||
| 393 | + "deprecated": false, | ||
| 394 | + "description": "Successfull redirection after approving a provider", | ||
| 395 | + "responses": { | ||
| 396 | + "200": { | ||
| 397 | + "description": "response", | ||
| 398 | + "content": { | ||
| 399 | + "application/json": { | ||
| 400 | + "schema": { | ||
| 401 | + "properties": { | ||
| 402 | + "foo": { | ||
| 403 | + "type": "string" | ||
| 404 | + } | ||
| 405 | + } | ||
| 406 | + } | ||
| 407 | + } | ||
| 408 | + } | ||
| 409 | + }, | ||
| 410 | + "403": { | ||
| 411 | + "description": "Forbidden", | ||
| 412 | + "content": { | ||
| 413 | + "application/json": { | ||
| 414 | + "schema": { | ||
| 415 | + "$ref": "#/components/schemas/Error" | ||
| 416 | + } | ||
| 417 | + } | ||
| 418 | + } | ||
| 419 | + }, | ||
| 420 | + "404": { | ||
| 421 | + "description": "Not found", | ||
| 422 | + "content": { | ||
| 423 | + "application/json": { | ||
| 424 | + "schema": { | ||
| 425 | + "$ref": "#/components/schemas/Error" | ||
| 426 | + } | ||
| 427 | + } | ||
| 428 | + } | ||
| 429 | + }, | ||
| 430 | + "default": { | ||
| 431 | + "description": "unexpected error", | ||
| 432 | + "content": { | ||
| 433 | + "application/json": { | ||
| 434 | + "schema": { | ||
| 435 | + "$ref": "#/components/schemas/Error" | ||
| 436 | + } | ||
| 437 | + } | ||
| 438 | + } | ||
| 439 | + } | ||
| 440 | + }, | ||
| 441 | + "summary": "", | ||
| 442 | + "tags": [ | ||
| 443 | + "Users-Permissions - User" | ||
| 444 | + ], | ||
| 445 | + "parameters": [ | ||
| 446 | + { | ||
| 447 | + "name": "provider", | ||
| 448 | + "in": "path", | ||
| 449 | + "description": "", | ||
| 450 | + "deprecated": false, | ||
| 451 | + "required": true, | ||
| 452 | + "schema": { | ||
| 453 | + "type": "string" | ||
| 454 | + } | ||
| 455 | + } | ||
| 456 | + ] | ||
| 457 | + } | ||
| 458 | + }, | ||
| 459 | + "/auth/forgot-password": { | ||
| 460 | + "post": { | ||
| 461 | + "deprecated": false, | ||
| 462 | + "description": "Send the reset password email link", | ||
| 463 | + "responses": { | ||
| 464 | + "200": { | ||
| 465 | + "description": "response", | ||
| 466 | + "content": { | ||
| 467 | + "application/json": { | ||
| 468 | + "schema": { | ||
| 469 | + "properties": { | ||
| 470 | + "foo": { | ||
| 471 | + "type": "string" | ||
| 472 | + } | ||
| 473 | + } | ||
| 474 | + } | ||
| 475 | + } | ||
| 476 | + } | ||
| 477 | + }, | ||
| 478 | + "403": { | ||
| 479 | + "description": "Forbidden", | ||
| 480 | + "content": { | ||
| 481 | + "application/json": { | ||
| 482 | + "schema": { | ||
| 483 | + "$ref": "#/components/schemas/Error" | ||
| 484 | + } | ||
| 485 | + } | ||
| 486 | + } | ||
| 487 | + }, | ||
| 488 | + "404": { | ||
| 489 | + "description": "Not found", | ||
| 490 | + "content": { | ||
| 491 | + "application/json": { | ||
| 492 | + "schema": { | ||
| 493 | + "$ref": "#/components/schemas/Error" | ||
| 494 | + } | ||
| 495 | + } | ||
| 496 | + } | ||
| 497 | + }, | ||
| 498 | + "default": { | ||
| 499 | + "description": "unexpected error", | ||
| 500 | + "content": { | ||
| 501 | + "application/json": { | ||
| 502 | + "schema": { | ||
| 503 | + "$ref": "#/components/schemas/Error" | ||
| 504 | + } | ||
| 505 | + } | ||
| 506 | + } | ||
| 507 | + } | ||
| 508 | + }, | ||
| 509 | + "summary": "", | ||
| 510 | + "tags": [ | ||
| 511 | + "Users-Permissions - User" | ||
| 512 | + ], | ||
| 513 | + "requestBody": { | ||
| 514 | + "description": "", | ||
| 515 | + "required": true, | ||
| 516 | + "content": { | ||
| 517 | + "application/json": { | ||
| 518 | + "schema": { | ||
| 519 | + "properties": { | ||
| 520 | + "foo": { | ||
| 521 | + "type": "string" | ||
| 522 | + } | ||
| 523 | + } | ||
| 524 | + } | ||
| 525 | + } | ||
| 526 | + } | ||
| 527 | + } | ||
| 528 | + } | ||
| 529 | + }, | ||
| 530 | + "/auth/reset-password": { | ||
| 531 | + "post": { | ||
| 532 | + "deprecated": false, | ||
| 533 | + "description": "Change a user's password", | ||
| 534 | + "responses": { | ||
| 535 | + "200": { | ||
| 536 | + "description": "response", | ||
| 537 | + "content": { | ||
| 538 | + "application/json": { | ||
| 539 | + "schema": { | ||
| 540 | + "properties": { | ||
| 541 | + "foo": { | ||
| 542 | + "type": "string" | ||
| 543 | + } | ||
| 544 | + } | ||
| 545 | + } | ||
| 546 | + } | ||
| 547 | + } | ||
| 548 | + }, | ||
| 549 | + "403": { | ||
| 550 | + "description": "Forbidden", | ||
| 551 | + "content": { | ||
| 552 | + "application/json": { | ||
| 553 | + "schema": { | ||
| 554 | + "$ref": "#/components/schemas/Error" | ||
| 555 | + } | ||
| 556 | + } | ||
| 557 | + } | ||
| 558 | + }, | ||
| 559 | + "404": { | ||
| 560 | + "description": "Not found", | ||
| 561 | + "content": { | ||
| 562 | + "application/json": { | ||
| 563 | + "schema": { | ||
| 564 | + "$ref": "#/components/schemas/Error" | ||
| 565 | + } | ||
| 566 | + } | ||
| 567 | + } | ||
| 568 | + }, | ||
| 569 | + "default": { | ||
| 570 | + "description": "unexpected error", | ||
| 571 | + "content": { | ||
| 572 | + "application/json": { | ||
| 573 | + "schema": { | ||
| 574 | + "$ref": "#/components/schemas/Error" | ||
| 575 | + } | ||
| 576 | + } | ||
| 577 | + } | ||
| 578 | + } | ||
| 579 | + }, | ||
| 580 | + "summary": "", | ||
| 581 | + "tags": [ | ||
| 582 | + "Users-Permissions - User" | ||
| 583 | + ], | ||
| 584 | + "requestBody": { | ||
| 585 | + "description": "", | ||
| 586 | + "required": true, | ||
| 587 | + "content": { | ||
| 588 | + "application/json": { | ||
| 589 | + "schema": { | ||
| 590 | + "properties": { | ||
| 591 | + "foo": { | ||
| 592 | + "type": "string" | ||
| 593 | + } | ||
| 594 | + } | ||
| 595 | + } | ||
| 596 | + } | ||
| 597 | + } | ||
| 598 | + } | ||
| 599 | + } | ||
| 600 | + }, | ||
| 601 | + "/auth/email-confirmation": { | ||
| 602 | + "get": { | ||
| 603 | + "deprecated": false, | ||
| 604 | + "description": "Validate a user account", | ||
| 605 | + "responses": { | ||
| 606 | + "200": { | ||
| 607 | + "description": "response", | ||
| 608 | + "content": { | ||
| 609 | + "application/json": { | ||
| 610 | + "schema": { | ||
| 611 | + "properties": { | ||
| 612 | + "foo": { | ||
| 613 | + "type": "string" | ||
| 614 | + } | ||
| 615 | + } | ||
| 616 | + } | ||
| 617 | + } | ||
| 618 | + } | ||
| 619 | + }, | ||
| 620 | + "403": { | ||
| 621 | + "description": "Forbidden", | ||
| 622 | + "content": { | ||
| 623 | + "application/json": { | ||
| 624 | + "schema": { | ||
| 625 | + "$ref": "#/components/schemas/Error" | ||
| 626 | + } | ||
| 627 | + } | ||
| 628 | + } | ||
| 629 | + }, | ||
| 630 | + "404": { | ||
| 631 | + "description": "Not found", | ||
| 632 | + "content": { | ||
| 633 | + "application/json": { | ||
| 634 | + "schema": { | ||
| 635 | + "$ref": "#/components/schemas/Error" | ||
| 636 | + } | ||
| 637 | + } | ||
| 638 | + } | ||
| 639 | + }, | ||
| 640 | + "default": { | ||
| 641 | + "description": "unexpected error", | ||
| 642 | + "content": { | ||
| 643 | + "application/json": { | ||
| 644 | + "schema": { | ||
| 645 | + "$ref": "#/components/schemas/Error" | ||
| 646 | + } | ||
| 647 | + } | ||
| 648 | + } | ||
| 649 | + } | ||
| 650 | + }, | ||
| 651 | + "summary": "", | ||
| 652 | + "tags": [ | ||
| 653 | + "Users-Permissions - User" | ||
| 654 | + ], | ||
| 655 | + "parameters": [] | ||
| 656 | + } | ||
| 657 | + }, | ||
| 658 | + "/auth/send-email-confirmation": { | ||
| 659 | + "post": { | ||
| 660 | + "deprecated": false, | ||
| 661 | + "description": "Send a confirmation email to user", | ||
| 662 | + "responses": { | ||
| 663 | + "200": { | ||
| 664 | + "description": "response", | ||
| 665 | + "content": { | ||
| 666 | + "application/json": { | ||
| 667 | + "schema": { | ||
| 668 | + "properties": { | ||
| 669 | + "foo": { | ||
| 670 | + "type": "string" | ||
| 671 | + } | ||
| 672 | + } | ||
| 673 | + } | ||
| 674 | + } | ||
| 675 | + } | ||
| 676 | + }, | ||
| 677 | + "403": { | ||
| 678 | + "description": "Forbidden", | ||
| 679 | + "content": { | ||
| 680 | + "application/json": { | ||
| 681 | + "schema": { | ||
| 682 | + "$ref": "#/components/schemas/Error" | ||
| 683 | + } | ||
| 684 | + } | ||
| 685 | + } | ||
| 686 | + }, | ||
| 687 | + "404": { | ||
| 688 | + "description": "Not found", | ||
| 689 | + "content": { | ||
| 690 | + "application/json": { | ||
| 691 | + "schema": { | ||
| 692 | + "$ref": "#/components/schemas/Error" | ||
| 693 | + } | ||
| 694 | + } | ||
| 695 | + } | ||
| 696 | + }, | ||
| 697 | + "default": { | ||
| 698 | + "description": "unexpected error", | ||
| 699 | + "content": { | ||
| 700 | + "application/json": { | ||
| 701 | + "schema": { | ||
| 702 | + "$ref": "#/components/schemas/Error" | ||
| 703 | + } | ||
| 704 | + } | ||
| 705 | + } | ||
| 706 | + } | ||
| 707 | + }, | ||
| 708 | + "summary": "", | ||
| 709 | + "tags": [ | ||
| 710 | + "Users-Permissions - User" | ||
| 711 | + ], | ||
| 712 | + "requestBody": { | ||
| 713 | + "description": "", | ||
| 714 | + "required": true, | ||
| 715 | + "content": { | ||
| 716 | + "application/json": { | ||
| 717 | + "schema": { | ||
| 718 | + "properties": { | ||
| 719 | + "foo": { | ||
| 720 | + "type": "string" | ||
| 721 | + } | ||
| 722 | + } | ||
| 723 | + } | ||
| 724 | + } | ||
| 725 | + } | ||
| 726 | + } | ||
| 727 | + } | ||
| 728 | + }, | ||
| 729 | + "/users": { | ||
| 730 | + "get": { | ||
| 731 | + "deprecated": false, | ||
| 732 | + "description": "Retrieve all user documents", | ||
| 733 | + "responses": { | ||
| 734 | + "200": { | ||
| 735 | + "description": "response", | ||
| 736 | + "content": { | ||
| 737 | + "application/json": { | ||
| 738 | + "schema": { | ||
| 739 | + "type": "array", | ||
| 740 | + "items": { | ||
| 741 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 742 | + } | ||
| 743 | + } | ||
| 744 | + } | ||
| 745 | + } | ||
| 746 | + }, | ||
| 747 | + "403": { | ||
| 748 | + "description": "Forbidden", | ||
| 749 | + "content": { | ||
| 750 | + "application/json": { | ||
| 751 | + "schema": { | ||
| 752 | + "$ref": "#/components/schemas/Error" | ||
| 753 | + } | ||
| 754 | + } | ||
| 755 | + } | ||
| 756 | + }, | ||
| 757 | + "404": { | ||
| 758 | + "description": "Not found", | ||
| 759 | + "content": { | ||
| 760 | + "application/json": { | ||
| 761 | + "schema": { | ||
| 762 | + "$ref": "#/components/schemas/Error" | ||
| 763 | + } | ||
| 764 | + } | ||
| 765 | + } | ||
| 766 | + }, | ||
| 767 | + "default": { | ||
| 768 | + "description": "unexpected error", | ||
| 769 | + "content": { | ||
| 770 | + "application/json": { | ||
| 771 | + "schema": { | ||
| 772 | + "$ref": "#/components/schemas/Error" | ||
| 773 | + } | ||
| 774 | + } | ||
| 775 | + } | ||
| 776 | + } | ||
| 777 | + }, | ||
| 778 | + "summary": "", | ||
| 779 | + "tags": [ | ||
| 780 | + "Users-Permissions - User" | ||
| 781 | + ], | ||
| 782 | + "parameters": [ | ||
| 783 | + { | ||
| 784 | + "name": "_limit", | ||
| 785 | + "in": "query", | ||
| 786 | + "required": false, | ||
| 787 | + "description": "Maximum number of results possible", | ||
| 788 | + "schema": { | ||
| 789 | + "type": "integer" | ||
| 790 | + }, | ||
| 791 | + "deprecated": false | ||
| 792 | + }, | ||
| 793 | + { | ||
| 794 | + "name": "_sort", | ||
| 795 | + "in": "query", | ||
| 796 | + "required": false, | ||
| 797 | + "description": "Sort according to a specific field.", | ||
| 798 | + "schema": { | ||
| 799 | + "type": "string" | ||
| 800 | + }, | ||
| 801 | + "deprecated": false | ||
| 802 | + }, | ||
| 803 | + { | ||
| 804 | + "name": "_start", | ||
| 805 | + "in": "query", | ||
| 806 | + "required": false, | ||
| 807 | + "description": "Skip a specific number of entries (especially useful for pagination)", | ||
| 808 | + "schema": { | ||
| 809 | + "type": "integer" | ||
| 810 | + }, | ||
| 811 | + "deprecated": false | ||
| 812 | + }, | ||
| 813 | + { | ||
| 814 | + "name": "=", | ||
| 815 | + "in": "query", | ||
| 816 | + "required": false, | ||
| 817 | + "description": "Get entries that matches exactly your input", | ||
| 818 | + "schema": { | ||
| 819 | + "type": "string" | ||
| 820 | + }, | ||
| 821 | + "deprecated": false | ||
| 822 | + }, | ||
| 823 | + { | ||
| 824 | + "name": "_ne", | ||
| 825 | + "in": "query", | ||
| 826 | + "required": false, | ||
| 827 | + "description": "Get records that are not equals to something", | ||
| 828 | + "schema": { | ||
| 829 | + "type": "string" | ||
| 830 | + }, | ||
| 831 | + "deprecated": false | ||
| 832 | + }, | ||
| 833 | + { | ||
| 834 | + "name": "_lt", | ||
| 835 | + "in": "query", | ||
| 836 | + "required": false, | ||
| 837 | + "description": "Get record that are lower than a value", | ||
| 838 | + "schema": { | ||
| 839 | + "type": "string" | ||
| 840 | + }, | ||
| 841 | + "deprecated": false | ||
| 842 | + }, | ||
| 843 | + { | ||
| 844 | + "name": "_lte", | ||
| 845 | + "in": "query", | ||
| 846 | + "required": false, | ||
| 847 | + "description": "Get records that are lower than or equal to a value", | ||
| 848 | + "schema": { | ||
| 849 | + "type": "string" | ||
| 850 | + }, | ||
| 851 | + "deprecated": false | ||
| 852 | + }, | ||
| 853 | + { | ||
| 854 | + "name": "_gt", | ||
| 855 | + "in": "query", | ||
| 856 | + "required": false, | ||
| 857 | + "description": "Get records that are greater than a value", | ||
| 858 | + "schema": { | ||
| 859 | + "type": "string" | ||
| 860 | + }, | ||
| 861 | + "deprecated": false | ||
| 862 | + }, | ||
| 863 | + { | ||
| 864 | + "name": "_gte", | ||
| 865 | + "in": "query", | ||
| 866 | + "required": false, | ||
| 867 | + "description": "Get records that are greater than or equal a value", | ||
| 868 | + "schema": { | ||
| 869 | + "type": "string" | ||
| 870 | + }, | ||
| 871 | + "deprecated": false | ||
| 872 | + }, | ||
| 873 | + { | ||
| 874 | + "name": "_contains", | ||
| 875 | + "in": "query", | ||
| 876 | + "required": false, | ||
| 877 | + "description": "Get records that contains a value", | ||
| 878 | + "schema": { | ||
| 879 | + "type": "string" | ||
| 880 | + }, | ||
| 881 | + "deprecated": false | ||
| 882 | + }, | ||
| 883 | + { | ||
| 884 | + "name": "_containss", | ||
| 885 | + "in": "query", | ||
| 886 | + "required": false, | ||
| 887 | + "description": "Get records that contains (case sensitive) a value", | ||
| 888 | + "schema": { | ||
| 889 | + "type": "string" | ||
| 890 | + }, | ||
| 891 | + "deprecated": false | ||
| 892 | + }, | ||
| 893 | + { | ||
| 894 | + "name": "_in", | ||
| 895 | + "in": "query", | ||
| 896 | + "required": false, | ||
| 897 | + "description": "Get records that matches any value in the array of values", | ||
| 898 | + "schema": { | ||
| 899 | + "type": "array" | ||
| 900 | + }, | ||
| 901 | + "deprecated": false | ||
| 902 | + }, | ||
| 903 | + { | ||
| 904 | + "name": "_nin", | ||
| 905 | + "in": "query", | ||
| 906 | + "required": false, | ||
| 907 | + "description": "Get records that doesn't match any value in the array of values", | ||
| 908 | + "schema": { | ||
| 909 | + "type": "array" | ||
| 910 | + }, | ||
| 911 | + "deprecated": false | ||
| 912 | + } | ||
| 913 | + ] | ||
| 914 | + } | ||
| 915 | + }, | ||
| 916 | + "/users/me": { | ||
| 917 | + "get": { | ||
| 918 | + "deprecated": false, | ||
| 919 | + "description": "Retrieve the logged in user information", | ||
| 920 | + "responses": { | ||
| 921 | + "200": { | ||
| 922 | + "description": "response", | ||
| 923 | + "content": { | ||
| 924 | + "application/json": { | ||
| 925 | + "schema": { | ||
| 926 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 927 | + } | ||
| 928 | + } | ||
| 929 | + } | ||
| 930 | + }, | ||
| 931 | + "403": { | ||
| 932 | + "description": "Forbidden", | ||
| 933 | + "content": { | ||
| 934 | + "application/json": { | ||
| 935 | + "schema": { | ||
| 936 | + "$ref": "#/components/schemas/Error" | ||
| 937 | + } | ||
| 938 | + } | ||
| 939 | + } | ||
| 940 | + }, | ||
| 941 | + "404": { | ||
| 942 | + "description": "Not found", | ||
| 943 | + "content": { | ||
| 944 | + "application/json": { | ||
| 945 | + "schema": { | ||
| 946 | + "$ref": "#/components/schemas/Error" | ||
| 947 | + } | ||
| 948 | + } | ||
| 949 | + } | ||
| 950 | + }, | ||
| 951 | + "default": { | ||
| 952 | + "description": "unexpected error", | ||
| 953 | + "content": { | ||
| 954 | + "application/json": { | ||
| 955 | + "schema": { | ||
| 956 | + "$ref": "#/components/schemas/Error" | ||
| 957 | + } | ||
| 958 | + } | ||
| 959 | + } | ||
| 960 | + } | ||
| 961 | + }, | ||
| 962 | + "summary": "", | ||
| 963 | + "tags": [ | ||
| 964 | + "Users-Permissions - User" | ||
| 965 | + ], | ||
| 966 | + "parameters": [] | ||
| 967 | + } | ||
| 968 | + }, | ||
| 969 | + "/users/{id}": { | ||
| 970 | + "get": { | ||
| 971 | + "deprecated": false, | ||
| 972 | + "description": "Retrieve a single user depending on his id", | ||
| 973 | + "responses": { | ||
| 974 | + "200": { | ||
| 975 | + "description": "response", | ||
| 976 | + "content": { | ||
| 977 | + "application/json": { | ||
| 978 | + "schema": { | ||
| 979 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 980 | + } | ||
| 981 | + } | ||
| 982 | + } | ||
| 983 | + }, | ||
| 984 | + "403": { | ||
| 985 | + "description": "Forbidden", | ||
| 986 | + "content": { | ||
| 987 | + "application/json": { | ||
| 988 | + "schema": { | ||
| 989 | + "$ref": "#/components/schemas/Error" | ||
| 990 | + } | ||
| 991 | + } | ||
| 992 | + } | ||
| 993 | + }, | ||
| 994 | + "404": { | ||
| 995 | + "description": "Not found", | ||
| 996 | + "content": { | ||
| 997 | + "application/json": { | ||
| 998 | + "schema": { | ||
| 999 | + "$ref": "#/components/schemas/Error" | ||
| 1000 | + } | ||
| 1001 | + } | ||
| 1002 | + } | ||
| 1003 | + }, | ||
| 1004 | + "default": { | ||
| 1005 | + "description": "unexpected error", | ||
| 1006 | + "content": { | ||
| 1007 | + "application/json": { | ||
| 1008 | + "schema": { | ||
| 1009 | + "$ref": "#/components/schemas/Error" | ||
| 1010 | + } | ||
| 1011 | + } | ||
| 1012 | + } | ||
| 1013 | + } | ||
| 1014 | + }, | ||
| 1015 | + "summary": "", | ||
| 1016 | + "tags": [ | ||
| 1017 | + "Users-Permissions - User" | ||
| 1018 | + ], | ||
| 1019 | + "parameters": [ | ||
| 1020 | + { | ||
| 1021 | + "name": "id", | ||
| 1022 | + "in": "path", | ||
| 1023 | + "description": "", | ||
| 1024 | + "deprecated": false, | ||
| 1025 | + "required": true, | ||
| 1026 | + "schema": { | ||
| 1027 | + "type": "string" | ||
| 1028 | + } | ||
| 1029 | + } | ||
| 1030 | + ] | ||
| 1031 | + }, | ||
| 1032 | + "put": { | ||
| 1033 | + "deprecated": false, | ||
| 1034 | + "description": "Update an existing user", | ||
| 1035 | + "responses": { | ||
| 1036 | + "200": { | ||
| 1037 | + "description": "response", | ||
| 1038 | + "content": { | ||
| 1039 | + "application/json": { | ||
| 1040 | + "schema": { | ||
| 1041 | + "$ref": "#/components/schemas/Users-PermissionsUser" | ||
| 1042 | + } | ||
| 1043 | + } | ||
| 1044 | + } | ||
| 1045 | + }, | ||
| 1046 | + "403": { | ||
| 1047 | + "description": "Forbidden", | ||
| 1048 | + "content": { | ||
| 1049 | + "application/json": { | ||
| 1050 | + "schema": { | ||
| 1051 | + "$ref": "#/components/schemas/Error" | ||
| 1052 | + } | ||
| 1053 | + } | ||
| 1054 | + } | ||
| 1055 | + }, | ||
| 1056 | + "404": { | ||
| 1057 | + "description": "Not found", | ||
| 1058 | + "content": { | ||
| 1059 | + "application/json": { | ||
| 1060 | + "schema": { | ||
| 1061 | + "$ref": "#/components/schemas/Error" | ||
| 1062 | + } | ||
| 1063 | + } | ||
| 1064 | + } | ||
| 1065 | + }, | ||
| 1066 | + "default": { | ||
| 1067 | + "description": "unexpected error", | ||
| 1068 | + "content": { | ||
| 1069 | + "application/json": { | ||
| 1070 | + "schema": { | ||
| 1071 | + "$ref": "#/components/schemas/Error" | ||
| 1072 | + } | ||
| 1073 | + } | ||
| 1074 | + } | ||
| 1075 | + } | ||
| 1076 | + }, | ||
| 1077 | + "summary": "", | ||
| 1078 | + "tags": [ | ||
| 1079 | + "Users-Permissions - User" | ||
| 1080 | + ], | ||
| 1081 | + "parameters": [ | ||
| 1082 | + { | ||
| 1083 | + "name": "id", | ||
| 1084 | + "in": "path", | ||
| 1085 | + "description": "", | ||
| 1086 | + "deprecated": false, | ||
| 1087 | + "required": true, | ||
| 1088 | + "schema": { | ||
| 1089 | + "type": "string" | ||
| 1090 | + } | ||
| 1091 | + } | ||
| 1092 | + ], | ||
| 1093 | + "requestBody": { | ||
| 1094 | + "description": "", | ||
| 1095 | + "required": true, | ||
| 1096 | + "content": { | ||
| 1097 | + "application/json": { | ||
| 1098 | + "schema": { | ||
| 1099 | + "$ref": "#/components/schemas/NewUsers-PermissionsUser" | ||
| 1100 | + } | ||
| 1101 | + } | ||
| 1102 | + } | ||
| 1103 | + } | ||
| 1104 | + }, | ||
| 1105 | + "delete": { | ||
| 1106 | + "deprecated": false, | ||
| 1107 | + "description": "Delete an existing user", | ||
| 1108 | + "responses": { | ||
| 1109 | + "200": { | ||
| 1110 | + "description": "response", | ||
| 1111 | + "content": { | ||
| 1112 | + "application/json": { | ||
| 1113 | + "schema": { | ||
| 1114 | + "properties": { | ||
| 1115 | + "foo": { | ||
| 1116 | + "type": "string" | ||
| 1117 | + } | ||
| 1118 | + } | ||
| 1119 | + } | ||
| 1120 | + } | ||
| 1121 | + } | ||
| 1122 | + }, | ||
| 1123 | + "403": { | ||
| 1124 | + "description": "Forbidden", | ||
| 1125 | + "content": { | ||
| 1126 | + "application/json": { | ||
| 1127 | + "schema": { | ||
| 1128 | + "$ref": "#/components/schemas/Error" | ||
| 1129 | + } | ||
| 1130 | + } | ||
| 1131 | + } | ||
| 1132 | + }, | ||
| 1133 | + "404": { | ||
| 1134 | + "description": "Not found", | ||
| 1135 | + "content": { | ||
| 1136 | + "application/json": { | ||
| 1137 | + "schema": { | ||
| 1138 | + "$ref": "#/components/schemas/Error" | ||
| 1139 | + } | ||
| 1140 | + } | ||
| 1141 | + } | ||
| 1142 | + }, | ||
| 1143 | + "default": { | ||
| 1144 | + "description": "unexpected error", | ||
| 1145 | + "content": { | ||
| 1146 | + "application/json": { | ||
| 1147 | + "schema": { | ||
| 1148 | + "$ref": "#/components/schemas/Error" | ||
| 1149 | + } | ||
| 1150 | + } | ||
| 1151 | + } | ||
| 1152 | + } | ||
| 1153 | + }, | ||
| 1154 | + "summary": "", | ||
| 1155 | + "tags": [ | ||
| 1156 | + "Users-Permissions - User" | ||
| 1157 | + ], | ||
| 1158 | + "parameters": [ | ||
| 1159 | + { | ||
| 1160 | + "name": "id", | ||
| 1161 | + "in": "path", | ||
| 1162 | + "description": "", | ||
| 1163 | + "deprecated": false, | ||
| 1164 | + "required": true, | ||
| 1165 | + "schema": { | ||
| 1166 | + "type": "string" | ||
| 1167 | + } | ||
| 1168 | + } | ||
| 1169 | + ] | ||
| 1170 | + } | ||
| 1171 | + } | ||
| 1172 | + }, | ||
| 1173 | + "components": { | ||
| 1174 | + "schemas": { | ||
| 1175 | + "Users-PermissionsUser": { | ||
| 1176 | + "required": [ | ||
| 1177 | + "id", | ||
| 1178 | + "username", | ||
| 1179 | + "email" | ||
| 1180 | + ], | ||
| 1181 | + "properties": { | ||
| 1182 | + "id": { | ||
| 1183 | + "type": "string" | ||
| 1184 | + }, | ||
| 1185 | + "username": { | ||
| 1186 | + "type": "string", | ||
| 1187 | + "minLength": 3 | ||
| 1188 | + }, | ||
| 1189 | + "email": { | ||
| 1190 | + "type": "string", | ||
| 1191 | + "minLength": 6 | ||
| 1192 | + }, | ||
| 1193 | + "provider": { | ||
| 1194 | + "type": "string" | ||
| 1195 | + }, | ||
| 1196 | + "confirmed": { | ||
| 1197 | + "type": "boolean", | ||
| 1198 | + "default": false | ||
| 1199 | + }, | ||
| 1200 | + "blocked": { | ||
| 1201 | + "type": "boolean", | ||
| 1202 | + "default": false | ||
| 1203 | + }, | ||
| 1204 | + "role": { | ||
| 1205 | + "required": [ | ||
| 1206 | + "id", | ||
| 1207 | + "name" | ||
| 1208 | + ], | ||
| 1209 | + "properties": { | ||
| 1210 | + "id": { | ||
| 1211 | + "type": "string" | ||
| 1212 | + }, | ||
| 1213 | + "name": { | ||
| 1214 | + "type": "string" | ||
| 1215 | + }, | ||
| 1216 | + "description": { | ||
| 1217 | + "type": "string" | ||
| 1218 | + }, | ||
| 1219 | + "type": { | ||
| 1220 | + "type": "string" | ||
| 1221 | + }, | ||
| 1222 | + "permissions": { | ||
| 1223 | + "type": "array", | ||
| 1224 | + "items": { | ||
| 1225 | + "type": "string" | ||
| 1226 | + } | ||
| 1227 | + }, | ||
| 1228 | + "users": { | ||
| 1229 | + "type": "array", | ||
| 1230 | + "items": { | ||
| 1231 | + "type": "string" | ||
| 1232 | + } | ||
| 1233 | + } | ||
| 1234 | + } | ||
| 1235 | + } | ||
| 1236 | + } | ||
| 1237 | + }, | ||
| 1238 | + "NewUsers-PermissionsUser": { | ||
| 1239 | + "required": [ | ||
| 1240 | + "username", | ||
| 1241 | + "email" | ||
| 1242 | + ], | ||
| 1243 | + "properties": { | ||
| 1244 | + "username": { | ||
| 1245 | + "type": "string", | ||
| 1246 | + "minLength": 3 | ||
| 1247 | + }, | ||
| 1248 | + "email": { | ||
| 1249 | + "type": "string", | ||
| 1250 | + "minLength": 6 | ||
| 1251 | + }, | ||
| 1252 | + "provider": { | ||
| 1253 | + "type": "string" | ||
| 1254 | + }, | ||
| 1255 | + "password": { | ||
| 1256 | + "type": "string", | ||
| 1257 | + "minLength": 6 | ||
| 1258 | + }, | ||
| 1259 | + "resetPasswordToken": { | ||
| 1260 | + "type": "string" | ||
| 1261 | + }, | ||
| 1262 | + "confirmed": { | ||
| 1263 | + "type": "boolean", | ||
| 1264 | + "default": false | ||
| 1265 | + }, | ||
| 1266 | + "blocked": { | ||
| 1267 | + "type": "boolean", | ||
| 1268 | + "default": false | ||
| 1269 | + }, | ||
| 1270 | + "role": { | ||
| 1271 | + "type": "string" | ||
| 1272 | + } | ||
| 1273 | + } | ||
| 1274 | + } | ||
| 1275 | + } | ||
| 1276 | + }, | ||
| 1277 | + "tags": [ | ||
| 1278 | + { | ||
| 1279 | + "name": "Users-Permissions - User" | ||
| 1280 | + } | ||
| 1281 | + ] | ||
| 1282 | +} | ||
| 0 | \ No newline at end of file | 1283 | \ No newline at end of file |
back-end/h5-api/package.json
| @@ -19,22 +19,23 @@ | @@ -19,22 +19,23 @@ | ||
| 19 | "eslint-plugin-react": "^7.14.0" | 19 | "eslint-plugin-react": "^7.14.0" |
| 20 | }, | 20 | }, |
| 21 | "dependencies": { | 21 | "dependencies": { |
| 22 | + "knex": "latest", | ||
| 22 | "lodash": "^4.17.5", | 23 | "lodash": "^4.17.5", |
| 24 | + "mysql": "latest", | ||
| 23 | "psd": "^3.2.0", | 25 | "psd": "^3.2.0", |
| 24 | - "strapi-hook-ejs": "3.0.0-beta.17.8", | 26 | + "sqlite3": "latest", |
| 25 | "strapi": "3.0.0-beta.17.8", | 27 | "strapi": "3.0.0-beta.17.8", |
| 26 | "strapi-admin": "3.0.0-beta.17.8", | 28 | "strapi-admin": "3.0.0-beta.17.8", |
| 27 | - "strapi-utils": "3.0.0-beta.17.8", | ||
| 28 | - "strapi-plugin-content-type-builder": "3.0.0-beta.17.8", | 29 | + "strapi-hook-bookshelf": "3.0.0-beta.17.8", |
| 30 | + "strapi-hook-ejs": "3.0.0-beta.17.8", | ||
| 31 | + "strapi-hook-knex": "3.0.0-beta.17.8", | ||
| 29 | "strapi-plugin-content-manager": "3.0.0-beta.17.8", | 32 | "strapi-plugin-content-manager": "3.0.0-beta.17.8", |
| 30 | - "strapi-plugin-users-permissions": "3.0.0-beta.17.8", | 33 | + "strapi-plugin-content-type-builder": "3.0.0-beta.17.8", |
| 34 | + "strapi-plugin-documentation": "3.0.0-beta.17.8", | ||
| 31 | "strapi-plugin-email": "3.0.0-beta.17.8", | 35 | "strapi-plugin-email": "3.0.0-beta.17.8", |
| 32 | "strapi-plugin-upload": "3.0.0-beta.17.8", | 36 | "strapi-plugin-upload": "3.0.0-beta.17.8", |
| 33 | - "strapi-hook-bookshelf": "3.0.0-beta.17.8", | ||
| 34 | - "strapi-hook-knex": "3.0.0-beta.17.8", | ||
| 35 | - "knex": "latest", | ||
| 36 | - "mysql": "latest", | ||
| 37 | - "sqlite3": "latest" | 37 | + "strapi-plugin-users-permissions": "3.0.0-beta.17.8", |
| 38 | + "strapi-utils": "3.0.0-beta.17.8" | ||
| 38 | }, | 39 | }, |
| 39 | "author": { | 40 | "author": { |
| 40 | "name": "A Strapi developer" | 41 | "name": "A Strapi developer" |
back-end/h5-api/yarn.lock
| @@ -2229,6 +2229,18 @@ chardet@^0.7.0: | @@ -2229,6 +2229,18 @@ chardet@^0.7.0: | ||
| 2229 | resolved "https://registry.npm.taobao.org/chardet/download/chardet-0.7.0.tgz?cache=0&sync_timestamp=1562887878067&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fchardet%2Fdownload%2Fchardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e" | 2229 | resolved "https://registry.npm.taobao.org/chardet/download/chardet-0.7.0.tgz?cache=0&sync_timestamp=1562887878067&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fchardet%2Fdownload%2Fchardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e" |
| 2230 | integrity sha1-kAlISfCTfy7twkJdDSip5fDLrZ4= | 2230 | integrity sha1-kAlISfCTfy7twkJdDSip5fDLrZ4= |
| 2231 | 2231 | ||
| 2232 | +cheerio@^1.0.0-rc.2: | ||
| 2233 | + version "1.0.0-rc.3" | ||
| 2234 | + resolved "https://registry.npm.taobao.org/cheerio/download/cheerio-1.0.0-rc.3.tgz#094636d425b2e9c0f4eb91a46c05630c9a1a8bf6" | ||
| 2235 | + integrity sha1-CUY21CWy6cD065GkbAVjDJoai/Y= | ||
| 2236 | + dependencies: | ||
| 2237 | + css-select "~1.2.0" | ||
| 2238 | + dom-serializer "~0.1.1" | ||
| 2239 | + entities "~1.1.1" | ||
| 2240 | + htmlparser2 "^3.9.1" | ||
| 2241 | + lodash "^4.15.0" | ||
| 2242 | + parse5 "^3.0.1" | ||
| 2243 | + | ||
| 2232 | chokidar@^2.0.2, chokidar@^2.1.2, chokidar@^2.1.8: | 2244 | chokidar@^2.0.2, chokidar@^2.1.2, chokidar@^2.1.8: |
| 2233 | version "2.1.8" | 2245 | version "2.1.8" |
| 2234 | resolved "https://registry.npm.taobao.org/chokidar/download/chokidar-2.1.8.tgz#804b3a7b6a99358c3c5c61e71d8728f041cff917" | 2246 | resolved "https://registry.npm.taobao.org/chokidar/download/chokidar-2.1.8.tgz#804b3a7b6a99358c3c5c61e71d8728f041cff917" |
| @@ -2843,7 +2855,7 @@ css-select-base-adapter@^0.1.1: | @@ -2843,7 +2855,7 @@ css-select-base-adapter@^0.1.1: | ||
| 2843 | resolved "https://registry.npm.taobao.org/css-select-base-adapter/download/css-select-base-adapter-0.1.1.tgz#3b2ff4972cc362ab88561507a95408a1432135d7" | 2855 | resolved "https://registry.npm.taobao.org/css-select-base-adapter/download/css-select-base-adapter-0.1.1.tgz#3b2ff4972cc362ab88561507a95408a1432135d7" |
| 2844 | integrity sha1-Oy/0lyzDYquIVhUHqVQIoUMhNdc= | 2856 | integrity sha1-Oy/0lyzDYquIVhUHqVQIoUMhNdc= |
| 2845 | 2857 | ||
| 2846 | -css-select@^1.1.0: | 2858 | +css-select@^1.1.0, css-select@~1.2.0: |
| 2847 | version "1.2.0" | 2859 | version "1.2.0" |
| 2848 | resolved "https://registry.npm.taobao.org/css-select/download/css-select-1.2.0.tgz#2b3a110539c5355f1cd8d314623e870b121ec858" | 2860 | resolved "https://registry.npm.taobao.org/css-select/download/css-select-1.2.0.tgz#2b3a110539c5355f1cd8d314623e870b121ec858" |
| 2849 | integrity sha1-KzoRBTnFNV8c2NMUYj6HCxIeyFg= | 2861 | integrity sha1-KzoRBTnFNV8c2NMUYj6HCxIeyFg= |
| @@ -2910,7 +2922,7 @@ csstype@^2.2.0: | @@ -2910,7 +2922,7 @@ csstype@^2.2.0: | ||
| 2910 | resolved "https://registry.npm.taobao.org/csstype/download/csstype-2.6.6.tgz#c34f8226a94bbb10c32cc0d714afdf942291fc41" | 2922 | resolved "https://registry.npm.taobao.org/csstype/download/csstype-2.6.6.tgz#c34f8226a94bbb10c32cc0d714afdf942291fc41" |
| 2911 | integrity sha1-w0+CJqlLuxDDLMDXFK/flCKR/EE= | 2923 | integrity sha1-w0+CJqlLuxDDLMDXFK/flCKR/EE= |
| 2912 | 2924 | ||
| 2913 | -csstype@^2.5.7: | 2925 | +csstype@^2.5.7, csstype@^2.6.7: |
| 2914 | version "2.6.7" | 2926 | version "2.6.7" |
| 2915 | resolved "https://registry.npm.taobao.org/csstype/download/csstype-2.6.7.tgz?cache=0&sync_timestamp=1575469756751&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcsstype%2Fdownload%2Fcsstype-2.6.7.tgz#20b0024c20b6718f4eda3853a1f5a1cce7f5e4a5" | 2927 | resolved "https://registry.npm.taobao.org/csstype/download/csstype-2.6.7.tgz?cache=0&sync_timestamp=1575469756751&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fcsstype%2Fdownload%2Fcsstype-2.6.7.tgz#20b0024c20b6718f4eda3853a1f5a1cce7f5e4a5" |
| 2916 | integrity sha1-ILACTCC2cY9O2jhTofWhzOf15KU= | 2928 | integrity sha1-ILACTCC2cY9O2jhTofWhzOf15KU= |
| @@ -3295,6 +3307,14 @@ dom-helpers@^3.4.0: | @@ -3295,6 +3307,14 @@ dom-helpers@^3.4.0: | ||
| 3295 | dependencies: | 3307 | dependencies: |
| 3296 | "@babel/runtime" "^7.1.2" | 3308 | "@babel/runtime" "^7.1.2" |
| 3297 | 3309 | ||
| 3310 | +dom-helpers@^5.0.1: | ||
| 3311 | + version "5.1.3" | ||
| 3312 | + resolved "https://registry.npm.taobao.org/dom-helpers/download/dom-helpers-5.1.3.tgz?cache=0&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fdom-helpers%2Fdownload%2Fdom-helpers-5.1.3.tgz#7233248eb3a2d1f74aafca31e52c5299cc8ce821" | ||
| 3313 | + integrity sha1-cjMkjrOi0fdKr8ox5SxSmcyM6CE= | ||
| 3314 | + dependencies: | ||
| 3315 | + "@babel/runtime" "^7.6.3" | ||
| 3316 | + csstype "^2.6.7" | ||
| 3317 | + | ||
| 3298 | dom-serializer@0: | 3318 | dom-serializer@0: |
| 3299 | version "0.2.1" | 3319 | version "0.2.1" |
| 3300 | resolved "https://registry.npm.taobao.org/dom-serializer/download/dom-serializer-0.2.1.tgz?cache=0&sync_timestamp=1564710970695&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fdom-serializer%2Fdownload%2Fdom-serializer-0.2.1.tgz#13650c850daffea35d8b626a4cfc4d3a17643fdb" | 3320 | resolved "https://registry.npm.taobao.org/dom-serializer/download/dom-serializer-0.2.1.tgz?cache=0&sync_timestamp=1564710970695&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fdom-serializer%2Fdownload%2Fdom-serializer-0.2.1.tgz#13650c850daffea35d8b626a4cfc4d3a17643fdb" |
| @@ -3303,12 +3323,20 @@ dom-serializer@0: | @@ -3303,12 +3323,20 @@ dom-serializer@0: | ||
| 3303 | domelementtype "^2.0.1" | 3323 | domelementtype "^2.0.1" |
| 3304 | entities "^2.0.0" | 3324 | entities "^2.0.0" |
| 3305 | 3325 | ||
| 3326 | +dom-serializer@~0.1.1: | ||
| 3327 | + version "0.1.1" | ||
| 3328 | + resolved "https://registry.npm.taobao.org/dom-serializer/download/dom-serializer-0.1.1.tgz?cache=0&sync_timestamp=1573447907918&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fdom-serializer%2Fdownload%2Fdom-serializer-0.1.1.tgz#1ec4059e284babed36eec2941d4a970a189ce7c0" | ||
| 3329 | + integrity sha1-HsQFnihLq+027sKUHUqXChic58A= | ||
| 3330 | + dependencies: | ||
| 3331 | + domelementtype "^1.3.0" | ||
| 3332 | + entities "^1.1.1" | ||
| 3333 | + | ||
| 3306 | domain-browser@^1.1.1: | 3334 | domain-browser@^1.1.1: |
| 3307 | version "1.2.0" | 3335 | version "1.2.0" |
| 3308 | resolved "https://registry.npm.taobao.org/domain-browser/download/domain-browser-1.2.0.tgz#3d31f50191a6749dd1375a7f522e823d42e54eda" | 3336 | resolved "https://registry.npm.taobao.org/domain-browser/download/domain-browser-1.2.0.tgz#3d31f50191a6749dd1375a7f522e823d42e54eda" |
| 3309 | integrity sha1-PTH1AZGmdJ3RN1p/Ui6CPULlTto= | 3337 | integrity sha1-PTH1AZGmdJ3RN1p/Ui6CPULlTto= |
| 3310 | 3338 | ||
| 3311 | -domelementtype@1, domelementtype@^1.3.1: | 3339 | +domelementtype@1, domelementtype@^1.3.0, domelementtype@^1.3.1: |
| 3312 | version "1.3.1" | 3340 | version "1.3.1" |
| 3313 | resolved "https://registry.npm.taobao.org/domelementtype/download/domelementtype-1.3.1.tgz#d048c44b37b0d10a7f2a3d5fee3f4333d790481f" | 3341 | resolved "https://registry.npm.taobao.org/domelementtype/download/domelementtype-1.3.1.tgz#d048c44b37b0d10a7f2a3d5fee3f4333d790481f" |
| 3314 | integrity sha1-0EjESzew0Qp/Kj1f7j9DM9eQSB8= | 3342 | integrity sha1-0EjESzew0Qp/Kj1f7j9DM9eQSB8= |
| @@ -3501,7 +3529,7 @@ enhanced-resolve@4.1.0, enhanced-resolve@^4.1.0: | @@ -3501,7 +3529,7 @@ enhanced-resolve@4.1.0, enhanced-resolve@^4.1.0: | ||
| 3501 | memory-fs "^0.4.0" | 3529 | memory-fs "^0.4.0" |
| 3502 | tapable "^1.0.0" | 3530 | tapable "^1.0.0" |
| 3503 | 3531 | ||
| 3504 | -entities@^1.1.1: | 3532 | +entities@^1.1.1, entities@~1.1.1: |
| 3505 | version "1.1.2" | 3533 | version "1.1.2" |
| 3506 | resolved "https://registry.npm.taobao.org/entities/download/entities-1.1.2.tgz?cache=0&sync_timestamp=1563403393055&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fentities%2Fdownload%2Fentities-1.1.2.tgz#bdfa735299664dfafd34529ed4f8522a275fea56" | 3534 | resolved "https://registry.npm.taobao.org/entities/download/entities-1.1.2.tgz?cache=0&sync_timestamp=1563403393055&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fentities%2Fdownload%2Fentities-1.1.2.tgz#bdfa735299664dfafd34529ed4f8522a275fea56" |
| 3507 | integrity sha1-vfpzUplmTfr9NFKe1PhSKidf6lY= | 3535 | integrity sha1-vfpzUplmTfr9NFKe1PhSKidf6lY= |
| @@ -5004,7 +5032,7 @@ html-webpack-plugin@^3.2.0: | @@ -5004,7 +5032,7 @@ html-webpack-plugin@^3.2.0: | ||
| 5004 | toposort "^1.0.0" | 5032 | toposort "^1.0.0" |
| 5005 | util.promisify "1.0.0" | 5033 | util.promisify "1.0.0" |
| 5006 | 5034 | ||
| 5007 | -htmlparser2@^3.3.0: | 5035 | +htmlparser2@^3.3.0, htmlparser2@^3.9.1: |
| 5008 | version "3.10.1" | 5036 | version "3.10.1" |
| 5009 | resolved "https://registry.npm.taobao.org/htmlparser2/download/htmlparser2-3.10.1.tgz?cache=0&sync_timestamp=1564773692945&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fhtmlparser2%2Fdownload%2Fhtmlparser2-3.10.1.tgz#bd679dc3f59897b6a34bb10749c855bb53a9392f" | 5037 | resolved "https://registry.npm.taobao.org/htmlparser2/download/htmlparser2-3.10.1.tgz?cache=0&sync_timestamp=1564773692945&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fhtmlparser2%2Fdownload%2Fhtmlparser2-3.10.1.tgz#bd679dc3f59897b6a34bb10749c855bb53a9392f" |
| 5010 | integrity sha1-vWedw/WYl7ajS7EHSchVu1OpOS8= | 5038 | integrity sha1-vWedw/WYl7ajS7EHSchVu1OpOS8= |
| @@ -6509,7 +6537,7 @@ lodash.tonumber@^4.0.3: | @@ -6509,7 +6537,7 @@ lodash.tonumber@^4.0.3: | ||
| 6509 | resolved "https://registry.npm.taobao.org/lodash.tonumber/download/lodash.tonumber-4.0.3.tgz#0b96b31b35672793eb7f5a63ee791f1b9e9025d9" | 6537 | resolved "https://registry.npm.taobao.org/lodash.tonumber/download/lodash.tonumber-4.0.3.tgz#0b96b31b35672793eb7f5a63ee791f1b9e9025d9" |
| 6510 | integrity sha1-C5azGzVnJ5Prf1pj7nkfG56QJdk= | 6538 | integrity sha1-C5azGzVnJ5Prf1pj7nkfG56QJdk= |
| 6511 | 6539 | ||
| 6512 | -lodash@^4.1.1, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.3, lodash@^4.17.4, lodash@^4.17.5: | 6540 | +lodash@^4.1.1, lodash@^4.15.0, lodash@^4.17.10, lodash@^4.17.11, lodash@^4.17.12, lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.3, lodash@^4.17.4, lodash@^4.17.5: |
| 6513 | version "4.17.15" | 6541 | version "4.17.15" |
| 6514 | resolved "https://registry.npm.taobao.org/lodash/download/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548" | 6542 | resolved "https://registry.npm.taobao.org/lodash/download/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548" |
| 6515 | integrity sha1-tEf2ZwoEVbv+7dETku/zMOoJdUg= | 6543 | integrity sha1-tEf2ZwoEVbv+7dETku/zMOoJdUg= |
| @@ -7813,6 +7841,13 @@ parse-passwd@^1.0.0: | @@ -7813,6 +7841,13 @@ parse-passwd@^1.0.0: | ||
| 7813 | resolved "https://registry.npm.taobao.org/parse-passwd/download/parse-passwd-1.0.0.tgz#6d5b934a456993b23d37f40a382d6f1666a8e5c6" | 7841 | resolved "https://registry.npm.taobao.org/parse-passwd/download/parse-passwd-1.0.0.tgz#6d5b934a456993b23d37f40a382d6f1666a8e5c6" |
| 7814 | integrity sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY= | 7842 | integrity sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY= |
| 7815 | 7843 | ||
| 7844 | +parse5@^3.0.1: | ||
| 7845 | + version "3.0.3" | ||
| 7846 | + resolved "https://registry.npm.taobao.org/parse5/download/parse5-3.0.3.tgz?cache=0&sync_timestamp=1573036762880&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fparse5%2Fdownload%2Fparse5-3.0.3.tgz#042f792ffdd36851551cf4e9e066b3874ab45b5c" | ||
| 7847 | + integrity sha1-BC95L/3TaFFVHPTp4Gazh0q0W1w= | ||
| 7848 | + dependencies: | ||
| 7849 | + "@types/node" "*" | ||
| 7850 | + | ||
| 7816 | parseurl@^1.3.2, parseurl@~1.3.2, parseurl@~1.3.3: | 7851 | parseurl@^1.3.2, parseurl@~1.3.2, parseurl@~1.3.3: |
| 7817 | version "1.3.3" | 7852 | version "1.3.3" |
| 7818 | resolved "https://registry.npm.taobao.org/parseurl/download/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" | 7853 | resolved "https://registry.npm.taobao.org/parseurl/download/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" |
| @@ -7889,6 +7924,11 @@ path-to-regexp@^1.1.1, path-to-regexp@^1.7.0: | @@ -7889,6 +7924,11 @@ path-to-regexp@^1.1.1, path-to-regexp@^1.7.0: | ||
| 7889 | dependencies: | 7924 | dependencies: |
| 7890 | isarray "0.0.1" | 7925 | isarray "0.0.1" |
| 7891 | 7926 | ||
| 7927 | +path-to-regexp@^3.0.0: | ||
| 7928 | + version "3.2.0" | ||
| 7929 | + resolved "https://registry.npm.taobao.org/path-to-regexp/download/path-to-regexp-3.2.0.tgz?cache=0&sync_timestamp=1574278262588&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Fpath-to-regexp%2Fdownload%2Fpath-to-regexp-3.2.0.tgz#fa7877ecbc495c601907562222453c43cc204a5f" | ||
| 7930 | + integrity sha1-+nh37LxJXGAZB1YiIkU8Q8wgSl8= | ||
| 7931 | + | ||
| 7892 | path-type@^1.0.0: | 7932 | path-type@^1.0.0: |
| 7893 | version "1.1.0" | 7933 | version "1.1.0" |
| 7894 | resolved "https://registry.npm.taobao.org/path-type/download/path-type-1.1.0.tgz#59c44f7ee491da704da415da5a4070ba4f8fe441" | 7934 | resolved "https://registry.npm.taobao.org/path-type/download/path-type-1.1.0.tgz#59c44f7ee491da704da415da5a4070ba4f8fe441" |
| @@ -8515,7 +8555,7 @@ react-input-autosize@^2.2.2: | @@ -8515,7 +8555,7 @@ react-input-autosize@^2.2.2: | ||
| 8515 | dependencies: | 8555 | dependencies: |
| 8516 | prop-types "^15.5.8" | 8556 | prop-types "^15.5.8" |
| 8517 | 8557 | ||
| 8518 | -react-intl@^2.8.0: | 8558 | +react-intl@^2.8.0, react-intl@^2.9.0: |
| 8519 | version "2.9.0" | 8559 | version "2.9.0" |
| 8520 | resolved "https://registry.npm.taobao.org/react-intl/download/react-intl-2.9.0.tgz#c97c5d17d4718f1575fdbd5a769f96018a3b1843" | 8560 | resolved "https://registry.npm.taobao.org/react-intl/download/react-intl-2.9.0.tgz#c97c5d17d4718f1575fdbd5a769f96018a3b1843" |
| 8521 | integrity sha1-yXxdF9RxjxV1/b1adp+WAYo7GEM= | 8561 | integrity sha1-yXxdF9RxjxV1/b1adp+WAYo7GEM= |
| @@ -8623,6 +8663,18 @@ react-redux@^7.0.2: | @@ -8623,6 +8663,18 @@ react-redux@^7.0.2: | ||
| 8623 | prop-types "^15.7.2" | 8663 | prop-types "^15.7.2" |
| 8624 | react-is "^16.9.0" | 8664 | react-is "^16.9.0" |
| 8625 | 8665 | ||
| 8666 | +react-redux@^7.0.3: | ||
| 8667 | + version "7.1.3" | ||
| 8668 | + resolved "https://registry.npm.taobao.org/react-redux/download/react-redux-7.1.3.tgz#717a3d7bbe3a1b2d535c94885ce04cdc5a33fc79" | ||
| 8669 | + integrity sha1-cXo9e746Gy1TXJSIXOBM3Foz/Hk= | ||
| 8670 | + dependencies: | ||
| 8671 | + "@babel/runtime" "^7.5.5" | ||
| 8672 | + hoist-non-react-statics "^3.3.0" | ||
| 8673 | + invariant "^2.2.4" | ||
| 8674 | + loose-envify "^1.4.0" | ||
| 8675 | + prop-types "^15.7.2" | ||
| 8676 | + react-is "^16.9.0" | ||
| 8677 | + | ||
| 8626 | react-router-dom@^5.0.0: | 8678 | react-router-dom@^5.0.0: |
| 8627 | version "5.0.1" | 8679 | version "5.0.1" |
| 8628 | resolved "https://registry.npm.taobao.org/react-router-dom/download/react-router-dom-5.0.1.tgz#ee66f4a5d18b6089c361958e443489d6bab714be" | 8680 | resolved "https://registry.npm.taobao.org/react-router-dom/download/react-router-dom-5.0.1.tgz#ee66f4a5d18b6089c361958e443489d6bab714be" |
| @@ -8683,6 +8735,16 @@ react-transition-group@^2.2.1, react-transition-group@^2.3.1, react-transition-g | @@ -8683,6 +8735,16 @@ react-transition-group@^2.2.1, react-transition-group@^2.3.1, react-transition-g | ||
| 8683 | prop-types "^15.6.2" | 8735 | prop-types "^15.6.2" |
| 8684 | react-lifecycles-compat "^3.0.4" | 8736 | react-lifecycles-compat "^3.0.4" |
| 8685 | 8737 | ||
| 8738 | +react-transition-group@^4.0.1: | ||
| 8739 | + version "4.3.0" | ||
| 8740 | + resolved "https://registry.npm.taobao.org/react-transition-group/download/react-transition-group-4.3.0.tgz#fea832e386cf8796c58b61874a3319704f5ce683" | ||
| 8741 | + integrity sha1-/qgy44bPh5bFi2GHSjMZcE9c5oM= | ||
| 8742 | + dependencies: | ||
| 8743 | + "@babel/runtime" "^7.5.5" | ||
| 8744 | + dom-helpers "^5.0.1" | ||
| 8745 | + loose-envify "^1.4.0" | ||
| 8746 | + prop-types "^15.6.2" | ||
| 8747 | + | ||
| 8686 | react-with-direction@^1.3.1: | 8748 | react-with-direction@^1.3.1: |
| 8687 | version "1.3.1" | 8749 | version "1.3.1" |
| 8688 | resolved "https://registry.npm.taobao.org/react-with-direction/download/react-with-direction-1.3.1.tgz#9fd414564f0ffe6947e5ff176f6132dd83f8b8df" | 8750 | resolved "https://registry.npm.taobao.org/react-with-direction/download/react-with-direction-1.3.1.tgz#9fd414564f0ffe6947e5ff176f6132dd83f8b8df" |
| @@ -8738,7 +8800,7 @@ reactstrap@^5.0.0: | @@ -8738,7 +8800,7 @@ reactstrap@^5.0.0: | ||
| 8738 | react-popper "^0.8.3" | 8800 | react-popper "^0.8.3" |
| 8739 | react-transition-group "^2.2.1" | 8801 | react-transition-group "^2.2.1" |
| 8740 | 8802 | ||
| 8741 | -reactstrap@^8.0.1: | 8803 | +reactstrap@^8.0.0, reactstrap@^8.0.1: |
| 8742 | version "8.2.0" | 8804 | version "8.2.0" |
| 8743 | resolved "https://registry.npm.taobao.org/reactstrap/download/reactstrap-8.2.0.tgz#10153163e45941b9397ffd6f5d3301b4bc83c215" | 8805 | resolved "https://registry.npm.taobao.org/reactstrap/download/reactstrap-8.2.0.tgz#10153163e45941b9397ffd6f5d3301b4bc83c215" |
| 8744 | integrity sha1-EBUxY+RZQbk5f/1vXTMBtLyDwhU= | 8806 | integrity sha1-EBUxY+RZQbk5f/1vXTMBtLyDwhU= |
| @@ -9134,6 +9196,11 @@ reselect@^3.0.1: | @@ -9134,6 +9196,11 @@ reselect@^3.0.1: | ||
| 9134 | resolved "https://registry.npm.taobao.org/reselect/download/reselect-3.0.1.tgz#efdaa98ea7451324d092b2b2163a6a1d7a9a2147" | 9196 | resolved "https://registry.npm.taobao.org/reselect/download/reselect-3.0.1.tgz#efdaa98ea7451324d092b2b2163a6a1d7a9a2147" |
| 9135 | integrity sha1-79qpjqdFEyTQkrKyFjpqHXqaIUc= | 9197 | integrity sha1-79qpjqdFEyTQkrKyFjpqHXqaIUc= |
| 9136 | 9198 | ||
| 9199 | +reselect@^4.0.0: | ||
| 9200 | + version "4.0.0" | ||
| 9201 | + resolved "https://registry.npm.taobao.org/reselect/download/reselect-4.0.0.tgz#f2529830e5d3d0e021408b246a206ef4ea4437f7" | ||
| 9202 | + integrity sha1-8lKYMOXT0OAhQIskaiBu9OpEN/c= | ||
| 9203 | + | ||
| 9137 | resolve-cwd@^2.0.0: | 9204 | resolve-cwd@^2.0.0: |
| 9138 | version "2.0.0" | 9205 | version "2.0.0" |
| 9139 | resolved "https://registry.npm.taobao.org/resolve-cwd/download/resolve-cwd-2.0.0.tgz#00a9f7387556e27038eae232caa372a6a59b665a" | 9206 | resolved "https://registry.npm.taobao.org/resolve-cwd/download/resolve-cwd-2.0.0.tgz#00a9f7387556e27038eae232caa372a6a59b665a" |
| @@ -10106,6 +10173,35 @@ strapi-plugin-content-type-builder@3.0.0-beta.17.8: | @@ -10106,6 +10173,35 @@ strapi-plugin-content-type-builder@3.0.0-beta.17.8: | ||
| 10106 | strapi-helper-plugin "3.0.0-beta.17.8" | 10173 | strapi-helper-plugin "3.0.0-beta.17.8" |
| 10107 | yup "^0.27.0" | 10174 | yup "^0.27.0" |
| 10108 | 10175 | ||
| 10176 | +strapi-plugin-documentation@3.0.0-beta.17.8: | ||
| 10177 | + version "3.0.0-beta.17.8" | ||
| 10178 | + resolved "https://registry.npm.taobao.org/strapi-plugin-documentation/download/strapi-plugin-documentation-3.0.0-beta.17.8.tgz#2386a803db44b60988a32c0ad62a604529964095" | ||
| 10179 | + integrity sha1-I4aoA9tEtgmIoywK1ipgRSmWQJU= | ||
| 10180 | + dependencies: | ||
| 10181 | + cheerio "^1.0.0-rc.2" | ||
| 10182 | + classnames "^2.2.6" | ||
| 10183 | + fs-extra "^8.0.1" | ||
| 10184 | + immutable "^3.8.2" | ||
| 10185 | + invariant "^2.2.4" | ||
| 10186 | + koa-static "^5.0.0" | ||
| 10187 | + lodash "^4.17.11" | ||
| 10188 | + moment "^2.24.0" | ||
| 10189 | + path-to-regexp "^3.0.0" | ||
| 10190 | + react "^16.9.0" | ||
| 10191 | + react-copy-to-clipboard "^5.0.1" | ||
| 10192 | + react-dom "^16.9.0" | ||
| 10193 | + react-intl "^2.9.0" | ||
| 10194 | + react-redux "^7.0.3" | ||
| 10195 | + react-router "^5.0.0" | ||
| 10196 | + react-router-dom "^5.0.0" | ||
| 10197 | + react-transition-group "^4.0.1" | ||
| 10198 | + reactstrap "^8.0.0" | ||
| 10199 | + redux "^4.0.1" | ||
| 10200 | + redux-immutable "^4.0.0" | ||
| 10201 | + reselect "^4.0.0" | ||
| 10202 | + strapi-helper-plugin "3.0.0-beta.17.8" | ||
| 10203 | + swagger-ui-dist "3.22.1" | ||
| 10204 | + | ||
| 10109 | strapi-plugin-email@3.0.0-beta.17.8: | 10205 | strapi-plugin-email@3.0.0-beta.17.8: |
| 10110 | version "3.0.0-beta.17.8" | 10206 | version "3.0.0-beta.17.8" |
| 10111 | resolved "https://registry.npm.taobao.org/strapi-plugin-email/download/strapi-plugin-email-3.0.0-beta.17.8.tgz#3ab920657bddf5aa52ab10a6c9bf511a35c40198" | 10207 | resolved "https://registry.npm.taobao.org/strapi-plugin-email/download/strapi-plugin-email-3.0.0-beta.17.8.tgz#3ab920657bddf5aa52ab10a6c9bf511a35c40198" |
| @@ -10515,6 +10611,11 @@ svgo@^1.0.5: | @@ -10515,6 +10611,11 @@ svgo@^1.0.5: | ||
| 10515 | unquote "~1.1.1" | 10611 | unquote "~1.1.1" |
| 10516 | util.promisify "~1.0.0" | 10612 | util.promisify "~1.0.0" |
| 10517 | 10613 | ||
| 10614 | +swagger-ui-dist@3.22.1: | ||
| 10615 | + version "3.22.1" | ||
| 10616 | + resolved "https://registry.npm.taobao.org/swagger-ui-dist/download/swagger-ui-dist-3.22.1.tgz#a7a4ebc5af5d28f7c9e1436be9a9258f5d23497e" | ||
| 10617 | + integrity sha1-p6Trxa9dKPfJ4UNr6aklj10jSX4= | ||
| 10618 | + | ||
| 10518 | switchback@^2.0.1: | 10619 | switchback@^2.0.1: |
| 10519 | version "2.0.5" | 10620 | version "2.0.5" |
| 10520 | resolved "https://registry.npm.taobao.org/switchback/download/switchback-2.0.5.tgz#2f50c91118f659c42e03c0f2bdb094f868c45336" | 10621 | resolved "https://registry.npm.taobao.org/switchback/download/switchback-2.0.5.tgz#2f50c91118f659c42e03c0f2bdb094f868c45336" |