Activar implementación de vista previa
Crea o actualiza una implementación de vista previa para una rama específica. Si ya existe una vista previa para la rama, se activa una reimplementación. Devuelve un ID de estado para hacer seguimiento del progreso y la URL de la vista previa.
Autentícate con una clave de API de administrador.
statusId que puedes pasar a Get deployment status para rastrear el progreso de la implementación.
Requisitos de la rama
branch debe existir en el repositorio conectado a tu proyecto de Mintlify. Las ramas de forks no son compatibles. La aplicación de GitHub de Mintlify debe estar instalada en un repositorio para generar una vista previa, por lo que no puede generar vistas previas a partir de ramas de forks. Consulta Solicitudes de extracción de forks para saber cómo previsualizar cambios de un fork.
Casos de uso
- Pipelines CI/CD: Crea automáticamente implementaciones de vista previa cuando se abren o actualizan solicitudes de extracción.
- Vistas previas programadas: Genera vistas previas de ramas de funcionalidades de larga duración de forma programada.
- Herramientas personalizadas: Integra la creación de vistas previas en flujos de trabajo internos o bots de Slack.
Acceso a las vistas previas
Límites de tasa
Autorizaciones
El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.
Parámetros de ruta
Cuerpo
El nombre de la rama de Git para la cual crear una implementación de vista previa.
1Respuesta
Implementación de vista previa puesta en cola correctamente.
El ID de estado para hacer seguimiento de la implementación de vista previa. Úsalo con el endpoint Get deployment status.
La URL donde se aloja la implementación de vista previa.
Temas relacionados
Implementaciones de vista previaNo se crea una implementación de vista previa para una rama de un forkDespliega en una subruta con AWS Route 53 y CloudFront