From 048eba9423cfa307d5ad62157448be915c7d0319 Mon Sep 17 00:00:00 2001 From: sbriat Date: Mon, 24 Jul 2023 15:48:03 +0200 Subject: [PATCH] update readme --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index d515345..20a2200 100644 --- a/README.md +++ b/README.md @@ -48,24 +48,15 @@ npm run migrate The app exposes the following [gRPC](https://grpc.io/) services : -- **FindByUuid** : find a user by its uuid +- **FindById** : find a user by its id ```json { - "uuid": "80126a61-d128-4f96-afdb-92e33c75a3e1" + "id": "80126a61-d128-4f96-afdb-92e33c75a3e1" } ``` -- **FindAll** : find all users; you can use pagination with `page` (default:_1_) and `perPage` (default:_10_) - - ```json - { - "page": 1, - "perPage": 10 - } - ``` - -- **Create** : create a user (note that uuid is optional, a uuid will be automatically attributed if it is not provided) +- **Create** : create a user ```json { @@ -82,15 +73,15 @@ The app exposes the following [gRPC](https://grpc.io/) services : { "firstName": "Jezabel-Katarina", "email": "jezabel-katarina.doe@email.com", - "uuid": "30f49838-3f24-42bb-a489-8ffb480173ae" + "id": "30f49838-3f24-42bb-a489-8ffb480173ae" } ``` -- **Delete** : delete a user by its uuid +- **Delete** : delete a user by its id ```json { - "uuid": "80126a61-d128-4f96-afdb-92e33c75a3e1" + "id": "80126a61-d128-4f96-afdb-92e33c75a3e1" } ``` @@ -102,7 +93,7 @@ As mentionned earlier, RabbitMQ messages are sent after these events : - **Update** (message : the updated user informations) -- **Delete** (message : the uuid of the deleted user) +- **Delete** (message : the id of the deleted user) Various messages are also sent for logging purpose.