Ferndesk

Revisiones de artículos

Comparar dos revisiones

Devuelve una diferencia de líneas en Markdown unificado entre esta revisión y otra (por número de versión o ID de revisión mediante against). Requiere el scope content:read.

Scope requerido: content:read

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

Comparar dos revisiones

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
}

Diferencias

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, anular la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de la definición de scopes tienen scopes nulos = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID de artículo de Ferndesk (art_...). Ejemplo: art_01JXY9AZK4KV

  • revisionId string obligatorio

    ID de revisión. Ejemplo: rev_01JXY9AZK4KV

Query Parameters

  • against string obligatorio

    Número de versión o ID de revisión con el que se comparará esta revisión. Ejemplo: 3

Response

application/json
  • articleId string

    ID de artículo de Ferndesk (art_...).

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

    Diferencia de líneas en Markdown con estilo unificado.

  • addedLines integer
  • removedLines integer
  • truncated boolean