[openaudit-search-api] Documentação: README completo alinhado ao projeto (neutralidade, minimização, contrato e integração com catálogo)

[4lessandrodev]

Repo: openaudit-search-api

Tags: priority:medium type:docs area:docs

Visão geral

Garantir que qualquer contribuidor entenda o objetivo do serviço, limites éticos, como rodar e como integrar com o catálogo.

Contexto

O search-api é a porta de entrada do usuário e tende a receber inputs sensíveis. A documentação precisa deixar claro o que ele faz e o que ele não faz.

Descrição

Atualizar ou criar README contendo:

• Objetivo e escopo (não cruza fontes, não calcula anomalias)
• Endpoints /health e /search
• Contrato de resposta (sem query.raw por padrão)
• Como usar catalog.sqlite + catalog_meta.json
• Configuração por env
• Segurança: não logar q bruto e redaction
• Rate limit e paginação
• Testes e fixtures sintéticas
• Links para docs oficiais do projeto (Manifesto, Risk Policy, etc.) e LICENSE

Incluir exemplos de curl e exemplos de resposta conforme core-contracts.

Impacto

Onboarding rápido, menos PRs ruins, maior aderência ao manifesto/política de risco.

Referências

• https://github.com/OpenAudit-Brasil/openaudit-search-api/blob/main/README.md
• https://github.com/OpenAudit-Brasil/About/blob/main/MANIFESTO.md
• https://github.com/OpenAudit-Brasil/About/blob/main/RISK_POLICY.md
• https://github.com/OpenAudit-Brasil/About/blob/main/METHODOLOGY.md
• https://github.com/OpenAudit-Brasil/About/blob/main/SECURITY.md
• https://github.com/OpenAudit-Brasil/About/blob/main/CODE_OF_CONDUCT.md

Definição de pronto

• README cobre todos os tópicos listados
• Exemplos consistentes com core-contracts
• Instruções de execução local e via Docker funcionando
• Links para docs e licença incluídos