Change programs: merge, revert, review

Reference for Change, one group of Change programs.

Change.merge

Merge applies a Change to live data with a three-way, field-level merge against its base Version. Verb page.

Text

do: return await $.Change.merge(input)

Inputs

Input	Type	Required	Description
`change`	Change	required	The reviewed Change.

Returns

Output	Type	Required	Description
`version`	Version	required	The new Version.
`change`	Change	required	The Change, now merged into live data.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record changed since it was read, so the write would overwrite a newer version.	`conflict`	Read the record again, then retry the write against its current state.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Change.merge({ change: 'change_3Ex8uVSOyQ' })"
  }
}

Revert undoes a merged Change with a new Change and a superseding Decision, deleting nothing. Verb page.

Text

do: return await $.Change.revert(input)

Inputs

Input	Type	Required	Description
`change`	Change	required	The merged Change to undo.
`reason`	`text`	required	Why it is undone.

Returns

Output	Type	Required	Description
`revert`	Change	required	The Change that undoes it.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Change.revert({ change: 'change_3Ex8uVSOyQ', reason: 'Example reason' })"
  }
}

Review runs every Evaluator on a Change’s preview and records each verdict on the Change. Verb page.

Text

do: return await $.Change.review(input)

Inputs

Input	Type	Required	Description
`change`	Change	required	The open Change.

Returns

Output	Type	Required	Description
`change`	Change	required	The Change with its verdicts.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Change.review({ change: 'change_3Ex8uVSOyQ' })"
  }
}