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
Tags
priority:high
type:feature
area:tooling
area:tests
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.tsusando AJV:examples/**para o schema correspondente.pnpm testrodando validate_examples.Definir convenção de mapeamento:
examples/search/*.jsonvalida contraschemas/search/search_response.schema.jsonexamples/catalog/*.jsonvalida contraschemas/catalog/catalog_meta.schema.jsonexamples/logs/*.jsonvalida contraschemas/observability/log_event.schema.jsonAdicionar 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
pnpm testTags
priority:hightype:featurearea:toolingarea:tests