Ferndesk

Artikelrevisionen

Zwei Revisionen vergleichen

Liefert einen einheitlichen Markdown-Zeilendiff zwischen dieser Revision und einer anderen (anhand der Versionsnummer oder der Revisions-ID über against). Erfordert den Scope content:read.

Erforderlicher Scope: content:read

GET /articles/{id}/revisions/{revisionId}/diff

Zwei Revisionen vergleichen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/revisions/{REVISIONID}/diff' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "articleId": "<string>",
  "from": {
    "revisionId": "<string>",
    "version": 1
  },
  "to": {
    "revisionId": "<string>",
    "version": 1
  },
  "changed": true,
  "diff": "<string>",
  "addedLines": 1,
  "removedLines": 1,
  "truncated": true
}

Diff

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Developer settings erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den über x-required-scopes erforderlichen Scope auf):

    • content:read: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfecenters lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes erstellte Schlüssel haben null scopes = vollständigen Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

    Ferndesk-Artikel-ID (art_...). Beispiel: art_01JXY9AZK4KV

  • revisionId string erforderlich

    Revisions-ID. Beispiel: rev_01JXY9AZK4KV

Query Parameters

  • against string erforderlich

    Versionsnummer oder Revisions-ID, mit der diese Revision verglichen werden soll. Beispiel: 3

Response

application/json
  • articleId string

    Ferndesk-Artikel-ID (art_...).

  • from object
    + Show Child Attributes
    • revisionId string
    • version integer
  • to object
    + Show Child Attributes
    • revisionId string
    • version integer
  • changed boolean
  • diff string

    Markdown-Zeilendiff im Unified-Format.

  • addedLines integer
  • removedLines integer
  • truncated boolean