GitScrum / Docs

Commentaires

Ajoutez, listez et mettez à jour les commentaires sur les tâches. Support du contenu en texte enrichi.

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.

Les commentaires permettent aux membres de l'équipe de discuter des tâches, partager des mises à jour et suivre les décisions directement sur les éléments de travail.

Lister les commentaires

Retourne les commentaires d'une tâche spécifique.

GET /comments?company_slug={slug}&project_slug={slug}&task_uuid={uuid}

Paramètres de requête

ParamètreTypeRequisDescription
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet
task_uuidstringOuiUUID de la tâche

Exemple de requête

curl -X GET "https://services.gitscrum.com/comments?company_slug=acme&project_slug=web-app&task_uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer {token}"

Exemple de réponse

{
  "data": [
    {
      "id": 1024,
      "comment": "<p>API integration is complete. Ready for review.</p>",
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "created_at": "2026-02-05T09:15:00Z",
      "updated_at": "2026-02-05T09:15:00Z"
    }
  ]
}

Créer un commentaire

Ajoute un commentaire à une tâche.

POST /comments

Corps de la requête

ChampTypeRequisDescription
commentstringOuiTexte du commentaire (HTML ou markdown)
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet
task_uuidstringOuiUUID de la tâche

Exemple de requête

curl -X POST "https://services.gitscrum.com/comments" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Blocked by missing API credentials. Reaching out to DevOps.",
    "company_slug": "acme",
    "project_slug": "web-app",
    "task_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Mettre à jour un commentaire

Met à jour un commentaire existant.

PUT /comments/{id}

Paramètres de chemin

ParamètreTypeDescription
idintegerID du commentaire

Corps de la requête

ChampTypeRequisDescription
commentstringOuiTexte du commentaire mis à jour
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet

Supprimer un commentaire

Supprime un commentaire.

DELETE /comments/{id}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

ParamètreTypeDescription
idintegerID du commentaire

Référence des champs

ChampTypeDescription
idintegerIdentifiant du commentaire
commentstringContenu du commentaire (HTML)
userobjectAuteur (username, name, avatar)
created_atstringHorodatage de création
updated_atstringHorodatage de dernière mise à jour