Append a version-graph commit

POST

api

version-graph

commits

curl --request POST \
  --url https://api.nitsor.com/api/v1/version-graph/commits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branchId": "<string>",
  "idempotencyKey": "<string>",
  "projectId": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/version-graph/commits"

payload = {
    "branchId": "<string>",
    "idempotencyKey": "<string>",
    "projectId": "<string>",
    "message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branchId: '<string>',
    idempotencyKey: '<string>',
    projectId: '<string>',
    message: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/version-graph/commits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/version-graph/commits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'branchId' => '<string>',
    'idempotencyKey' => '<string>',
    'projectId' => '<string>',
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/version-graph/commits"

	payload := strings.NewReader("{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/version-graph/commits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/version-graph/commits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "<string>",
  "ambiguousBase": true,
  "authorPrincipalSubject": "<string>",
  "authorPrincipalType": "agent",
  "branchId": "<string>",
  "commitId": "<string>",
  "committedAt": "2023-11-07T05:31:56Z",
  "contentRoot": "<string>",
  "eventRange": {
    "fromSeq": 123,
    "toSeq": 123
  },
  "eventRangeDigest": "<string>",
  "kind": "annotate",
  "message": "<string>",
  "parentCommitIds": [
    "<string>"
  ],
  "projectId": "<string>",
  "authorPrincipalIssuer": "<string>",
  "authorPrincipalName": "<string>",
  "authorPrincipalEmail": "<string>",
  "messageDisplay": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Body

application/json

branchId

string

required

Required string length: 1 - 200

idempotencyKey

string

required

Required string length: 1 - 200

projectId

string

required

Required string length: 1 - 200

message

string

required

Required string length: 1 - 500

Response

Append a version-graph commit

accountId

string

required

Required string length: 1 - 200

ambiguousBase

boolean

required

authorPrincipalSubject

string

required

Required string length: 1 - 200

authorPrincipalType

enum<string>

required

Available options:

agent,

system,

user

branchId

string

required

Required string length: 1 - 200

commitId

string

required

Pattern: ^sha256:([0-9a-f]{64})$

committedAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

contentRoot

string

required

Pattern: ^sha256:([0-9a-f]{64})$

eventRange

object

required

Show child attributes

eventRangeDigest

string

required

Pattern: ^sha256:([0-9a-f]{64})$

kind

enum<string>

required

Available options:

annotate,

review,

rework,

handback,

safety,

merge,

import,

branch,

checkpoint,

run

message

string

required

Maximum string length: 500

parentCommitIds

string[]

required

Maximum array length: 2

Pattern: ^sha256:([0-9a-f]{64})$

projectId

string

required

Required string length: 1 - 200

authorPrincipalIssuer

string

Required string length: 1 - 200

authorPrincipalName

string

Minimum string length: 1

authorPrincipalEmail

string

Minimum string length: 1

messageDisplay

string

Append a version-graph commit

curl --request POST \
  --url https://api.nitsor.com/api/v1/version-graph/commits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branchId": "<string>",
  "idempotencyKey": "<string>",
  "projectId": "<string>",
  "message": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/version-graph/commits"

payload = {
    "branchId": "<string>",
    "idempotencyKey": "<string>",
    "projectId": "<string>",
    "message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    branchId: '<string>',
    idempotencyKey: '<string>',
    projectId: '<string>',
    message: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/version-graph/commits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/version-graph/commits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'branchId' => '<string>',
    'idempotencyKey' => '<string>',
    'projectId' => '<string>',
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/version-graph/commits"

	payload := strings.NewReader("{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/version-graph/commits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/version-graph/commits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"branchId\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "accountId": "<string>",
  "ambiguousBase": true,
  "authorPrincipalSubject": "<string>",
  "authorPrincipalType": "agent",
  "branchId": "<string>",
  "commitId": "<string>",
  "committedAt": "2023-11-07T05:31:56Z",
  "contentRoot": "<string>",
  "eventRange": {
    "fromSeq": 123,
    "toSeq": 123
  },
  "eventRangeDigest": "<string>",
  "kind": "annotate",
  "message": "<string>",
  "parentCommitIds": [
    "<string>"
  ],
  "projectId": "<string>",
  "authorPrincipalIssuer": "<string>",
  "authorPrincipalName": "<string>",
  "authorPrincipalEmail": "<string>",
  "messageDisplay": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Reference

API operations

Append a version-graph commit

Authorizations

Body

Response