Documentation

La pantalla Documentation muestra todos los servicios de la(s) malla(s) seleccionada(s) que tienen documentación (Swagger) registrada, facilitando la gestión y visualización de estas documentaciones.

Se puede acceder a ella desde el menú principal de Sensedia Service Mesh, como se muestra en la siguiente imagen:

documentations listing
Pantalla "Documentation" con la lista de los servicios que tienen documentación registrada
Puede seleccionar el cluster que desea operar en el campo Cluster:, situado en la esquina superior derecha de la pantalla.
El registro o la eliminación de la documentación de un servicio específico se realizan desde la pestaña "Documentation" de este microservicio, accesible a través de la pantalla "Services".

  • Para ver la lista de servicios con documentación registrada, su usuario debe tener al menos el permiso List Documentations activado en Sensedia Access Control.

  • Para poder ver las documentaciones registradas, su usuario debe tener el permiso Read Documentations.

Visualización de las documentaciones registradas

Para ver la documentación de microservicios registradas en Sensedia Service Mesh, seleccione una o más mallas en el campo Mesh, situado en la esquina superior izquierda de la pantalla Documentation.

Los servicios de la(s) malla(s) seleccionada(s) con documentación registrada se listarán en orden alfabético — ascendente por defecto, pero puede seleccionar la ordenación descendente en el campo Sort.

Para cada servicio de la lista (fila), se muestra la siguiente información (columnas):

  • NAME: Nombre del servicio;

  • MESH: La malla a la que pertenece;

  • ACTIONS: Contiene el siguiente botón:

    • icon view: Cuando se hace clic, se abre la documentación en una nueva pestaña del navegador.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]