Skip to content

docs(swagger): documentação XML completa de endpoints e DTOs - #217

Merged
elson-vinicius-lopes merged 3 commits into
developfrom
docs/swagger-xml-completo
Aug 29, 2026
Merged

docs(swagger): documentação XML completa de endpoints e DTOs#217
elson-vinicius-lopes merged 3 commits into
developfrom
docs/swagger-xml-completo

Conversation

@elson-vinicius-lopes

Copy link
Copy Markdown
Collaborator

Resumo

Documentação XML completa do Swagger para 17 controllers (~64 endpoints), agrupados por tag de domínio: Parsing, Transformation, Catalog, Learning, Validation, Metrics, Logs.

  • GenerateDocumentationFile + IncludeXmlComments configurados no Swashbuckle
  • NoWarn CS1591 para membros internos não documentados
  • Comentários XML em PT-BR nos endpoints e DTOs públicos

Validação

  • dotnet build: 0 erros
  • dotnet test: 420/420 + 59/59 (XslSynth.Core.Tests)

🤖 Generated with Claude Code

elson-vinicius-lopes and others added 2 commits August 29, 2026 11:09
…upa por tag

- Habilita GenerateDocumentationFile no .csproj (NoWarn CS1591 para membros internos)
- Swashbuckle: IncludeXmlComments, descricao geral da API, agrupamento por tag de dominio
  (Parsing/Transformation/Catalog/Learning/Validation/Metrics/Logs)
- XML docs (summary/param/returns/response) em todos os 17 controllers e nos DTOs
  citados na tarefa (segmentMappings, FailureKind, GeneratedXslt via TransformationCandidate,
  campos de request/response menos obvios)

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

… docs (PR #217)

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@elson-vinicius-lopes
elson-vinicius-lopes merged commit b756630 into develop Aug 29, 2026
3 checks passed
@elson-vinicius-lopes
elson-vinicius-lopes deleted the docs/swagger-xml-completo branch August 29, 2026 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant