From 12c237b980df4af9d494359ef3d0b8974aa7c75f Mon Sep 17 00:00:00 2001 From: Romain Thouvenin Date: Fri, 10 May 2024 11:06:40 +0200 Subject: [PATCH] Update the README doc --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 079a439..b360896 100644 --- a/README.md +++ b/README.md @@ -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 - 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 ```json @@ -246,13 +249,16 @@ The app exposes the following [gRPC](https://grpc.io/) services : 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) ### Emitted 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) ## Tests / ESLint / Prettier