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

Update the README doc

This commit is contained in:
Romain Thouvenin 2024-05-10 11:06:40 +02:00
parent f6f9696620
commit 12c237b980
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -232,6 +232,9 @@ The app exposes the following [gRPC](https://grpc.io/) services :
- 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 - 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
- comment: optional freetext comment / description about the ad - comment: optional freetext comment / description about the ad
- **Update** : Replace the content of an ad
Accepts the same data as the `Create` function + an ad id, and replace the given ad with the given data.
- **Delete** : Delete permanently an ad - **Delete** : Delete permanently an ad
```json ```json
@ -246,13 +249,16 @@ The app exposes the following [gRPC](https://grpc.io/) services :
The service listens to these RabbitMQ messages: The service listens to these RabbitMQ messages:
- **matcher-ad.created** (to update the status of pending ads)
- **matcher-ad.creation-failed** (to update the status of pending ads)
- **user.deleted** (to delete the associated ads) - **user.deleted** (to delete the associated ads)
### Emitted ### Emitted
As mentionned earlier, RabbitMQ messages are sent after these events : As mentionned earlier, RabbitMQ messages are sent after these events :
- **ad.created** (message: the created ad informations) - **ad.created** (message: the created ad information)
- **ad.updated** (message: the updated ad information)
- **ad.deleted** (message: the id of the deleted ad) - **ad.deleted** (message: the id of the deleted ad)
## Tests / ESLint / Prettier ## Tests / ESLint / Prettier