Merge pull request #797 from isucon/fix-docs

ドキュメント更新

docs/ISURIDE.md

@@ -30,6 +30,7 @@ ISURIDEでは、チェアオーナーが提供する椅子をユーザーがア
 ### ユーザー（user）
 - ISURIDEアプリを利用して実際に移動する人です。
 - ユーザーは在住している地域内での移動を目的としてISURIDEを利用します。
+- ユーザーは他者の招待コード経由で新規登録することで、クーポン特典を受けられます。
 
 ### 椅子（chair）
 - ユーザーを載せて移動する自律運転式の椅子です。
@@ -54,6 +55,7 @@ ISURIDEでは、チェアオーナーが提供する椅子をユーザーがア
     - 割り当てられた椅子が乗車位置に早く到着しそうかどうか（乗車位置に近い椅子が割り当てられていたり、遠くても速い椅子が割り当てられている場合が好ましい）
     - 椅子が割り当てられてから、ユーザーが乗車できるまでの時間
     - ユーザーが乗車してから目的地に到着するまでの時間
+- 配車依頼にかかる運賃は、クーポンを使用しない場合、`500(固定利用料金) + 乗車位置と目的地間の距離 * 100`円です。rideに対して評価を行った時点でユーザーに請求されます。
 
 配車依頼は、 `MATCHING`, `ENROUTE`, `PICKUP`, `CARRYING`, `ARRIVED`, `COMPLETED` の6つの状態を持ちます。
 
@@ -70,6 +72,20 @@ stateDiagram-v2
   COMPLETED --> [*]: 次の配車依頼が作成されるまで（MATCHINGになるまで）はCOMPLETEDの状態が継続
 ```
 
+### クーポン (coupon)
+- ユーザーはクーポンを付与されることで運賃の割引を受けられます。
+- ユーザーに付与されている未使用のクーポンは、次回以降の配車依頼において付与された順番に必ず使用されます。
+- クーポンによる割引は、固定利用料金を除いた運賃に適用されます。1回の配車依頼で使い切れなかった余剰分は破棄されます。
+- 現在、ユーザーはクーポンを以下方法で受け取ることができます。
+  - 新規登録キャンペーン
+    - 本日以降の新規登録ユーザーは初回配車依頼に使える最大3000円引きクーポンが必ず付与されます
+  - 知り合い招待(招待する側)
+    - 自身の招待コードを経由して他者が新規登録した場合、招待したユーザーに1000円引きクーポンが付与されます。
+    - 招待は最大3人まで行うことができます。
+  - 知り合い招待(招待される側)
+    - 他者の招待コードを経由して新規登録したユーザーは、1500円引きクーポンが付与されます。
+    - 新規登録キャンペーンによるクーポンも同時に受け取ることになりますが、新規登録キャンペーンによるクーポンの方が優先して使用されます。
+
 ## 通知エンドポイント
 ISURIDEではクライアントに配車状態の変化を通知するための2つのエンドポイントが実装されています。
 - ユーザー向け通知： `/api/app/notification`

webapp/payment_mock/openapi.yaml

@@ -3,7 +3,7 @@ info:
   version: "1.0"
   title: isu payment gateway
 servers:
-  - url: "http://localhost:8081/"
+  - url: "http://localhost:12345/"
     description: api
 paths:
   /payments: