Skip to content
Closed
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
2 changes: 2 additions & 0 deletions api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
Static exports use `.html` URLs that match the files in the bundle. For example, `/guides/getting-started` becomes `/guides/getting-started.html`. This happens automatically and requires no configuration.

<Note>
Canonical and sitemap URLs remain extensionless. CloudFront resolves these URLs automatically, but other static hosts may require rewrite rules.

Check warning on line 18 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L18

Did you really mean 'extensionless'?
</Note>

## How static export works
Expand All @@ -26,6 +26,8 @@
<Step title="Start a static export job">
Call [Start static export job](/api/static-export/start-job) with your project ID. The API queues the job and returns a `jobId`.

Optionally pass `basePath` in the request body to control the subpath the exported site is served under. Supported values are `""` (site root), `/docs`, and `/documentation`. If you omit `basePath`, the export uses your deployment's configured base path.

A deployment can have only one active job at a time. If a job is already `queued` or `running` for the deployment, the endpoint returns `409`. The endpoint is rate-limited to 10 job starts per organization per hour.
</Step>
<Step title="Poll the job and download the bundle">
Expand Down
2 changes: 2 additions & 0 deletions es/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Una exportación estática se ejecuta como un trabajo asíncrono. Inicias el tra
<Step title="Iniciar un trabajo de exportación estática">
Llama a [Iniciar trabajo de exportación estática](/es/api/static-export/start-job) con tu ID de proyecto. La API pone el trabajo en cola y devuelve un `jobId`.

Opcionalmente, pasa `basePath` en el cuerpo de la solicitud para controlar la subruta bajo la que se sirve el sitio exportado. Los valores admitidos son `""` (raíz del sitio), `/docs` y `/documentation`. Si omites `basePath`, la exportación usa la ruta base configurada de tu implementación.

