Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion es.json
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"es/api/update/trigger",
"es/api/update/status"
"es/api/update/status",
"es/api/preview/trigger"
]
},
{
Expand Down
4 changes: 3 additions & 1 deletion es/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar

* [Trigger update](/es/api/update/trigger): Activa una actualización de tu sitio cuando quieras.
* [Get update status](/es/api/update/status): Obtén el estado de una actualización y otros detalles de tu documentación.
* [Trigger preview deployment](/es/api/preview/trigger): Crea o actualiza una implementación de vista previa para una rama específica.
* [Create agent job](/es/api/agent/v2/create-agent-job): Crea una tarea de agente para editar tu documentación automáticamente.
* [Get agent job](/es/api/agent/v2/get-agent-job): Obtén los detalles y el estado de una tarea de agente específica.
* [Send follow-up message](/es/api/agent/v2/send-message): Envía un mensaje de seguimiento a una tarea de agente existente.
Expand All @@ -28,6 +29,7 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar

* **Implementaciones automatizadas**: Activa actualizaciones del sitio a intervalos establecidos o cuando se produzcan eventos con [Trigger update](/es/api/update/trigger) y [Get update status](/es/api/update/status).
* **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/update/trigger).
* **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/preview/trigger).
* **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message-v2), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content).
* **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job) y [Send follow-up message](/es/api/agent/v2/send-message).
* **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).
Expand All @@ -44,7 +46,7 @@ Puedes crear hasta 10 API keys por hora y por organización.
### Clave de la API de administrador
</div>

Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).
Usa la clave de la API de administrador para autenticar solicitudes a [Trigger update](/es/api/update/trigger), [Get update status](/es/api/update/status), [Trigger preview deployment](/es/api/preview/trigger), [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job), [Send follow-up message](/es/api/agent/v2/send-message), [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).

Las claves de la API de administrador comienzan con el prefijo `mint_`.

Expand Down
28 changes: 28 additions & 0 deletions es/api/preview/trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Activar implementación de vista previa"
description: "Crea o actualiza una implementación de vista previa para una rama específica y revisa los cambios en la documentación antes de fusionarlos a producción."
openapi: "/es/openapi.json POST /project/preview/{projectId}"
keywords: ["preview", "preview deployment", "branch preview", "staging"]
---

<Info>
Las implementaciones de vista previa están disponibles en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=preview-deployments).
</Info>

Usa este endpoint para crear o actualizar de forma programática una implementación de vista previa para una rama de Git. Si ya existe una vista previa para la rama especificada, el endpoint activa una reimplementación en lugar de crear un duplicado.

La respuesta incluye un `statusId` que puedes pasar a [Get deployment status](/es/api/update/status) para rastrear el progreso de la implementación.

<div id="use-cases">
## Casos de uso
</div>

- **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.

<div id="rate-limits">
## Límites de tasa
</div>

Este endpoint permite hasta 5 solicitudes por minuto por organización.
6 changes: 6 additions & 0 deletions es/deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ Puedes crear manualmente una vista previa para cualquier branch.
4. Ingresa el nombre del branch que quieres previsualizar.
5. Selecciona **Create preview**.

<div id="api">
### API
</div>

También puedes crear implementaciones de vista previa de forma programática usando el endpoint de la API [Trigger preview deployment](/es/api/preview/trigger). Esto es útil para integrar la creación de vistas previas en pipelines CI/CD o herramientas personalizadas.

<div id="redeploy-a-preview">
## Volver a implementar una vista previa
</div>
Expand Down
87 changes: 87 additions & 0 deletions es/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,93 @@
}
}
}
},
"/project/preview/{projectId}": {
"post": {
"summary": "Activar implementación de vista previa",
"description": "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.",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "El ID de tu proyecto. Puedes copiarlo de la página de [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de tu dashboard.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["branch"],
"properties": {
"branch": {
"type": "string",
"description": "El nombre de la rama de Git para la cual crear una implementación de vista previa.",
"minLength": 1
}
}
}
}
}
},
"responses": {
"202": {
"description": "Implementación de vista previa puesta en cola correctamente.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusId": {
"type": "string",
"description": "El ID de estado para hacer seguimiento de la implementación de vista previa. Úsalo con el endpoint [Get deployment status](/es/api/update/status)."
},
"previewUrl": {
"type": "string",
"description": "La URL donde se aloja la implementación de vista previa."
}
}
}
}
}
},
"400": {
"description": "Solicitud no válida. El campo `branch` es obligatorio.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "Las implementaciones de vista previa no están disponibles en tu plan actual.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"components": {
Expand Down
3 changes: 2 additions & 1 deletion fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"fr/api/update/trigger",
"fr/api/update/status"
"fr/api/update/status",
"fr/api/preview/trigger"
]
},
{
Expand Down
4 changes: 3 additions & 1 deletion fr/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir

* [Trigger update](/fr/api/update/trigger): Déclenchez une mise à jour de votre site quand vous le souhaitez.
* [Get update status](/fr/api/update/status): Récupérez le statut d'une mise à jour et d'autres détails sur votre documentation.
* [Trigger preview deployment](/fr/api/preview/trigger): Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique.
* [Create agent job](/fr/api/agent/v2/create-agent-job): Créez une tâche d'agent pour modifier automatiquement votre documentation.
* [Get agent job](/fr/api/agent/v2/get-agent-job): Récupérez les détails et le statut d'une tâche d'agent spécifique.
* [Send follow-up message](/fr/api/agent/v2/send-message): Envoyez un message de suivi à une tâche d'agent existante.
Expand All @@ -28,6 +29,7 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir

* **Déploiements automatisés** : Déclenchez les mises à jour du site à intervalles réguliers ou lorsqu'un événement se produit avec [Trigger update](/fr/api/update/trigger) et [Get update status](/fr/api/update/status).
* **Intégration CI/CD** : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec [Trigger update](/fr/api/update/trigger).
* **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/preview/trigger).
* **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content).
* **Édition automatisée** : Utilisez des jobs d'agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), et [Send follow-up message](/fr/api/agent/v2/send-message).
* **Export Analytics** : Exportez les retours utilisateurs, les conversations de l'Assistant et les données de visiteurs pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
Expand All @@ -44,7 +46,7 @@ Vous pouvez créer jusqu'à 10 clés d'API par heure et par organisation.
### Clé d'API administrateur
</div>

Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).
Utilisez la clé d'API administrateur pour authentifier les requêtes vers [Trigger update](/fr/api/update/trigger), [Get update status](/fr/api/update/status), [Trigger preview deployment](/fr/api/preview/trigger), [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), [Send follow-up message](/fr/api/agent/v2/send-message), [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).

