Skip to content

Contratos — Platform API

Contratos — Platform API

Documentação detalhada por recurso. Cada arquivo cobre:

  1. Endpoints (método + path)
  2. Auth
  3. Request: path/query params, body
  4. Response: schemas + exemplos reais
  5. Erros (HTTP + error slug + causa)
  6. Invariantes / regras de negócio
  7. Diagramas (quando aplicável)

Fonte de verdade dos contratos: anotações #[OA] nos controllers em classes/extensions/platform/controller/. Este texto humaniza e amplia o que openapi.yaml expõe — não substitui.

Endpoints

Recurso Status Doc
Identidade — /me Implementado me.md
Perfil do Usuário Implementado (feature flag) perfil.md
Identidade — /enrolments Implementado enrolments.md
Onboarding (questionário) Implementado (lake) onboarding.md
Roteiro / Estudo Implementado study.md
Desempenho / Métricas Implementado performance.md
Simulados — lista Implementado exam.md
Simulados — detalhe Implementado exam.md#detalhe
Flashcards Implementado flashcard.md
Caderno Implementado notebook.md
Notificações Mock (pendente domínio) notification.md
Dashboard Implementado dashboard.md
Retrospectiva de Conclusão Implementado retrospective.md
Estado de Interface do Aluno Em implementação user-state.md
Admin — Correção Implementado admin/corrections.md

Como ler

  • Status Implementado significa: o controller chama serviço de domínio real; payload reflete dados reais do usuário autenticado e da matrícula.
  • Status Mock significa: o endpoint retorna payload hardcoded até o serviço upstream ficar pronto. O contrato (shape) é estável mesmo assim — o frontend pode codificar contra o shape; só os valores serão substituídos.
  • Mudanças de contrato (shape) seguem o processo de ADR + revisão.

Referências cruzadas

Navigation

Type to search…

↑↓ navigate↵ selectEsc close