From 6c94330003c9502158e955740e288b191270940d Mon Sep 17 00:00:00 2001 From: sbriat Date: Tue, 27 Jun 2023 14:14:14 +0200 Subject: [PATCH] update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5fe1dc6..84f8a3a 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ The app exposes the following [gRPC](https://grpc.io/) services : ```json { - "userUuid": "80c9bb02-0931-4a1d-bea6-22d358992245", + "userId": "80c9bb02-0931-4a1d-bea6-22d358992245", "passenger": true, "seatsPassenger": 1, "frequency": "RECURRRENT", @@ -179,7 +179,7 @@ The app exposes the following [gRPC](https://grpc.io/) services : - frequency: `PUNCTUAL` or `RECURRENT` - fromDate: start date for recurrent ad, carpool date for punctual ad - toDate: end date for recurrent ad, same as fromDate for punctual ad - - schedule: an object with the departure time for each carpooled day in the week + - schedule: an object with the departure time for each carpooled day in the week (only the carpooled day for punctual ad) - marginDurations (optional): an object with the margin duration (in seconds) for each carpooled day in the week, eg: { @@ -191,7 +191,7 @@ The app exposes the following [gRPC](https://grpc.io/) services : - seatsProposed (optional): number of seats proposed as driver - seatsRequested (optional): number of seats requested as passenger - strict (boolean, optional): if set to true, allow matching only with similar frequency ads - - waypoints: an array of addresses that represent the waypoints of the journey (only first and last waypoints are used for passenger ads). Note that positions **must** be consecutives + - waypoints: an array of addresses that represent the waypoints of the journey (only first and last waypoints are used for passenger ads). Note that positions are **required** and **must** be consecutives Default values must be set in `.env` file.