徐烜 / bsth-ebus-h5_editor · Commits

Commit cb6cf476c253eef2a7cb4cf50076a32b3491e1ca

Authored by ly525
1 parent 4e28516e

feat(docs): use strapi documentation plugin to generate api your documentation(s… 

…wagger ui); 使用strapi document plugin 自动生成API 文档(由swagger ui 驱动)
Inline Side-by-side
Showing 2 changed files with 1543 additions and 0 deletions

Too many changes to show.
Reload with full diff Plain diff Email patch

To preserve performance only 2 of 10 files are displayed.

back-end/h5-api/api/work/documentation/1.0.0/work.json 0 → 100644
  View file @cb6cf47
  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 975 \ No newline at end of file
... ...
back-end/h5-api/api/workform/documentation/1.0.0/workform.json 0 → 100644
  View file @cb6cf47
  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 570 \ No newline at end of file
... ...