@tocca-systems/twp-cli 0.14.0 → 0.15.0

package/command-model/onboarding-template.json

@@ -0,0 +1,706 @@
+{
+  "domain": "onboarding-template",
+  "operations": [
+    {
+      "name": "apply",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.apply",
+      "method": "POST",
+      "path": "/v2/onboarding-templates/{id}/apply",
+      "summary": "テンプレートをユーザーに適用（ProjectTask自動生成）",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "user_id": {
+              "type": "string"
+            },
+            "project_id": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "user_id",
+            "project_id"
+          ]
+        }
+      },
+      "resultPath": "tasks",
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "complete-module",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.completeModule",
+      "method": "POST",
+      "path": "/v2/onboarding-progress/{progressId}/modules/{moduleId}/complete",
+      "summary": "モジュールを完了としてマーク",
+      "pathParams": [
+        {
+          "name": "progressId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "moduleId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "create",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.store",
+      "method": "POST",
+      "path": "/v2/onboarding-templates",
+      "summary": "テンプレート作成",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "target_role": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "estimated_days": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 1,
+              "maximum": 365
+            },
+            "target_skill_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 100
+              },
+              "maxItems": 50
+            }
+          },
+          "required": [
+            "name"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.destroy",
+      "method": "DELETE",
+      "path": "/v2/onboarding-templates/{id}",
+      "summary": "テンプレート削除",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.show",
+      "method": "GET",
+      "path": "/v2/onboarding-templates/{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": "list",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.index",
+      "method": "GET",
+      "path": "/v2/onboarding-templates",
+      "summary": "テンプレート一覧",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "skill_id",
+          "type": [
+            "string",
+            "null"
+          ],
+          "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": "data",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "manager-dashboard",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.managerDashboard",
+      "method": "GET",
+      "path": "/v2/onboarding-dashboard/manager",
+      "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": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "module-destroy",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.moduleDestroy",
+      "method": "DELETE",
+      "path": "/v2/onboarding-templates/{templateId}/modules/{moduleId}",
+      "summary": "モジュール削除",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "moduleId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "module-index",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.moduleIndex",
+      "method": "GET",
+      "path": "/v2/onboarding-templates/{templateId}/modules",
+      "summary": "モジュール一覧",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "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": "data",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "module-reorder",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.moduleReorder",
+      "method": "PUT",
+      "path": "/v2/onboarding-templates/{templateId}/modules-reorder",
+      "summary": "モジュール並び替え",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "module_ids": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "minItems": 1
+            }
+          },
+          "required": [
+            "module_ids"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "module-store",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.moduleStore",
+      "method": "POST",
+      "path": "/v2/onboarding-templates/{templateId}/modules",
+      "summary": "モジュール作成",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "sort_order": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 0
+            },
+            "is_required": {
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
+            "estimated_minutes": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 1,
+              "maximum": 480
+            },
+            "completion_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "manual",
+                null
+              ]
+            },
+            "reference_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "target_path": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            }
+          },
+          "required": [
+            "title"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "module-update",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.moduleUpdate",
+      "method": "PUT",
+      "path": "/v2/onboarding-templates/{templateId}/modules/{moduleId}",
+      "summary": "モジュール更新",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "moduleId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "sort_order": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 0
+            },
+            "is_required": {
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
+            "estimated_minutes": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 1,
+              "maximum": 480
+            },
+            "completion_type": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "manual",
+                null
+              ]
+            },
+            "reference_url": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            },
+            "target_path": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            }
+          }
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "my-dashboard",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.myDashboard",
+      "method": "GET",
+      "path": "/v2/onboarding-dashboard/me",
+      "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": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "my-progress",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.myProgress",
+      "method": "GET",
+      "path": "/v2/onboarding-progress/me",
+      "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": "data",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "template-progress",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.templateProgress",
+      "method": "GET",
+      "path": "/v2/onboarding-templates/{templateId}/progress",
+      "summary": "テンプレートの適用状況一覧（管理者向け）",
+      "pathParams": [
+        {
+          "name": "templateId",
+          "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": "data",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.update",
+      "method": "PUT",
+      "path": "/v2/onboarding-templates/{id}",
+      "summary": "テンプレート更新",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "target_role": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 100
+            },
+            "estimated_days": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 1,
+              "maximum": 365
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "draft",
+                "active",
+                "archived",
+                null
+              ]
+            },
+            "target_skill_ids": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string",
+                "maxLength": 100
+              },
+              "maxItems": 50
+            }
+          }
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "user-progress",
+      "domain": "onboarding-template",
+      "operationId": "onboardingTemplate.userProgress",
+      "method": "GET",
+      "path": "/v2/onboarding-progress/user/{userId}",
+      "summary": "特定ユーザーのオンボーディング進捗一覧（管理者向け）",
+      "pathParams": [
+        {
+          "name": "userId",
+          "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": "data",
+      "risk": "read",
+      "aliases": []
+    }
+  ]
+}