From d7bf293cf3f826835f0a4ea9a34ad5db322f058a Mon Sep 17 00:00:00 2001 From: CleilsonAndrade Date: Wed, 14 Aug 2024 16:03:43 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=91=20docs:=20added=20section=20to=20r?= =?UTF-8?q?ole?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16e047b..a3575c5 100644 --- a/README.md +++ b/README.md @@ -54,17 +54,17 @@ Template inicial para projetos em [**NestJS**](https://nestjs.com/) pré-configu - **Swagger themes** # 📍 Endpoints -| Endpoint | Resumo | Autenticação -|----------------------|------------------------------------------------------|---------------------- -| GET / | Responsável por ser o endpoint inicial | Não -| GET /auth/login | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim -| POST /users | Responsável por cadastrar o usuário| Não -| GET /users | Responsável por listar todos os usuários com paginação | Sim -| GET /users/:id | Responsável por buscar usuário, informando o ID | Sim -| PATCH /users/:id | Responsável por atualizar as informações de um usuário, informando o ID | Sim -| DELETE /users/:id | Responsável por desabilitar um usuário, informando o ID | Sim -| GET /health | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim -| GET /docs | Responsável por servir a documentação dos recursos da API | +| Endpoint | Resumo | Autenticação | Role +|----------------------|------------------------------------------------------|--------------------------|---------------------- +| GET / | Responsável por ser o endpoint inicial | Não | * +| GET /auth/login | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim | * +| POST /users | Responsável por cadastrar o usuário | Não | * +| GET /users | Responsável por listar todos os usuários com paginação | Sim | * +| GET /users/:id | Responsável por buscar usuário, informando o ID | Sim | * +| PATCH /users/:id | Responsável por atualizar as informações de um usuário, informando o ID | Sim | * +| DELETE /users/:id | Responsável por desabilitar um usuário, informando o ID | Sim | * +| GET /health | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim | * +| GET /docs | Responsável por servir a documentação dos recursos da API | Não | * # 🚀 Instalação ```bash