Wiki

Créez, mettez à jour, recherchez et gérez les pages wiki. Construisez une base de connaissances du projet.

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

Le wiki fournit une base de connaissances structurée au sein de chaque projet. Les pages supportent le contenu markdown, les hiérarchies imbriquées et la recherche en texte intégral.

Lister les pages wiki

Retourne les pages wiki d'un projet.

GET /wiki/pages?company_slug={slug}&project_slug={slug}

Paramètres de requête

Paramètre	Type	Requis	Description
`company_slug`	string	Oui	Identifiant du workspace
`project_slug`	string	Oui	Identifiant du projet

Exemple de requête

curl -X GET "https://services.gitscrum.com/wiki/pages?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Exemple de réponse

{
  "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"
    }
  ]
}

Obtenir une page wiki

Retourne une page wiki avec son contenu complet.

GET /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Paramètre	Type	Description
`uuid`	string	UUID de la page wiki

Créer une page wiki

Crée une nouvelle page wiki.

POST /wiki/pages

Corps de la requête

Champ	Type	Requis	Description
`title`	string	Oui	Titre de la page
`content`	string	Oui	Contenu de la page (markdown)
`company_slug`	string	Oui	Identifiant du workspace
`project_slug`	string	Oui	Identifiant du projet
`parent_uuid`	string	Non	UUID de la page parent (pour les pages imbriquées)

Exemple de requête

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"
  }'

Mettre à jour une page wiki

Met à jour une page wiki existante.

PUT /wiki/pages/{uuid}

Paramètres de chemin

Paramètre	Type	Description
`uuid`	string	UUID de la page wiki

Corps de la requête

Champ	Type	Requis	Description
`company_slug`	string	Oui	Identifiant du workspace
`project_slug`	string	Oui	Identifiant du projet
`title`	string	Non	Titre de la page mis à jour
`content`	string	Non	Contenu de la page mis à jour (markdown)

Supprimer une page wiki

Supprime définitivement une page wiki.

DELETE /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Paramètre	Type	Description
`uuid`	string	UUID de la page wiki

Révisions de page

Retourne l'historique des révisions d'une page wiki.

GET /wiki/pages/{uuid}/revisions?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Paramètre	Type	Description
`uuid`	string	UUID de la page wiki

Restaurer une révision

Restaure une page wiki à une révision précédente.

POST /wiki/pages/{uuid}/restore/{revision_uuid}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Paramètre	Type	Description
`uuid`	string	UUID de la page wiki
`revision_uuid`	string	UUID de la révision à restaurer

Rechercher dans le wiki

Recherche des pages wiki par contenu ou titre.

GET /wiki/pages/search?company_slug={slug}&project_slug={slug}&q={query}

Paramètres de requête

Paramètre	Type	Requis	Description
`company_slug`	string	Oui	Identifiant du workspace
`project_slug`	string	Oui	Identifiant du projet
`q`	string	Oui	Requête de recherche (min 2 caractères)
`limit`	integer	Non	Résultats max (défaut 20, max 50)

Exemple de requête

curl -X GET "https://services.gitscrum.com/wiki/pages/search?company_slug=acme&project_slug=web-app&q=deployment" \
  -H "Authorization: Bearer {token}"

Référence des champs

Champ	Type	Description
`uuid`	string	Identifiant unique de la page
`title`	string	Titre de la page
`content`	string	Contenu de la page (markdown)
`parent_uuid`	string	UUID de la page parent (null pour les pages racine)
`user`	object	Auteur (`username`, `name`)
`revisions_count`	integer	Nombre de révisions
`created_at`	string	Horodatage de création
`updated_at`	string	Horodatage de dernière mise à jour