Referência de API

Esta seção contém a documentação automática gerada a partir das docstrings presentes no código-fonte Python do Onboarding Hub.

A estrutura de módulos documentados é a seguinte:

---

Estrutura de Pacotes

• Configurações: Configurações centrais do sistema obtidas através de variáveis de ambiente.
• Modelos: Modelos de dados Pydantic que regem o contrato de onboarding.
• Banco de Dados: Componentes para inicialização e conexão com os bancos de dados (PostgreSQL/Oracle).
• Mensageria: Produtores e consumidores Kafka para processamento orientado a eventos.
• Gerador Sintético: Utilitários de geração de massa de dados sintéticos para simulação de payloads.

---

Como escrever Docstrings

Para garantir que a documentação gerada via mkdocstrings seja elegante e legível, siga a convenção de formatação de docstrings do Google:

def function_name(param1: int, param2: str) -> bool:
    """Resumo curto de uma única linha.

    Explicação mais detalhada sobre o funcionamento da função
    e suas regras de negócio associadas.

    Args:
        param1: Descrição do primeiro parâmetro.
        param2: Descrição do segundo parâmetro.

    Returns:
        Descrição do valor de retorno.
    """