agente documentação

2026-08-12 15:26:26 -03:00 · 2026-08-12 15:26:26 -03:00 · 5f11352ab7
commit 5f11352ab7
parent b92dc7b06e
11 changed files with 239 additions and 158 deletions
--- a/DOCUMENTACAO/contratos/_template-contrato
+++ b/DOCUMENTACAO/contratos/_template-contrato
@ -1,70 +0,0 @@
---
-type: template
-name: _template-contrato
-description: Template para definição de contratos de API e schemas
-updatedAt: "2026-08-12"
---
-
-# Contrato: <PREENCHER NOME DO SERVIÇO OU DOMÍNIO>
-
-## Serviço
-<Nome e breve descrição do serviço ou microsserviço responsável por esta API>
-
-## Base URL
-`<URL base de desenvolvimento e/ou produção>`
-
-## Autenticação
-<Como autenticar? Token Bearer, API Key, sem auth?>
-
-## Endpoints
-
-| Método | Rota | Descrição | Auth |
-| :--- | :--- | :--- | :--- |
-| `GET` | `/rota/exemplo` | `<Descrição>` | `Sim/Não` |
-| `POST` | `/rota/exemplo` | `<Descrição>` | `Sim/Não` |
-
---
-
-## Detalhamento por Endpoint
-
-### `<MÉTODO>` `<ROTA>`
-<Breve descrição adicional do endpoint>
-
-**Request Params**
- `param1` (tipo, obrigatório?): <descrição>
-
-**Body Schema**
-```json
-{
-  // Exemplo de body esperado
-}
-```
-
-**Response Schema (Sucesso)**
-```json
-{
-  // Exemplo de resposta 200/201
-}
-```
-
-**Códigos de Erro**
- `400 Bad Request`: <motivo>
- `404 Not Found`: <motivo>
-
---
-
-## Schema Zod de Referência
-<Adicionar fragmento de código Zod caso o projeto utilize validação via schema>
-```typescript
-// z.object({ ... })
-```
-
-## Exemplos de Uso
-<Comandos curl, snippets fetch ou scripts de exemplo>
-```bash
-curl -X GET ...
-```
-
-## Referências
-<Links para outras documentações, regras de negócio ou ADRs relacionadas>
- [...]