ncaron
/
ad
mirror of https://gitlab.com/mobicoop/v3/service/ad.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
sbriat 2023-06-27 14:14:14 +02:00
parent 3a90345d3e
commit 6c94330003
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -136,7 +136,7 @@ The app exposes the following [gRPC](https://grpc.io/) services :
```json ```json
{ {
"userUuid": "80c9bb02-0931-4a1d-bea6-22d358992245", "userId": "80c9bb02-0931-4a1d-bea6-22d358992245",
"passenger": true, "passenger": true,
"seatsPassenger": 1, "seatsPassenger": 1,
"frequency": "RECURRRENT", "frequency": "RECURRRENT",
@ -179,7 +179,7 @@ The app exposes the following [gRPC](https://grpc.io/) services :
- frequency: `PUNCTUAL` or `RECURRENT` - frequency: `PUNCTUAL` or `RECURRENT`
- fromDate: start date for recurrent ad, carpool date for punctual ad - fromDate: start date for recurrent ad, carpool date for punctual ad
- toDate: end date for recurrent ad, same as fromDate 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: - 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 - seatsProposed (optional): number of seats proposed as driver
- seatsRequested (optional): number of seats requested as passenger - seatsRequested (optional): number of seats requested as passenger
- strict (boolean, optional): if set to true, allow matching only with similar frequency ads - 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. Default values must be set in `.env` file.