docs: swager update#44
Conversation
Add centralized swagger models in pkg/core/swagger_models.go to provide consistent API response structures. Update all handler Swagger annotations to reference these core models instead of generic gin.H responses. This improves API documentation clarity and ensures consistent response formats across all endpoints. Additionally, refactor version initialization in main.go to use a function and add WebSocket endpoint documentation.
…ntext info, and message versioning
There was a problem hiding this comment.
Sorry @oismaelash, your pull request is larger than the review limit of 150000 diff characters
|
🔴 👎 Esse aqui é justamente o anti-padrão: aponta para |
|
Obrigado pela contribuição! 🙏 Estamos fechando esta PR porque ela parte de um fork desatualizado e reintroduz o repositório quase inteiro (dezenas de arquivos: Se houver uma correção ou feature específica aqui que você acredita que ainda falta no projeto, por favor abra uma PR nova e focada (só os arquivos relevantes, a partir do branch atualizado) que teremos prazer em avaliar e integrar. Valeu pelo empenho! |
Description
Esta PR atualiza e melhora a documentação da API Swagger/OpenAPI do projeto. As mudanças incluem:
pkg/core/swagger_models.gopara melhor estruturação das respostas da APIdocs/swagger.yamlcom definições completas dos endpoints e modelosexample) nos campos das estruturas para melhor visualização no Swagger UIOs modelos estão organizados por funcionalidade e incluem:
Related Issue
Closes #(issue_number)
Type of Change
Testing
Screenshots (if applicable)
Checklist
Additional Notes
pkg/core/swagger_models.gopara facilitar a manutençãodocs/swagger.yamlé gerado automaticamente a partir das anotações no código Go/swagger/index.htmlou/api/docs