Pular para conteúdo

GraphQL Docs

Esta e a superficie publica oficial de referencia GraphQL do Auraxis.

Objetivo

Oferecer uma referencia navegavel "tipo Swagger para GraphQL", segura para uso publico e util tanto para humanos quanto para agentes de IA.

Principios da superficie publica

  1. a documentacao publica e estatica;
  2. ela nao depende de tokens reais;
  3. ela nao executa requests reais em producao;
  4. exemplos e respostas devem ser mockados;
  5. a separacao entre operacoes publicas e privadas deve ficar explicita.

O que esta previsto para esta superficie

  • explorer do schema GraphQL;
  • tipos, queries e mutations por dominio;
  • exemplos de operacoes;
  • exemplos de variables;
  • respostas mockadas;
  • indicacao de auth por operacao.

Como ler os exemplos

  • a operation usa nomes reais do schema exportado;
  • variables e response sao sempre mockados;
  • nenhum exemplo depende de token funcional para ser entendido;
  • operacoes premium podem aparecer documentadas, mas continuam exigindo entitlement no runtime real.

O que fica fora da superficie publica

  • GraphiQL publico em producao;
  • Apollo Sandbox publico em producao;
  • tokens funcionais;
  • escrita ou leitura de dados reais a partir do portal.

Modelo de seguranca

O Auraxis usa um endpoint unico POST /graphql com operacoes publicas e privadas. Por isso, a documentacao publica precisa ser desacoplada do runtime real e operar sobre artefatos exportados offline.

Se no futuro existir um sandbox GraphQL interativo, ele sera uma superficie separada e protegida, nunca parte da documentacao publica aberta.

Status

Publicado via:

  • schema.graphql
  • graphql.introspection.json
  • graphql.operations.manifest.json

Fonte canônica

  • repos/auraxis-api/app/graphql/schema.py
  • repos/auraxis-api/app/graphql/authorization.py
  • .context/discovery/J16_documentacao_graphql_publica_estatica.md