repos.notes.append

POST

api

repos

{repo_name}

notes

append

Append Note

curl --request POST \
  --url https://api.{org}.code.storage/api/repos/{repo_name}/notes/append \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "author": {
    "email": "review@example.com",
    "name": "Review Bot"
  },
  "note": "Deployment complete.",
  "object_ref": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
'

import requests

url = "https://api.{org}.code.storage/api/repos/{repo_name}/notes/append"

payload = {
    "author": {
        "email": "review@example.com",
        "name": "Review Bot"
    },
    "note": "Deployment complete.",
    "object_ref": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
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({
    author: {email: 'review@example.com', name: 'Review Bot'},
    note: 'Deployment complete.',
    object_ref: 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  })
};

fetch('https://api.{org}.code.storage/api/repos/{repo_name}/notes/append', 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.{org}.code.storage/api/repos/{repo_name}/notes/append",
  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([
    'author' => [
        'email' => 'review@example.com',
        'name' => 'Review Bot'
    ],
    'note' => 'Deployment complete.',
    'object_ref' => 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  ]),
  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.{org}.code.storage/api/repos/{repo_name}/notes/append"

	payload := strings.NewReader("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\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.{org}.code.storage/api/repos/{repo_name}/notes/append")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{org}.code.storage/api/repos/{repo_name}/notes/append")

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  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}"

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

{
  "base_commit": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "new_ref_sha": "3a1d9f7d6b6d482c970554e2a6ef980ecf4f1d55",
  "notes_ref": "refs/notes/commits",
  "result": {
    "status": "ok",
    "success": true
  },
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

Body

application/json

Add text to the Git note of the supplied object_ref. If the object has no note, the request creates it. Set notes_ref to target a notes ref other than refs/notes/commits; a bare name like reviews is accepted and placed under refs/notes/.

Append-note request describing the Git object, the text to add, and the optional notes ref guard.

note

string

required

Plain text to add to the note.

Example:

"Deployment complete."

author

object

Author object with name and email for the notes commit.

Show child attributes

expected_notes_ref_sha

string

Optional compare-and-swap guard for the notes ref. Provide expected_notes_ref_sha or the deprecated expected_ref_sha.

expected_ref_sha

string

deprecated

Deprecated: use expected_notes_ref_sha. Optional compare-and-swap guard for the notes ref.

notes_ref

string

Optional notes ref to target. A bare name like reviews is placed under refs/notes/; a fully-qualified refs/notes/* ref is also accepted. Defaults to refs/notes/commits. Provide notes_ref or the deprecated ref.

Example:

"refs/notes/commits"

object_ref

string

Git object the note attaches to: a full object SHA (a commit, tree, blob, or annotated tag), or a branch, tag, or other revision that resolves to a commit. Provide object_ref or the deprecated sha.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

ref

string

deprecated

Deprecated: use notes_ref. Optional notes ref to target.

Example:

"refs/notes/commits"

sha

string

deprecated

Deprecated: use object_ref. Git object SHA to attach the note to.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

Response

Note update applied to the notes ref.

Result of a notes write operation, including the resulting notes ref state.

new_ref_sha

string

required

New notes ref SHA after the operation.

Example:

"3a1d9f7d6b6d482c970554e2a6ef980ecf4f1d55"

notes_ref

string

required

The notes ref the operation updates.

Example:

"refs/notes/commits"

result

object

required

Operation result with success, status, and optional message.

Show child attributes

sha

string

required

The commit SHA the note is attached to.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

target_ref

string

required

deprecated

Deprecated: use notes_ref. The notes ref the operation updates.

Example:

"refs/notes/commits"

base_commit

string

Previous notes ref commit SHA.

Example:

"0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"

Append Note

curl --request POST \
  --url https://api.{org}.code.storage/api/repos/{repo_name}/notes/append \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "author": {
    "email": "review@example.com",
    "name": "Review Bot"
  },
  "note": "Deployment complete.",
  "object_ref": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
'

import requests

url = "https://api.{org}.code.storage/api/repos/{repo_name}/notes/append"

payload = {
    "author": {
        "email": "review@example.com",
        "name": "Review Bot"
    },
    "note": "Deployment complete.",
    "object_ref": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
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({
    author: {email: 'review@example.com', name: 'Review Bot'},
    note: 'Deployment complete.',
    object_ref: 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  })
};

fetch('https://api.{org}.code.storage/api/repos/{repo_name}/notes/append', 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.{org}.code.storage/api/repos/{repo_name}/notes/append",
  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([
    'author' => [
        'email' => 'review@example.com',
        'name' => 'Review Bot'
    ],
    'note' => 'Deployment complete.',
    'object_ref' => 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  ]),
  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.{org}.code.storage/api/repos/{repo_name}/notes/append"

	payload := strings.NewReader("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\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.{org}.code.storage/api/repos/{repo_name}/notes/append")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{org}.code.storage/api/repos/{repo_name}/notes/append")

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  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"note\": \"Deployment complete.\",\n  \"object_ref\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}"

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

{
  "base_commit": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "new_ref_sha": "3a1d9f7d6b6d482c970554e2a6ef980ecf4f1d55",
  "notes_ref": "refs/notes/commits",
  "result": {
    "status": "ok",
    "success": true
  },
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Getting Started

Platform

Workflows

Libraries

API Reference

Authorizations

Path Parameters

Body

Response