Superfícies Públicas Oficiais

Esta página consolida as superfícies públicas e semi-públicas oficiais do ecossistema Auraxis.

Mapa oficial

Superfície	URL	Papel	Status
Site institucional	https://auraxis.com.br	aquisição, posicionamento, SEO e páginas públicas	oficial
Aplicação web	https://app.auraxis.com.br	produto autenticado e fluxos do usuário	oficial
Portal de docs	https://docs.auraxis.com.br	documentação oficial de produto, arquitetura e operação	oficial
API runtime	https://api.auraxis.com.br	runtime da API e integração entre canais	oficial
API docs oficiais	https://docs.auraxis.com.br/api/	referência pública de contratos e endpoints	oficial
GraphQL docs oficiais	https://docs.auraxis.com.br/graphql/	referência pública estática do schema GraphQL e catálogo mock-first	oficial
Design system	https://v1.design-system.auraxis.com.br	revisão visual contínua do frontend e design system	em implantação
App mobile	stores	aplicativo iOS/Android	ainda não publicado

Enquanto o domínio customizado não estiver ativo, o fallback operacional do portal é:

• https://italofelipe.github.io/auraxis-platform/

Política de documentação da API

A documentação pública oficial da API fica no portal de docs, a partir do snapshot OpenAPI versionado.

• URL oficial: https://docs.auraxis.com.br/api/
• artefato canônico: .context/openapi/openapi.snapshot.json
• origem do snapshot: endpoint runtime /docs/swagger/ da auraxis-api
• viewer público oficial: Scalar embutido em página estática do portal

O que NÃO é a fonte oficial

https://api.auraxis.com.br/docs não deve ser tratado como o portal público oficial da documentação.

Motivos:

1. o runtime da API não deve ser a única superfície de publicação da referência técnica;
2. a documentação oficial precisa ser estável, versionada e reproduzível mesmo quando a API estiver degradada;
3. a exposição do Swagger runtime em produção pública deve ser tratada separadamente, com política explícita de segurança.

Política para docs GraphQL

A documentação pública oficial de GraphQL deve viver no portal de docs, separada do runtime real:

• URL oficial alvo: https://docs.auraxis.com.br/graphql/
• artefatos canônicos: schema.graphql, graphql.introspection.json, graphql.operations.manifest.json e graphql.mock_examples.json
• origem dos artefatos: export offline a partir do schema da auraxis-api
• viewer público oficial: explorer estático alimentado por introspection exportada offline

O que a docs pública GraphQL deve mostrar

1. tipos, queries e mutations do schema;
2. auth esperada por operação (public, auth required e gates adicionais quando aplicável);
3. exemplos de query/mutation;
4. exemplos de variables;
5. respostas mockadas para referência;
6. notas de uso e indicação de entitlement quando aplicável.

O que a docs pública GraphQL NÃO deve fazer

1. não deve executar requests reais em produção;
2. não deve embutir tokens funcionais;
3. não deve expor playground público ligado ao endpoint real /graphql.

Sandbox interativo

Se o Auraxis vier a oferecer um sandbox GraphQL real no futuro, ele deve existir como superfície separada e protegida, nunca como parte da documentação pública.

Política para o design system

O Storybook/Chromatic oficial do Auraxis deve ser publicado em:

• https://v1.design-system.auraxis.com.br

Até o custom domain estar ativo, a URL nativa da Chromatic continua válida como fallback operacional.

Observações operacionais

1. o portal docs.auraxis.com.br é publicado pelo workflow Docs Portal;
2. o snapshot OpenAPI precisa ser sincronizado para o portal antes do build do MkDocs;
3. o runtime da API continua podendo expor /docs/swagger/ em dev/local para debugging e validação.
4. o repositório auraxis-platform usa GitHub Pages em modo workflow;
5. o domínio customizado não deve depender de commit automático de CNAME em branch protegida.