Les clés d'API administrateur commencent par le préfixe `mint_`.

Expand Down
28 changes: 28 additions & 0 deletions fr/api/preview/trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Déclencher un déploiement de prévisualisation"
description: "Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique afin de vérifier les modifications de documentation avant la mise en production."
openapi: "/fr/openapi.json POST /project/preview/{projectId}"
keywords: ["preview", "preview deployment", "branch preview", "staging"]
---

<Info>
Les déploiements de prévisualisation sont disponibles avec les [offres Pro et Enterprise](https://mintlify.com/pricing?ref=preview-deployments).
</Info>

Utilisez cet endpoint pour créer ou mettre à jour de manière programmatique un déploiement de prévisualisation pour une branche Git. Si une prévisualisation existe déjà pour la branche spécifiée, l'endpoint déclenche un redéploiement au lieu de créer un doublon.

La réponse inclut un `statusId` que vous pouvez transmettre à [Get deployment status](/fr/api/update/status) pour suivre la progression du déploiement.

<div id="use-cases">
## Cas d'utilisation
</div>

- **Pipelines CI/CD** : Créez automatiquement des déploiements de prévisualisation lorsque des pull requests sont ouvertes ou mises à jour.
- **Prévisualisations planifiées** : Générez des prévisualisations de branches de fonctionnalités de longue durée selon un calendrier.
- **Outillage personnalisé** : Intégrez la création de prévisualisations dans des workflows internes ou des bots Slack.

<div id="rate-limits">
## Limites de débit
</div>

Cet endpoint autorise jusqu'à 5 requêtes par minute et par organisation.
6 changes: 6 additions & 0 deletions fr/deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ Vous pouvez créer manuellement un aperçu pour n’importe quelle branche.
4. Entrez le nom de la branche à prévisualiser.
5. Sélectionnez **Create preview**.

<div id="api">
### API
</div>

Vous pouvez également créer des déploiements de prévisualisation de manière programmatique en utilisant l'endpoint de l'API [Trigger preview deployment](/fr/api/preview/trigger). Cela est utile pour intégrer la création de prévisualisations dans des pipelines CI/CD ou des outils personnalisés.

<div id="redeploy-a-preview">
## Redéployer un aperçu
</div>
Expand Down
87 changes: 87 additions & 0 deletions fr/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,93 @@
}
}
}
},
"/project/preview/{projectId}": {
"post": {
"summary": "Déclencher un déploiement de prévisualisation",
"description": "Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. Si une prévisualisation existe déjà pour la branche, un redéploiement est déclenché. Retourne un identifiant de statut pour suivre la progression et l'URL de la prévisualisation.",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Identifiant de votre projet. Vous pouvez le copier à partir de la page [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) de votre Dashboard.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["branch"],
"properties": {
"branch": {
"type": "string",
"description": "Le nom de la branche Git pour laquelle créer un déploiement de prévisualisation.",
"minLength": 1
}
}
}
}
}
},
"responses": {
"202": {
"description": "Déploiement de prévisualisation mis en file d'attente avec succès.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusId": {
"type": "string",
"description": "L'identifiant de statut pour suivre le déploiement de prévisualisation. Utilisez-le avec l'endpoint [Get deployment status](/fr/api/update/status)."
},
"previewUrl": {
"type": "string",
"description": "L'URL à laquelle le déploiement de prévisualisation est hébergé."
}
}
}
}
}
},
"400": {
"description": "Requête non valide. Le champ `branch` est obligatoire.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "Les déploiements de prévisualisation ne sont pas disponibles avec votre offre actuelle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"components": {
Expand Down
3 changes: 2 additions & 1 deletion zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@
"icon": "activity",
"pages": [
"zh/api/update/trigger",
"zh/api/update/status"
"zh/api/update/status",
"zh/api/preview/trigger"
]
},
{
Expand Down
Loading
Loading