SpedySpedy Docs

Kommentare

Kommentare zu Tickets hinzufügen, bearbeiten und verwalten.

Kommentare ermöglichen es Teammitgliedern, auf Tickets zu diskutieren und zusammenzuarbeiten. Spedy unterstützt verschachtelte Antworten und geheime Kommentare, die nur für Teammitglieder sichtbar sind (nicht für Kunden).

Kommentare auflisten

GET /api/v1/boards/{boardId}/tickets/{ticketId}/comments

Query-Parameter

ParameterTypPflichtBeschreibung
pagenumberNeinSeitennummer (Standard: 1)
limitnumberNeinEinträge pro Seite (Standard: 20)

Beispiel-Response

{
  "data": [
    {
      "id": "cmt_abc123",
      "content": "Ich habe das auf Chrome 120 reproduziert.",
      "isSecret": false,
      "author": {
        "id": "usr_abc123",
        "name": "Alex Smith"
      },
      "parentId": null,
      "createdAt": "2025-03-15T14:30:00Z",
      "updatedAt": "2025-03-15T14:30:00Z"
    }
  ]
}

Kommentar erstellen

POST /api/v1/boards/{boardId}/tickets/{ticketId}/comments

Request Body

FeldTypPflichtBeschreibung
contentstringJaKommentarinhalt (max. 10.000 Zeichen)
isSecretbooleanNeinGeheimer Kommentar, nur für Teammitglieder sichtbar (erfordert tickets:add-secret-comments-Berechtigung)
parentIdstringNeinEltern-Kommentar-ID für verschachtelte Antworten

Beispiel-Request

{
  "content": "Ich habe das auf Chrome 120 reproduziert.",
  "isSecret": false
}

Kommentar abrufen

GET /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}

Gibt einen einzelnen Kommentar zurück.

Kommentar aktualisieren

PATCH /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}

Nur der Kommentarautor oder Nutzer mit tickets:edit-Berechtigung können Kommentare aktualisieren.

Request Body

FeldTypPflichtBeschreibung
contentstringJaAktualisierter Kommentarinhalt

Kommentar löschen

DELETE /api/v1/boards/{boardId}/tickets/{ticketId}/comments/{commentId}

Nur der Kommentarautor oder Nutzer mit tickets:edit-Berechtigung können Kommentare löschen. Gibt 204 No Content zurück.