From 6e81e3a52439399352a21bbae2b7ba50db523899 Mon Sep 17 00:00:00 2001 From: Alliana <56180684+Allianaab2m@users.noreply.github.com> Date: Wed, 31 Jul 2024 12:48:33 +0900 Subject: [PATCH 1/3] feat: add `PATCH /lists/{list_id}` specification --- src/endpoint/list.md | 64 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/src/endpoint/list.md b/src/endpoint/list.md index 97df2ba..581fb16 100644 --- a/src/endpoint/list.md +++ b/src/endpoint/list.md @@ -44,6 +44,70 @@ - `TITLE_TOO_LONG`: タイトルが長すぎます +## `PATCH /lists/{list_id}` + +リスト情報を編集します + +### 入力 + +- パスパラメータ + - `list_id`: `string` + - 編集したいリストのID + +- body: `application/json` + +| 項目名 | 型 | 説明 | 制約 | +| ------ | --------- | -------------------- | ------------- | +| title | `string` | リストのタイトル | 1≤N≤100[文字] | +| public | `boolean` | 公開・非公開のフラグ | | + +### 入力例 + +```json +{ + "title": "Edited Title", + "public": true +} +``` + +### 出力 + +**`200 OK`** + +```json +{ + "id": "18342938400393", + "title": "Edited Title", + "public": true, + "assigners": [ + { + "id": "1838933554", + "name": "@john@example.com" + } + ] +} +``` + +**`404 Not Found`** + +```json +{ + "error": "TEST_ERROR_CODE" +} +``` + +- `LIST_NOTFOUND`: リストが見つかりません + +**`400 Bad Request`** + +```json +{ + "error": "TEST_ERROR_CODE" +} +``` + +- `TITLE_TOO_LONG`: タイトルが長すぎます + ## `GET /lists/{list_id}` リスト情報を取得します From 16d5e6aa1c52a1c80f69de22d5ff183914f0b809 Mon Sep 17 00:00:00 2001 From: Alliana <56180684+Allianaab2m@users.noreply.github.com> Date: Wed, 31 Jul 2024 12:50:59 +0900 Subject: [PATCH 2/3] chore: format --- src/endpoint/list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/endpoint/list.md b/src/endpoint/list.md index 581fb16..e1242fc 100644 --- a/src/endpoint/list.md +++ b/src/endpoint/list.md @@ -53,7 +53,7 @@ - パスパラメータ - `list_id`: `string` - 編集したいリストのID - + - body: `application/json` | 項目名 | 型 | 説明 | 制約 | From d15e57e6fc5a762bba1a2872e3786b1a97baf32e Mon Sep 17 00:00:00 2001 From: Alliana <56180684+Allianaab2m@users.noreply.github.com> Date: Wed, 31 Jul 2024 13:15:29 +0900 Subject: [PATCH 3/3] fix: assigners -> assignees --- src/endpoint/list.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/endpoint/list.md b/src/endpoint/list.md index e1242fc..b2a9901 100644 --- a/src/endpoint/list.md +++ b/src/endpoint/list.md @@ -79,7 +79,7 @@ "id": "18342938400393", "title": "Edited Title", "public": true, - "assigners": [ + "assignees": [ { "id": "1838933554", "name": "@john@example.com" @@ -127,7 +127,7 @@ "id": "18342938400393", "title": "Pulsate Developers", "public": false, - "assigners": [ + "assignees": [ { "id": "1838933554", "name": "@john@example.com" @@ -166,7 +166,7 @@ "id": "18342938400393", "title": "Pulsate Developers", "public": false, - "assigners": [ + "assignees": [ { "id": "1838933554", "name": "@john@example.com"