Documentation

A tela Documentation exibe todos os serviços do(s) mesh(es) selecionado(s) que possuem documentação (Swagger) cadastrada, facilitando o gerenciamento e a visualização dessas documentações.

Ela pode ser acessada pelo menu principal do Sensedia Service Mesh, como mostra a figura abaixo:

documentations listing
Tela "Documentation" listando os serviços que possuem documentação cadastrada
Você pode selecionar o cluster que deseja operar no campo Cluster:, localizado no canto superior direito da tela.
O cadastro ou a exclusão da documentação de um serviço específico são realizados a partir da aba "Documentation" desse microsserviço, acessível por meio da tela "Services".

  • Para poder visualizar a listagem dos serviços com documentação cadastrada, é necessário que seu usuário tenha ao menos a permissão List Documentations ativada no Sensedia Access Control.

  • Para poder visualizar as documentações cadastradas, é necessário que seu usuário possua a permissão Read Documentations.

Visualização das documentações cadastradas

Para visualizar documentações de microsserviços cadastradas no Sensedia Service Mesh, selecione um ou mais meshes no campo Mesh, localizado no canto superior esquerdo da tela Documentation.

Os serviços do(s) mesh(es) selecionado(s) com documentação cadastrada serão listados em ordem alfabética — crescente por padrão, mas é possível selecionar ordenação decrescente no campo Sort.

Para cada serviço da lista (linha), as seguintes informações são exibidas (colunas):

  • NAME: Nome do serviço;

  • MESH: Mesh do qual faz parte;

  • ACTIONS: Contém o seguinte botão:

    • icon view: Quando clicado, abre a documentação em uma nova aba do seu navegador.

Thanks for your feedback!
EDIT
How useful was this article to you?