Generate a page diff

POST

/api/content/management/packages/{repo}/{packageName}/page-diff

const url = 'https://example.com/api/content/management/packages/example/example/page-diff';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"sectionPath":"/products","pageSlug":"about-us","changeType":"UPDATE"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/content/management/packages/example/example/page-diff \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sectionPath": "/products", "pageSlug": "about-us", "changeType": "UPDATE" }'

Generates a page diff for a changed page in a package and stores it under an ephemeral key. Requires the packages.diff.view permission.

Authorizations

bearerAuth

Parameters

Path Parameters

repo

required

Repository name or ID

string

packageName

required

Package name

string

Request Body

application/json

object

sectionPath

Section path of the changed page

string

Example

/products

pageSlug

Slug of the changed page

string

Example

about-us

changeType

Type of change being diffed

string

Allowed values: UPDATE ADD REMOVE BASE_ADD BASE_REMOVE

Example

UPDATE

Responses

200

Page diff generated

application/json

object

diffKey

required

Ephemeral key identifying the generated diff

string

url

required

URL to view the rendered diff HTML

string

expiresInSeconds

required

Seconds until the diff key expires

number

Example

{
  "expiresInSeconds": 3600
}

403

Access denied

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}