Changelog
Sistema de controle de versões e atualizações do sistema
Descrição
O sistema de changelog permite acompanhar todas as atualizações, melhorias e correções realizadas no sistema com as seguintes funcionalidades:
- Importação automática: Importa commits do git automaticamente
- Revisão manual: Permite ao administrador revisar antes de publicar
- CRUD completo: Criar, editar, excluir e listar changelogs
- Categorias: Nova Funcionalidade, Correção, Melhoria e Atualização
- Versionamento: Sistema de versionamento semântico (v1.0.0)
Detalhes do Endpoint
VERBO
GET
URL BASE
http://api.provista.dev.nabrasil.org.br/v1
ENDPOINT
/api/changelogs
Query Parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
| category | string | Filtrar por categoria: Nova Funcionalidade, Correção, Melhoria, Atualização |
| version | string | Filtrar por versão específica (ex: v1.0.0) |
| is_published | boolean | Filtrar por status de publicação (true/false) |
| date_from | date | Data inicial no formato YYYY-MM-DD |
| date_to | date | Data final no formato YYYY-MM-DD |
| per_page | integer | Número de itens por página (padrão: 12) |
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer {token} |
| Accept | application/json |
Exemplo de Requisição
GET /api/changelogs?category=Nova Funcionalidade&is_published=true&per_page=10
Headers:
Authorization: Bearer {seu_token_jwt}
Accept: application/jsonResposta - Sucesso 200
{
"success": true,
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"version": "v1.0.0",
"date": "2025-01-27",
"title": "Implementação do sistema de autenticação",
"description": "Sistema completo de autenticação JWT com login, logout e refresh token",
"category": "Nova Funcionalidade",
"is_published": true,
"git_commit_hash": "a1b2c3d4e5f6",
"created_at": "2025-01-27T10:00:00.000000Z",
"updated_at": "2025-01-27T10:00:00.000000Z"
},
{
"id": "223e4567-e89b-12d3-a456-426614174001",
"version": "v1.0.1",
"date": "2025-01-28",
"title": "Correção no fluxo de recuperação de senha",
"description": "Correção na validação de OTP durante o processo de reset de senha",
"category": "Correção",
"is_published": true,
"git_commit_hash": "b2c3d4e5f6a7",
"created_at": "2025-01-28T11:00:00.000000Z",
"updated_at": "2025-01-28T11:00:00.000000Z"
}
]
}Códigos de Resposta
| Código | Descrição |
|---|---|
| 200 | Changelogs listados com sucesso |
| 401 | Não autorizado - Token inválido ou ausente |
Endpoints Disponíveis
GET /api/changelogs
Listar todos os changelogs (com filtros opcionais)
GET /api/changelogs/{id}
Visualizar um changelog específico
POST /api/changelogs/sync-from-git
Sincronizar changelogs do git
POST /api/changelogs
Criar novo changelog manualmente
PUT /api/changelogs/{changelog}
Atualizar changelog existente
DELETE /api/changelogs/{changelog}
Excluir changelog
Categorias de Changelog
Nova Funcionalidade
Para novas funcionalidades e features implementadas no sistema
Correção
Para correções de bugs e problemas identificados
Melhoria
Para melhorias em funcionalidades existentes
Atualização
Para atualizações de dependências, documentação e chores