@tocca-systems/twp-cli 0.17.0 → 0.18.0

package/command-model/note.json

@@ -7,7 +7,7 @@
       "operationId": "note.store",
       "method": "POST",
       "path": "/v2/notes",
-      "summary": "",
+      "summary": "ノートを作成",
       "pathParams": [],
       "queryParams": [],
       "body": {
@@ -135,7 +135,7 @@
       "operationId": "note.destroy",
       "method": "DELETE",
       "path": "/v2/notes/{id}",
-      "summary": "",
+      "summary": "ノートを削除",
       "pathParams": [
         {
           "name": "id",
@@ -156,7 +156,7 @@
       "operationId": "note.show",
       "method": "GET",
       "path": "/v2/notes/{id}",
-      "summary": "",
+      "summary": "ノート詳細を取得",
       "pathParams": [
         {
           "name": "id",
@@ -192,43 +192,49 @@
       "operationId": "note.index",
       "method": "GET",
       "path": "/v2/notes",
-      "summary": "",
+      "summary": "ノート一覧を取得",
       "pathParams": [],
       "queryParams": [
         {
           "name": "sort_by",
           "type": "string",
           "required": false,
+          "description": "並び順（manual / created_at / updated_at / view_count / comment_count / reaction_count）",
           "source": "spec"
         },
         {
           "name": "status",
           "type": "string",
           "required": false,
+          "description": "状態で絞り込む（draft / published）",
           "source": "spec"
         },
         {
           "name": "category_id",
           "type": "string",
           "required": false,
+          "description": "カテゴリIDで絞り込む",
           "source": "spec"
         },
         {
           "name": "tag",
           "type": "string",
           "required": false,
+          "description": "タグで絞り込む",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "visibility",
           "type": "string",
           "required": false,
+          "description": "公開範囲で絞り込む（private / tenant / external / public）",
           "source": "spec"
         },
         {
@@ -242,6 +248,7 @@
           "name": "created_by",
           "type": "string",
           "required": false,
+          "description": "作成者のユーザーIDで絞り込む",
           "source": "spec"
         },
         {
@@ -250,6 +257,20 @@
           "required": false,
           "description": "1ページあたりの件数",
           "source": "curation"
+        },
+        {
+          "name": "mine",
+          "type": "boolean",
+          "required": false,
+          "description": "true で自分が作成したノートだけにする",
+          "source": "curation"
+        },
+        {
+          "name": "is_favorited",
+          "type": "boolean",
+          "required": false,
+          "description": "true でお気に入りに登録したノートだけにする",
+          "source": "curation"
         }
       ],
       "body": null,
@@ -263,19 +284,21 @@
       "operationId": "note.publicNotes",
       "method": "GET",
       "path": "/v2/notes/public",
-      "summary": "",
+      "summary": "公開ノート一覧を取得",
       "pathParams": [],
       "queryParams": [
         {
           "name": "tag",
           "type": "string",
           "required": false,
+          "description": "タグで絞り込む",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
@@ -373,25 +396,28 @@
       "operationId": "note.subscribed",
       "method": "GET",
       "path": "/v2/notes/subscribed",
-      "summary": "",
+      "summary": "購読しているノートの一覧を取得",
       "pathParams": [],
       "queryParams": [
         {
           "name": "tenant_id",
           "type": "string",
           "required": false,
+          "description": "発行元のテナントで絞り込む",
           "source": "spec"
         },
         {
           "name": "tag",
           "type": "string",
           "required": false,
+          "description": "タグで絞り込む",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
@@ -420,7 +446,7 @@
       "operationId": "note.tags",
       "method": "GET",
       "path": "/v2/notes/tags",
-      "summary": "",
+      "summary": "ノートのタグ一覧を取得",
       "pathParams": [],
       "queryParams": [
         {
@@ -449,7 +475,7 @@
       "operationId": "note.update",
       "method": "PUT",
       "path": "/v2/notes/{id}",
-      "summary": "",
+      "summary": "ノートを更新",
       "pathParams": [
         {
           "name": "id",

package/command-model/notification.json

@@ -146,6 +146,41 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "read_status",
+          "type": "string",
+          "required": false,
+          "description": "既読状態で絞り込む（unread / read）。付けるとカーソル方式で返る",
+          "source": "curation"
+        },
+        {
+          "name": "reaction_status",
+          "type": "string",
+          "required": false,
+          "description": "対応状況で絞り込む（unreacted / in_progress / done）。付けるとカーソル方式で返る",
+          "source": "curation"
+        },
+        {
+          "name": "category",
+          "type": "string",
+          "required": false,
+          "description": "通知カテゴリで絞り込む（カーソル方式のとき）",
+          "source": "curation"
+        },
+        {
+          "name": "action_required",
+          "type": "boolean",
+          "required": false,
+          "description": "true で要対応（未読、または既読で未対応）の通知だけにする",
+          "source": "curation"
+        },
+        {
+          "name": "search_keyword",
+          "type": "string",
+          "required": false,
+          "description": "キーワードで絞り込む",
+          "source": "curation"
         }
       ],
       "body": null,

package/command-model/private-task.json

@@ -186,18 +186,21 @@
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "sort_column",
           "type": "string",
           "required": false,
+          "description": "並べ替える列（subject / status / priority / due_date / updated_at）。カンマ区切りで3列まで",
           "source": "spec"
         },
         {
           "name": "sort_direction",
           "type": "string",
           "required": false,
+          "description": "asc / desc。sort_column と同じ順にカンマ区切りで並べる",
           "source": "spec"
         },
         {
@@ -213,10 +216,52 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "status_id",
+          "type": "string",
+          "required": false,
+          "description": "ステータスIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "exclude_status_ids",
+          "type": "string",
+          "required": false,
+          "description": "除外するステータスID（カンマ区切り）",
+          "source": "curation"
+        },
+        {
+          "name": "type_id",
+          "type": "string",
+          "required": false,
+          "description": "種別IDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "category_id",
+          "type": "string",
+          "required": false,
+          "description": "カテゴリIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "label_ids",
+          "type": "string",
+          "required": false,
+          "description": "ラベルIDで絞り込む（カンマ区切り）",
+          "source": "curation"
+        },
+        {
+          "name": "priority",
+          "type": "string",
+          "required": false,
+          "description": "優先度で絞り込む（1 高 / 2 中 / 3 低）",
+          "source": "curation"
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },

package/command-model/project-member.json

@@ -194,6 +194,7 @@
           "name": "role",
           "type": "string",
           "required": false,
+          "description": "プロジェクト内の役割で絞り込む",
           "source": "spec"
         },
         {
@@ -212,7 +213,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "list",
       "risk": "read",
       "aliases": []
     },

package/command-model/project-task-comment.json

@@ -285,7 +285,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },

package/command-model/project-task.json

@@ -39,7 +39,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },
@@ -534,18 +534,21 @@
           "name": "format",
           "type": "string",
           "required": false,
+          "description": "出力形式（csv / xlsx）",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "recurrence_type",
           "type": "string",
           "required": false,
+          "description": "繰り返し周期で絞り込む（一覧と同じ値）",
           "source": "spec"
         },
         {
@@ -561,6 +564,62 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "status_id",
+          "type": "string",
+          "required": false,
+          "description": "ステータスIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "type_id",
+          "type": "string",
+          "required": false,
+          "description": "種別IDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "category_id",
+          "type": "string",
+          "required": false,
+          "description": "カテゴリIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "version_id",
+          "type": "string",
+          "required": false,
+          "description": "バージョンIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "milestone_id",
+          "type": "string",
+          "required": false,
+          "description": "マイルストーンIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "label_ids",
+          "type": "string",
+          "required": false,
+          "description": "ラベルIDで絞り込む（カンマ区切り）",
+          "source": "curation"
+        },
+        {
+          "name": "assignee_id",
+          "type": "string",
+          "required": false,
+          "description": "担当者のユーザーIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "created_by",
+          "type": "string",
+          "required": false,
+          "description": "起票者のユーザーIDで絞り込む",
+          "source": "curation"
         }
       ],
       "body": null,
@@ -739,42 +798,49 @@
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "sort_column",
           "type": "string",
           "required": false,
+          "description": "並べ替える列（key / subject / assignee / type / status / priority / dueDate / category / version / milestone / updatedAt）。カンマ区切りで3列まで",
           "source": "spec"
         },
         {
           "name": "sort_direction",
           "type": "string",
           "required": false,
+          "description": "asc / desc。sort_column と同じ順にカンマ区切りで並べる",
           "source": "spec"
         },
         {
           "name": "condition",
           "type": "string",
           "required": false,
+          "description": "状態で絞り込む（overdue＝期限切れ / stagnant＝停滞 / risk＝リスクあり）",
           "source": "spec"
         },
         {
           "name": "completed_from",
           "type": "string",
           "required": false,
+          "description": "完了日がこの日以降（YYYY-MM-DD・日本時間）",
           "source": "spec"
         },
         {
           "name": "completed_to",
           "type": "string",
           "required": false,
+          "description": "完了日がこの日以前（YYYY-MM-DD・日本時間）",
           "source": "spec"
         },
         {
           "name": "recurrence_type",
           "type": "string",
           "required": false,
+          "description": "繰り返し周期で絞り込む（daily / weekly / monthly / quarterly / half_yearly / yearly。any で周期ありすべて）",
           "source": "spec"
         },
         {
@@ -790,10 +856,87 @@
           "required": false,
           "description": "次ページの取得に使うカーソル",
           "source": "curation"
+        },
+        {
+          "name": "status_id",
+          "type": "string",
+          "required": false,
+          "description": "ステータスIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "exclude_status_ids",
+          "type": "string",
+          "required": false,
+          "description": "除外するステータスID（カンマ区切り）",
+          "source": "curation"
+        },
+        {
+          "name": "type_id",
+          "type": "string",
+          "required": false,
+          "description": "種別IDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "category_id",
+          "type": "string",
+          "required": false,
+          "description": "カテゴリIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "version_id",
+          "type": "string",
+          "required": false,
+          "description": "バージョンIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "milestone_id",
+          "type": "string",
+          "required": false,
+          "description": "マイルストーンIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "label_ids",
+          "type": "string",
+          "required": false,
+          "description": "ラベルIDで絞り込む（カンマ区切り）",
+          "source": "curation"
+        },
+        {
+          "name": "assignee_id",
+          "type": "string",
+          "required": false,
+          "description": "担当者のユーザーIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "created_by",
+          "type": "string",
+          "required": false,
+          "description": "起票者のユーザーIDで絞り込む",
+          "source": "curation"
+        },
+        {
+          "name": "priority",
+          "type": "string",
+          "required": false,
+          "description": "優先度で絞り込む（1 高 / 2 中 / 3 低）",
+          "source": "curation"
+        },
+        {
+          "name": "exclude_subtasks",
+          "type": "boolean",
+          "required": false,
+          "description": "true で子タスクを除く",
+          "source": "curation"
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },
@@ -810,36 +953,42 @@
           "name": "scope",
           "type": "string",
           "required": false,
+          "description": "表示範囲（me＝自分の活動・既定 / all＝テナント全体）",
           "source": "spec"
         },
         {
           "name": "keyword",
           "type": "string",
           "required": false,
+          "description": "キーワードで絞り込む",
           "source": "spec"
         },
         {
           "name": "date_from",
           "type": "string",
           "required": false,
+          "description": "この日以降の活動（YYYY-MM-DD）",
           "source": "spec"
         },
         {
           "name": "date_to",
           "type": "string",
           "required": false,
+          "description": "この日以前の活動（YYYY-MM-DD）",
           "source": "spec"
         },
         {
           "name": "action",
           "type": "string",
           "required": false,
+          "description": "操作の種類で絞り込む",
           "source": "spec"
         },
         {
           "name": "entity_type",
           "type": "string",
           "required": false,
+          "description": "対象の種類で絞り込む（既定はすべて）",
           "source": "spec"
         },
         {
@@ -923,7 +1072,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },
@@ -1227,7 +1376,7 @@
         }
       ],
       "body": null,
-      "resultPath": null,
+      "resultPath": "items",
       "risk": "read",
       "aliases": []
     },