Skip to main content

Reference (Diátaxis)

Documentação técnica de referência. Descreve o sistema tal como é.

Público: Developers, integradores, administradores técnicos.

Regra: Preciso, completo, sem opinião. Estrutura consistente. Actualizado automaticamente quando possível.

Convenções

  • Título: nome do recurso/endpoint/componente
  • Formato tabular para parâmetros e opções
  • Exemplos de código em cada endpoint
  • Versionado (indicar desde que versão existe)

Conteúdo

  • API Reference (auto-gerado de OpenAPI/FastAPI)
  • Configurações de ambiente (.env vars)
  • Modelos de dados (schemas)
  • Permissões por role

Fonte

Auto-gerado via OpenAPI spec + manual para configs. Agregado pelo Docusaurus em guide.inallweb.com/booking/reference/.