Una implementación solo puede tener un trabajo activo a la vez. Si ya hay un trabajo `queued` o `running` para la implementación, el endpoint devuelve `409`. El endpoint está limitado a 10 inicios de trabajo por organización por hora.
</Step>
<Step title="Consultar el trabajo y descargar el paquete">
Expand Down
46 changes: 44 additions & 2 deletions es/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@
}
}
},
"400": {
"description": "El cuerpo de la solicitud no es válido. `basePath` debe ser uno de los valores admitidos.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "La autenticación falló.",
"content": {
Expand Down Expand Up @@ -77,6 +87,28 @@
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"basePath": {
"type": "string",
"enum": [
"",
"/docs",
"/documentation"
],
"description": "Ruta base bajo la que se sirve el sitio exportado. Anula la ruta base configurada de la implementación para esta exportación. Si se omite, la exportación usa la ruta base configurada de la implementación.",
"example": "/docs"
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -166,7 +198,12 @@
"schemas": {
"StaticExportJob": {
"type": "object",
"required": ["jobId", "status", "createdAt", "updatedAt"],
"required": [
"jobId",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"jobId": {
"type": "string",
Expand All @@ -176,7 +213,12 @@
"status": {
"type": "string",
"description": "El estado actual del trabajo.",
"enum": ["queued", "running", "completed", "failed"],
"enum": [
"queued",
"running",
"completed",
"failed"
],
"example": "completed"
},
"createdAt": {
Expand Down
2 changes: 2 additions & 0 deletions fr/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Une exportation statique s'exécute sous forme de tâche asynchrone. Vous démar
<Step title="Démarrer une tâche d'exportation statique">
Appelez [Démarrer une tâche d'exportation statique](/fr/api/static-export/start-job) avec l'identifiant de votre projet. L'API met la tâche en file d'attente et renvoie un `jobId`.

Vous pouvez éventuellement passer `basePath` dans le corps de la requête pour contrôler le sous-chemin sous lequel le site exporté est servi. Les valeurs prises en charge sont `""` (racine du site), `/docs` et `/documentation`. Si vous omettez `basePath`, l'exportation utilise le chemin de base configuré de votre déploiement.

Un déploiement ne peut avoir qu'une seule tâche active à la fois. Si une tâche est déjà `queued` ou `running` pour le déploiement, l'endpoint retourne `409`. L'endpoint est limité à 10 démarrages de tâche par organisation et par heure.
</Step>
<Step title="Interroger la tâche et télécharger le bundle">
Expand Down
46 changes: 44 additions & 2 deletions fr/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@
}
}
},
"400": {
"description": "Le corps de la requête n'est pas valide. `basePath` doit être l'une des valeurs prises en charge.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "L’authentification a échoué.",
"content": {
Expand Down Expand Up @@ -77,6 +87,28 @@
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"basePath": {
"type": "string",
"enum": [
"",
"/docs",
"/documentation"
],
"description": "Chemin de base sous lequel le site exporté est servi. Remplace le chemin de base configuré du déploiement pour cet export. S'il est omis, l'export utilise le chemin de base configuré du déploiement.",
"example": "/docs"
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -166,7 +198,12 @@
"schemas": {
"StaticExportJob": {
"type": "object",
"required": ["jobId", "status", "createdAt", "updatedAt"],
"required": [
"jobId",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"jobId": {
"type": "string",
Expand All @@ -176,7 +213,12 @@
"status": {
"type": "string",
"description": "L’état actuel de la tâche.",
"enum": ["queued", "running", "completed", "failed"],
"enum": [
"queued",
"running",
"completed",
"failed"
],
"example": "completed"
},
"createdAt": {
Expand Down
46 changes: 44 additions & 2 deletions static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@
}
}
},
"400": {
"description": "The request body is invalid. `basePath` must be one of the supported values.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Authentication failed.",
"content": {
Expand Down Expand Up @@ -77,6 +87,28 @@
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"basePath": {
"type": "string",
"enum": [
"",
"/docs",
"/documentation"
],
"description": "Base path to serve the exported site under. Overrides the deployment's configured base path for this export. If omitted, the export uses the deployment's configured base path.",
"example": "/docs"
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -166,7 +198,12 @@
"schemas": {
"StaticExportJob": {
"type": "object",
"required": ["jobId", "status", "createdAt", "updatedAt"],
"required": [
"jobId",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"jobId": {
"type": "string",
Expand All @@ -176,7 +213,12 @@
"status": {
"type": "string",
"description": "The current state of the job.",
"enum": ["queued", "running", "completed", "failed"],
"enum": [
"queued",
"running",
"completed",
"failed"
],
"example": "completed"
},
"createdAt": {
Expand Down
2 changes: 2 additions & 0 deletions zh/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]
<Step title="启动静态导出作业">
使用你的项目 ID 调用 [启动静态导出作业](/zh/api/static-export/start-job)。API 会将作业加入队列并返回 `jobId`。

可以在请求正文中传入可选的 `basePath`,控制导出站点所服务的子路径。支持的值为 `""`(站点根路径)、`/docs` 和 `/documentation`。如果省略 `basePath`,导出将使用部署配置的基础路径。

每个部署同一时间只能有一个处于活动状态的作业。如果该部署已有作业处于 `queued` 或 `running` 状态,端点将返回 `409`。该端点的速率限制为每个组织每小时最多启动 10 个作业。
</Step>
<Step title="轮询作业并下载包">
Expand Down
46 changes: 44 additions & 2 deletions zh/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@
}
}
},
"400": {
"description": "请求正文无效。`basePath` 必须是受支持的值之一。",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "身份验证失败。",
"content": {
Expand Down Expand Up @@ -77,6 +87,28 @@
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"basePath": {
"type": "string",
"enum": [
"",
"/docs",
"/documentation"
],
"description": "导出站点所使用的基础路径。为本次导出覆盖部署配置的基础路径。如果省略,导出将使用部署配置的基础路径。",
"example": "/docs"
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -166,7 +198,12 @@
"schemas": {
"StaticExportJob": {
"type": "object",
"required": ["jobId", "status", "createdAt", "updatedAt"],
"required": [
"jobId",
"status",
"createdAt",
"updatedAt"
],
"properties": {
"jobId": {
"type": "string",
Expand All @@ -176,7 +213,12 @@
"status": {
"type": "string",
"description": "任务的当前状态。",
"enum": ["queued", "running", "completed", "failed"],
"enum": [
"queued",
"running",
"completed",
"failed"
],
"example": "completed"
},
"createdAt": {
Expand Down