Afeta
Equipes que usam a documentação do Partners Hub. Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.
O que mudou
A documentação do Partners Hub foi reestruturada e ampliada para atender melhor aos parceiros de integração que constroem sobre a plataforma Lerian.
O que mudou
Primeiros passos
A introdução e o fluxo de onboarding foram reescritos para dar aos parceiros um caminho mais claro do primeiro contato até a integração em produção.Guias e templates
- O Template de guias foi ampliado com exemplos detalhados que cobrem padrões comuns de integração
- Um novo Template de referência de API traz uma estrutura de referência completa para parceiros que documentam as próprias APIs
Arquitetura e operações
A página Arquitetura e operações foi ampliada com mais orientações de infraestrutura e recomendações operacionais para parceiros que rodam produtos Lerian.Tratamento de erros
A documentação do Modelo de erros foi atualizada e consolidada. Páginas redundantes sobre erros (lista completa de erros, formato de erro, referência por endpoint) foram removidas em favor de uma referência única e completa.Novos guias do Flowker
Dois novos guias foram adicionados para ajudar parceiros que trabalham com orquestração de workflows:- Guia de design de workflows: Boas práticas para desenhar e estruturar workflows do Flowker
- Guia de observabilidade: Monitoramento, logs e tracing para deploys do Flowker
Limpeza da navegação
Várias páginas de placeholder e de pouco valor foram removidas (child-pages-ph, coding-standards, approval-process, auditability-traceability, authentication-authorization, data-lgpd, homologation-requirements), e a navegação foi simplificada para reduzir ruído e destacar o conteúdo mais útil.
Impacto
Esta é uma atualização de documentação. As integrações existentes não precisam de migração apenas por esta nota de release.
O que você precisa fazer
1
Revise a navegação atualizada do Partners Hub, as referências de operações e a documentação de erros.