Skip to content

Implementar validação de exemplos: scripts + testes que garantem que examples/ validam contra schemas/ #9

Description

@4lessandrodev

Visão geral

Tornar o contrato executável: todo exemplo deve ser um 'golden file' validado automaticamente.

Contexto

Comunidade contribui mais quando existe feedback rápido. Exemplos validados são a forma mais simples de garantir que contratos são claros e consistentes.

Descrição

Implementar scripts/validate_examples.ts usando AJV:

  • Mapear arquivos em examples/** para o schema correspondente.
  • Validar e falhar com mensagens claras (qual arquivo, qual erro, qual schema).
  • Incluir pnpm test rodando validate_examples.

Definir convenção de mapeamento:

  • examples/search/*.json valida contra schemas/search/search_response.schema.json
  • examples/catalog/*.json valida contra schemas/catalog/catalog_meta.schema.json
  • examples/logs/*.json valida contra schemas/observability/log_event.schema.json

Adicionar pelo menos 1 exemplo por categoria.

Impacto

Evita contratos ambíguos. Reduz bugs em consumidores. Melhora qualidade e confiança da comunidade.

Referências

Definição de pronto

  • Script criado e integrado em pnpm test
  • Exemplos existentes passam na validação
  • Mensagens de erro são acionáveis (arquivo + caminho do schema + detalhe do erro)

Tags

  • priority:high
  • type:feature
  • area:tooling
  • area:tests

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions