mintlify__docs/fr/openapi.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "Mintlify External API",
    "description": "Une API pour gérer la documentation Mintlify et accéder aux ressources.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.mintlify.com/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-mcp": {
    "enabled": true
  },
  "paths": {
    "/project/update/{projectId}": {
      "post": {
        "summary": "Lancer la mise à jour",
        "description": "Mettez en file d’attente une mise à jour de déploiement pour votre projet de documentation. Retourne un identifiant de statut qui peut être utilisé pour suivre la progression de la mise à jour. La mise à jour est déclenchée à partir de la branche de déploiement que vous avez configurée.\n\nAuthentifiez-vous avec une clé d'API administrateur.",
        "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"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Une réponse réussie",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusId": {
                      "type": "string",
                      "description": "L’identifiant de statut de la mise à jour déclenchée."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/project/update-status/{statusId}": {
      "get": {
        "summary": "Obtenir le statut de mise à jour",
        "description": "Récupérer le statut d’une mise à jour à partir de son identifiant de statut\n\nAuthentifiez-vous avec une clé d'API administrateur.",
        "parameters": [
          {
            "name": "statusId",
            "in": "path",
            "description": "L’identifiant de statut de la mise à jour déclenchée.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Une réponse réussie",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string",
                      "description": "L’identifiant de statut de la mise à jour déclenchée."
                    },
                    "projectId": {
                      "type": "string",
                      "description": "L’identifiant du projet de documentation."
                    },
                    "createdAt": {
                      "type": "string",
                      "description": "Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC"
                    },
                    "endedAt": {
                      "type": "string",
                      "description": "Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "queued",
                        "in_progress",
                        "success",
                        "failure"
                      ],
                      "description": "Le statut de la mise à jour."
                    },
                    "summary": {
                      "type": "string",
                      "description": "Récapitulatif de l’état de la mise à jour"
                    },
                    "logs": {
                      "type": "array",
                      "description": "Un tableau de logs.",
                      "items": {
                        "type": "string"
                      }
                    },
                    "subdomain": {
                      "type": "string",
                      "description": "Le sous-domaine de la documentation en cours de mise à jour."
                    },
                    "screenshot": {
                      "type": "string",
                      "description": "Une capture d’écran de la documentation."
                    },
                    "screenshotLight": {
                      "type": "string",
                      "description": "Une capture d’écran de la doc."
                    },
                    "screenshotDark": {
                      "type": "string",
                      "description": "Une capture d’écran de la documentation en mode sombre."
                    },
                    "author": {
                      "type": "object",
                      "description": "L'auteur de la mise à jour.",
                      "nullable": true,
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "Le nom de l'auteur."
                        },
                        "avatarUrl": {
                          "type": "string",
                          "description": "URL de l'avatar de l'auteur."
                        },
                        "githubUserId": {
                          "type": "number",
                          "description": "L'identifiant GitHub de l'auteur."
                        }
                      }
                    },
                    "commit": {
                      "type": "object",
                      "description": "Les détails du commit",
                      "properties": {
                        "sha": {
                          "type": "string",
                          "description": "Le SHA du commit."
                        },
                        "ref": {
                          "type": "string",
                          "description": "La référence du commit."
                        },
                        "message": {
                          "type": "string",
                          "description": "Le message de commit."
                        },
                        "filesChanged": {
                          "type": "object",
                          "description": "Détails des fichiers modifiés.",
                          "properties": {
                            "added": {
                              "type": "array",
                              "description": "De nouveaux fichiers ont été ajoutés.",
                              "items": {
                                "type": "string"
                              }
                            },
                            "modified": {
                              "type": "array",
                              "description": "Fichiers existants modifiés.",
                              "items": {
                                "type": "string"
                              }
                            },
                            "removed": {
                              "type": "array",
                              "description": "Fichiers supprimés.",
                              "items": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    },
                    "source": {
                      "type": "string",
                      "description": "La source du déclencheur de mise à jour.",
                      "enum": [
                        "internal",
                        "github-app-installation",
                        "api",
                        "github",
                        "dashboard",
                        "gitlab",
                        "onboarding"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/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.\n\nAuthentifiez-vous avec une clé d'API administrateur.",
        "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"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/workflow/{projectId}/{workflowSchemaId}/trigger": {
      "post": {
        "summary": "Déclencher une automatisation",
        "description": "Déclenchez immédiatement une automatisation planifiée, au lieu d'attendre sa prochaine heure planifiée. Utile pour exécuter des automatisations depuis des pipelines CI/CD, comme une GitHub Action qui s'exécute à chaque fusion sur votre branche par défaut. Seules les automatisations planifiées (avec un calendrier personnalisé) peuvent être déclenchées. L'exécution récupère les modifications effectuées depuis la dernière exécution terminée, à l'identique d'une exécution planifiée habituelle.\n\nAuthentifiez-vous avec une clé d'API administrateur.",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "description": "Identifiant de votre projet. Vous pouvez le copier à partir de la page [API keys](https://app.mintlify.com/settings/organization/api-keys) de votre Dashboard.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workflowSchemaId",
            "in": "path",
            "description": "Identifiant de l'automatisation à déclencher. Vous pouvez le copier depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "Exécution de l'automatisation mise en file d'attente avec succès.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "schemaId": {
                      "type": "string",
                      "description": "Identifiant de l'automatisation déclenchée."
                    },
                    "instanceId": {
                      "type": "string",
                      "description": "Identifiant de l'exécution d'automatisation mise en file d'attente. Apparaît dans l'historique des exécutions sur la page [Automation Runs](https://app.mintlify.com/products/automations)."
                    },
                    "jobId": {
                      "type": "string",
                      "description": "Identifiant de la tâche d'arrière-plan qui traite l'exécution."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Requête non valide. L'identifiant de l'automatisation est mal formé, l'automatisation n'est pas active, ou l'automatisation n'est pas configurée avec un calendrier personnalisé.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "L'automatisation est introuvable ou n'appartient pas à ce projet.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la [page des clés d'API](https://dashboard.mintlify.com/settings/organization/api-keys) de votre Dashboard."
      }
    }
  }
}