Commit

POST

Creates a permanent commit with a commit message. Throws if the checklist or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you commit to an archived checklist.

Path parameters

checklistRidstringRequired

Query parameters

branchstringOptional

Request

This endpoint expects an object.
commitMessagestringRequired
checkslist of objectsRequired
functionsmap from strings to objectsRequired

The keys of the map are references that can be used for checks to reference functions in the same request, before the function RIDs have been created.

checklistVariableslist of objectsRequired

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.

latestCommitstringOptional

If present, will validate that the latest commit matches this id, and otherwise throw CommitConflict.

Response

This endpoint returns an object.
ridstring
metadataobject
commitobject
functionslist of objects

A list of functions that are available to be used by checks in this checklist.

checkslist of objects
checklistVariableslist of objects

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.

Save Working State
Built with