From 1a6e67b9aee879d8388d599f21a1749027a4c073 Mon Sep 17 00:00:00 2001
From: motty <motty.mio2@gmail.com>
Date: Sun, 12 Nov 2023 21:07:59 +0900
Subject: [PATCH 1/2] update server api document

---
 doc/server/api.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 doc/server/api.md

diff --git a/doc/server/api.md b/doc/server/api.md
new file mode 100644
index 0000000..6f6ec40
--- /dev/null
+++ b/doc/server/api.md
@@ -0,0 +1,47 @@
+# API ドキュメント
+
+## /api/line
+
+- line API との通信用
+
+### /api/line/callback
+
+- line API から受け取った内容をもとに，イベント処理を行う
+- カルーセルや返信などは，内容に応じて分岐させている
+
+## /api/sensor
+
+- Arduino などのエッジデバイスからのデータを受け取る
+
+### /api/sensor POST
+
+- Arduino から Json でデータを受け取る
+    例：
+
+    ```json
+    {
+        "device_id": 1, // (デバイスID)[../arduino/include.md#config.h]
+        "session_id": "1a2b3c-...", // セッションID: UUID
+        "external_temperature": 20.0, // 外気温度
+        "external_humidity": 20.0,// 外気湿度
+        "interlnal_temperature": 20.0, // 靴内温度
+        "interlnal_humidity": 20.0,// 靴内湿度
+        "drying": 0, // 乾燥状態: true / false
+    }
+    
+    ```
+
+""
+
+## /api/session
+
+- セッション発行用API
+  - エッジデバイスからの要求を想定
+  - セッションIDを発行し，Lineに靴の乾燥の旨を通知
+  - `/api/session/?device_id=1`
+
+## /api/shoe
+
+- 靴検索用API
+  - 靴のid と靴の名前（部分一致）で可能
+  - `/api/shoe/?id=1?name=靴`

From e0bf282eaa82c711c118ecaa6764e71a9db41277 Mon Sep 17 00:00:00 2001
From: motty <motty.mio2@gmail.com>
Date: Thu, 16 Nov 2023 19:40:15 +0900
Subject: [PATCH 2/2] update server doc

---
 doc/server/api.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/server/api.md b/doc/server/api.md
index 6f6ec40..c32dd00 100644
--- a/doc/server/api.md
+++ b/doc/server/api.md
@@ -26,22 +26,30 @@
         "external_humidity": 20.0,// 外気湿度
         "interlnal_temperature": 20.0, // 靴内温度
         "interlnal_humidity": 20.0,// 靴内湿度
-        "drying": 0, // 乾燥状態: true / false
+        "drying": 0, // 乾燥状態: bool
     }
-    
     ```
 
-""
-
 ## /api/session
 
+- セッション関係のAPI
+
+### /api/session GET
+
 - セッション発行用API
   - エッジデバイスからの要求を想定
   - セッションIDを発行し，Lineに靴の乾燥の旨を通知
   - `/api/session/?device_id=1`
+  - device_id: required | int
 
 ## /api/shoe
 
+- 靴関係のAPI
+
+### /api/shoe GET
+
 - 靴検索用API
   - 靴のid と靴の名前（部分一致）で可能
   - `/api/shoe/?id=1?name=靴`
+  - id: optional | int
+  - name: optional | string