Commit

POST

Creates a new permanent commit on the given branch. Throws if the branch doesn’t exist. Throws if latestCommit is passed and is not the latest commit.

Path parameters

resourceRidstringRequired

branchNamestringRequired

Request

This endpoint expects an object.

newCommitstringRequired

40 hex character unique identifier.

messagestringRequired

mergeParentCommitstringOptional

If present, this existing commit will be the merge parent of the new commit. It will be made permanent if not already, to prevent the merge parent from being compacted.

latestCommitstringOptional

40 hex character unique identifier.

Response

This endpoint returns an object.

branchobject

commitobject

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/versioning/internal/resourceRid/branch/branchName/commit \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "newCommit": "newCommit",
6   "message": "message"
7 }'

200Successful

1 {
2   "branch": {
3     "rid": "rid",
4     "name": "name",
5     "resourceRid": "resourceRid",
6     "commit": "commit",
7     "createdBy": "createdBy",
8     "createdAt": "2024-01-15T09:30:00Z",
9     "updatedAt": "2024-01-15T09:30:00Z"
10   },
11   "commit": {
12     "id": "id",
13     "resourceRid": "resourceRid",
14     "message": "message",
15     "isWorkingState": true,
16     "committedBy": "committedBy",
17     "committedAt": "2024-01-15T09:30:00Z",
18     "parentCommit": "parentCommit",
19     "mergeParentCommit": "mergeParentCommit"
20   }
21 }

Compact Commits

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/versioning/internal/resourceRid/branch/branchName/commit \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"newCommit": "newCommit",
6	"message": "message"
7	}'

1	{
2	"branch": {
3	"rid": "rid",
4	"name": "name",
5	"resourceRid": "resourceRid",
6	"commit": "commit",
7	"createdBy": "createdBy",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z"
10	},
11	"commit": {
12	"id": "id",
13	"resourceRid": "resourceRid",
14	"message": "message",
15	"isWorkingState": true,
16	"committedBy": "committedBy",
17	"committedAt": "2024-01-15T09:30:00Z",
18	"parentCommit": "parentCommit",
19	"mergeParentCommit": "mergeParentCommit"
20	}
21	}