Ferndesk

Révisions d’article

Comparer deux révisions

Retourne un diff de lignes Markdown unifié entre cette révision et une autre (par numéro de version ou ID de révision via against). Nécessite la portée content:read.

Portée requise : content:read

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

Comparer deux révisions

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 requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces portées (chaque endpoint indique la portée requise via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et mettre à la corbeille du contenu (rendre les modifications accessibles)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des portées ont des portées nulles = accès complet (mode hérité).

Path Parameters

  • id string requis

    ID d’article Ferndesk (art_...). Exemple: art_01JXY9AZK4KV

  • revisionId string requis

    ID de révision. Exemple: rev_01JXY9AZK4KV

Query Parameters

  • against string requis

    Numéro de version ou ID de révision avec lequel comparer cette révision. Exemple: 3

Response

application/json
  • articleId string

    ID d’article Ferndesk (art_...).

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

    Diff de lignes Markdown de style unifié.

  • addedLines integer
  • removedLines integer
  • truncated boolean