diff --git a/backend/README.md b/backend/README.md index 85da7cc..1b4727f 100644 --- a/backend/README.md +++ b/backend/README.md @@ -82,8 +82,8 @@ hay una cuarta página. Para obtener un usuario se debe hacer un `GET` a la ruta `/api/v1/users/{id}` donde `{id}` es el ID del usuario a buscar, este ID puede ser el UUID del -usuario o el ID entregado por auth0, esto puede ser util si el frontend tiene -solamente acceso al ID entregado por auth0. +usuario o el ID entregado por Auth0, esto puede ser util si el frontend tiene +solamente acceso al ID entregado por Auth0. Si el ID de usuario existe, la siguiente sera la respuesta de la API @@ -186,8 +186,9 @@ para el modelo. ### Actualizar Para actualizar un usuario se debe enviar un `POST` a la -ruta `/api/v1/users/{id}` y en el cuerpo se debe indicar los campos a -actualizar. +ruta `/api/v1/users/{id}` donde `{id}` es el ID del usuario a buscar, este ID +puede ser el UUID del usuario o el ID entregado por Auth0, y en el cuerpo se +debe indicar los campos a actualizar. Por ejemplo para actualizar el nombre del usuario se envía el siguiente payload @@ -244,3 +245,17 @@ si esto es asi, hay que tomar en cuenta las limitaciones impuestas por Auth0, donde ciertos campos no se pueden cambiar al mismo tiempo, para más detalles, ver la [documentación de Auth0](https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id) + +### Eliminar + +Para eliminar a un usuario hay que enviar un `DELETE` a la +ruta `/api/v1/user/{id}` donde `{id}` es el ID del usuario a buscar, este ID +puede ser el UUID del usuario o el ID entregado por Auth0, esto puede ser util +si el frontend tiene solamente acceso al ID entregado por Auth0. + +Los usuarios eliminados podrán ser recuperados localmente, pero en auth0 serán +eliminados permanentemente y su asociación con restaurantes se perderá. + +La respuesta de la API al eliminar será un código `204` sin cuerpo, pero ante +cualquier error, principalmente proviniendo desde Auth0, se utilizará el cuerpo +de error definido al inicio.