Wiki
Crea, actualiza, busca y gestiona páginas wiki. Construye una base de conocimiento del proyecto.
REST API — Todos los endpoints requieren autenticación mediante Bearer token. IncluyeAuthorization: Bearer {token}en cada solicitud. Los tokens se gestionan en Configuración de GitScrum → API. Base URL:https://services.gitscrum.com— Todas las rutas de solicitud en esta documentación son relativas a esta URL base.
La wiki proporciona una base de conocimiento estructurada dentro de cada proyecto. Las páginas soportan contenido markdown, jerarquías anidadas y búsqueda de texto completo.
Listar páginas wiki
Devuelve las páginas wiki de un proyecto.
GET /wiki/pages?company_slug={slug}&project_slug={slug}Parámetros de query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
Ejemplo de solicitud
curl -X GET "https://services.gitscrum.com/wiki/pages?company_slug=acme&project_slug=web-app" \
-H "Authorization: Bearer {token}"Ejemplo de respuesta
{
"data": [
{
"uuid": "d4e5f6a7-b8c9-0123-def0-123456789abc",
"title": "API Architecture",
"content": "# API Architecture\n\nOur REST API follows...",
"parent_uuid": null,
"user": {
"username": "johndoe",
"name": "John Doe"
},
"revisions_count": 3,
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-01T14:30:00Z"
}
]
}Obtener página wiki
Devuelve una página wiki individual con su contenido completo.
GET /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la página wiki |
Crear página wiki
Crea una nueva página wiki.
POST /wiki/pagesCuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
title | string | Sí | Título de la página |
content | string | Sí | Contenido de la página (markdown) |
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
parent_uuid | string | No | UUID de la página padre (para páginas anidadas) |
Ejemplo de solicitud
curl -X POST "https://services.gitscrum.com/wiki/pages" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"title": "Deployment Guide",
"content": "# Deployment Guide\n\n## Prerequisites\n\n- Docker installed\n- Access to production cluster",
"company_slug": "acme",
"project_slug": "web-app"
}'Actualizar página wiki
Actualiza una página wiki existente.
PUT /wiki/pages/{uuid}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la página wiki |
Cuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
title | string | No | Título actualizado de la página |
content | string | No | Contenido actualizado de la página (markdown) |
Eliminar página wiki
Elimina permanentemente una página wiki.
DELETE /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la página wiki |
Revisiones de página
Devuelve el historial de revisiones de una página wiki.
GET /wiki/pages/{uuid}/revisions?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la página wiki |
Restaurar revisión
Restaura una página wiki a una revisión anterior.
POST /wiki/pages/{uuid}/restore/{revision_uuid}?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la página wiki |
revision_uuid | string | UUID de la revisión a restaurar |
Buscar en la wiki
Busca páginas wiki por contenido o título.
GET /wiki/pages/search?company_slug={slug}&project_slug={slug}&q={query}Parámetros de query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
q | string | Sí | Consulta de búsqueda (mínimo 2 caracteres) |
limit | integer | No | Máximo de resultados (predeterminado 20, máximo 50) |
Ejemplo de solicitud
curl -X GET "https://services.gitscrum.com/wiki/pages/search?company_slug=acme&project_slug=web-app&q=deployment" \
-H "Authorization: Bearer {token}"Referencia de campos
| Campo | Tipo | Descripción |
|---|---|---|
uuid | string | Identificador único de la página |
title | string | Título de la página |
content | string | Contenido de la página (markdown) |
parent_uuid | string | UUID de la página padre (null para páginas raíz) |
user | object | Autor (username, name) |
revisions_count | integer | Número de revisiones |
created_at | string | Timestamp de creación |
updated_at | string | Timestamp de última actualización |