@tocca-systems/twp-cli 0.14.0 → 0.15.0

package/command-model/equipment.json

@@ -0,0 +1,614 @@
+{
+  "domain": "equipment",
+  "operations": [
+    {
+      "name": "available-options",
+      "domain": "equipment",
+      "operationId": "equipment.availableOptions",
+      "method": "GET",
+      "path": "/v2/equipment/available-options",
+      "summary": "貸出可能な備品をセレクトオプション形式で取得する（ワークフロー申請用）",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "category_ids",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "start_date",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "due_date",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "options",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "create",
+      "domain": "equipment",
+      "operationId": "equipment.store",
+      "method": "POST",
+      "path": "/v2/equipment",
+      "summary": "備品を登録する",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "category_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "management_code": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "available",
+                "lending",
+                "maintenance",
+                "retired",
+                null
+              ]
+            },
+            "image_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "location": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "has_camera": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "yes",
+                "no",
+                "unknown",
+                null
+              ]
+            },
+            "has_nfc": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "yes",
+                "no",
+                "unknown",
+                null
+              ]
+            },
+            "version": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            }
+          },
+          "required": [
+            "name"
+          ],
+          "title": "StoreEquipmentRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "dashboard",
+      "domain": "equipment",
+      "operationId": "equipment.dashboard",
+      "method": "GET",
+      "path": "/v2/equipment/dashboard",
+      "summary": "貸出状況ダッシュボードを取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "search",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "equipment",
+      "operationId": "equipment.destroy",
+      "method": "DELETE",
+      "path": "/v2/equipment/{id}",
+      "summary": "備品を削除する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "equipment",
+      "operationId": "equipment.show",
+      "method": "GET",
+      "path": "/v2/equipment/{id}",
+      "summary": "備品詳細を取得する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "lend",
+      "domain": "equipment",
+      "operationId": "equipment.lend",
+      "method": "POST",
+      "path": "/v2/equipment/{id}/lend",
+      "summary": "備品を貸し出す",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "borrower_id": {
+              "type": "string"
+            },
+            "borrower_name": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "lent_at": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "due_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            }
+          },
+          "required": [
+            "borrower_id"
+          ],
+          "title": "LendEquipmentRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "lendings",
+      "domain": "equipment",
+      "operationId": "equipment.lendings",
+      "method": "GET",
+      "path": "/v2/equipment/lendings",
+      "summary": "貸出一覧を取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "status",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "lendings",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "equipment",
+      "operationId": "equipment.index",
+      "method": "GET",
+      "path": "/v2/equipment",
+      "summary": "備品一覧を取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "equipment",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "manual-lend",
+      "domain": "equipment",
+      "operationId": "equipment.manualLend",
+      "method": "POST",
+      "path": "/v2/equipment/{id}/lending/manual",
+      "summary": "管理者が貸出情報（借用者・貸出期間）を手動で登録する（後追い反映）",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "borrower_id": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "borrower_name": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "lent_at": {
+              "type": "string",
+              "format": "date"
+            },
+            "due_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            }
+          },
+          "required": [
+            "lent_at"
+          ],
+          "title": "AdminLendEquipmentRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "my-lendings",
+      "domain": "equipment",
+      "operationId": "equipment.myLendings",
+      "method": "GET",
+      "path": "/v2/equipment/my-lendings",
+      "summary": "ログインユーザー本人が現在借用中の備品一覧を取得する",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "lendings",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "return-equipment",
+      "domain": "equipment",
+      "operationId": "equipment.returnEquipment",
+      "method": "POST",
+      "path": "/v2/equipment/lendings/{lendingId}/return",
+      "summary": "備品を返却する",
+      "pathParams": [
+        {
+          "name": "lendingId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "equipment",
+      "operationId": "equipment.update",
+      "method": "PUT",
+      "path": "/v2/equipment/{id}",
+      "summary": "備品を更新する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "category": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "category_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "management_code": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "available",
+                "lending",
+                "maintenance",
+                "retired",
+                null
+              ]
+            },
+            "image_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "location": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 255
+            },
+            "notes": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "has_camera": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "yes",
+                "no",
+                "unknown",
+                null
+              ]
+            },
+            "has_nfc": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "yes",
+                "no",
+                "unknown",
+                null
+              ]
+            },
+            "version": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            }
+          },
+          "title": "UpdateEquipmentRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}