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

update readme

This commit is contained in:
sbriat 2023-07-24 15:48:03 +02:00
parent 248c141656
commit 048eba9423
1 changed files with 7 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -48,24 +48,15 @@ npm run migrate
The app exposes the following [gRPC](https://grpc.io/) services : 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 ```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_) - **Create** : create a user
```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)
```json ```json
{ {
@ -82,15 +73,15 @@ The app exposes the following [gRPC](https://grpc.io/) services :
{ {
"firstName": "Jezabel-Katarina", "firstName": "Jezabel-Katarina",
"email": "jezabel-katarina.doe@email.com", "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 ```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) - **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. Various messages are also sent for logging purpose.