Skip to content

Add get page content endpoint to Discovery API docs #5007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Add get page content endpoint to Discovery API docs #5007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions api/assistant/get-page-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Get page content"
description: "Retrieve the full content of a specific documentation page by its slug."
openapi: "/discovery-openapi.json POST /v1/page/{domain}"
keywords: [ "page", "content", "fetch" ]
---
91 changes: 91 additions & 0 deletions discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,6 +840,97 @@
}
}
}
},
"/v1/page/{domain}": {
"post": {
"summary": "Get page content",
"description": "Retrieve the full content of a specific documentation page by its slug. Returns the complete stitched content from all chunks of the page.",
"parameters": [
{
"name": "domain",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The domain identifier from your `domain.mintlify.app` URL. Can be found at the end of your dashboard URL. For example, `dashboard.mintlify.com/organization/domain` has a domain identifier of `domain`."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"description": "The page slug or path to retrieve content for (e.g. `getting-started/quickstart`)."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Page content retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "The page slug that was requested."
},
"content": {
"type": "string",
"description": "The full stitched content of the page."
}
}
}
}
}
},
"400": {
"description": "Invalid request body",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Page not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"components": {
Expand Down
12 changes: 8 additions & 4 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,8 @@
"icon": "bot-message-square",
"pages": [
"api/assistant/create-assistant-message-v2",
"api/assistant/search"
"api/assistant/search",
"api/assistant/get-page-content"
]
},
{
Expand Down Expand Up @@ -737,7 +738,8 @@
"icon": "bot-message-square",
"pages": [
"fr/api/assistant/create-assistant-message-v2",
"fr/api/assistant/search"
"fr/api/assistant/search",
"fr/api/assistant/get-page-content"
]
},
{
Expand Down Expand Up @@ -1109,7 +1111,8 @@
"icon": "bot-message-square",
"pages": [
"es/api/assistant/create-assistant-message-v2",
"es/api/assistant/search"
"es/api/assistant/search",
"es/api/assistant/get-page-content"
]
},
{
Expand Down Expand Up @@ -1481,7 +1484,8 @@
"icon": "bot-message-square",
"pages": [
"zh/api/assistant/create-assistant-message-v2",
"zh/api/assistant/search"
"zh/api/assistant/search",
"zh/api/assistant/get-page-content"
]
},
{
Expand Down
6 changes: 6 additions & 0 deletions es/api/assistant/get-page-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Obtener contenido de página"
description: "Recupera el contenido completo de una página de documentación específica por su slug."
openapi: "/es/discovery-openapi.json POST /v1/page/{domain}"
keywords: [ "página", "contenido", "obtener" ]
---
91 changes: 91 additions & 0 deletions es/discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,6 +840,97 @@
}
}
}
},
"/v1/page/{domain}": {
"post": {
"summary": "Obtener contenido de página",
"description": "Recupera el contenido completo de una página de documentación específica por su slug. Devuelve el contenido completo ensamblado a partir de todos los fragmentos de la página.",
"parameters": [
{
"name": "domain",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "El identificador de dominio de tu URL `domain.mintlify.app`. Se puede encontrar al final de la URL de tu dashboard. Por ejemplo, `dashboard.mintlify.com/organization/domain` tiene un identificador de dominio `domain`."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"description": "El slug o ruta de la página cuyo contenido deseas recuperar (por ejemplo, `getting-started/quickstart`)."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Contenido de la página recuperado exitosamente",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "El slug de la página solicitada."
},
"content": {
"type": "string",
"description": "El contenido completo ensamblado de la página."
}
}
}
}
}
},
"400": {
"description": "Cuerpo de solicitud inválido",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Página no encontrada",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"components": {
Expand Down
6 changes: 6 additions & 0 deletions fr/api/assistant/get-page-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Récupérer le contenu d'une page"
description: "Récupérez le contenu complet d'une page de documentation spécifique par son slug."
openapi: "/fr/discovery-openapi.json POST /v1/page/{domain}"
keywords: [ "page", "contenu", "récupérer" ]
---
91 changes: 91 additions & 0 deletions fr/discovery-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,6 +840,97 @@
}
}
}
},
"/v1/page/{domain}": {
"post": {
"summary": "Récupérer le contenu d'une page",
"description": "Récupère le contenu complet d'une page de documentation spécifique par son slug. Retourne le contenu complet reconstitué à partir de tous les fragments de la page.",
"parameters": [
{
"name": "domain",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "L'identifiant de domaine de votre URL `domain.mintlify.app`. Vous le trouverez à la fin de l'URL de votre Dashboard. Par exemple, `dashboard.mintlify.com/organization/domain` a pour identifiant de domaine `domain`."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"description": "Le slug ou chemin de la page dont vous souhaitez récupérer le contenu (ex : `getting-started/quickstart`)."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Contenu de la page récupéré avec succès",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "Le slug de la page demandée."
},
"content": {
"type": "string",
"description": "Le contenu complet reconstitué de la page."
}
}
}
}
}
},
"400": {
"description": "Corps de requête invalide",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
}
}
}
}
},
"404": {
"description": "Page non trouvée",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"components": {
Expand Down
6 changes: 6 additions & 0 deletions zh/api/assistant/get-page-content.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "获取页面内容"
description: "通过页面路径检索特定文档页面的完整内容。"
openapi: "/zh/discovery-openapi.json POST /v1/page/{domain}"
keywords: [ "页面", "内容", "获取" ]
---
Loading
Loading