Notes Delete

DELETE

api

repos

notes

Notes Delete

curl --request DELETE \
  --url https://api.{cluster}.code.storage/api/v1/repos/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "author": {
    "email": "review@example.com",
    "name": "Review Bot"
  },
  "ref": "refs/notes/commits",
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
'

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/notes"

payload = {
    "author": {
        "email": "review@example.com",
        "name": "Review Bot"
    },
    "ref": "refs/notes/commits",
    "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    author: {email: 'review@example.com', name: 'Review Bot'},
    ref: 'refs/notes/commits',
    sha: 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  })
};

fetch('https://api.{cluster}.code.storage/api/v1/repos/notes', 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.{cluster}.code.storage/api/v1/repos/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'author' => [
        'email' => 'review@example.com',
        'name' => 'Review Bot'
    ],
    'ref' => 'refs/notes/commits',
    'sha' => '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.{cluster}.code.storage/api/v1/repos/notes"

	payload := strings.NewReader("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.{cluster}.code.storage/api/v1/repos/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/notes")

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

request = Net::HTTP::Delete.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  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}"

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

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

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

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

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

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

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

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

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

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Delete the Git note for the supplied SHA. Set ref to target a notes ref other than refs/notes/commits; a bare name like reviews is accepted and placed under refs/notes/. note and action are ignored for DELETE requests.

Notes write request describing the commit, the action (add, append, or remove), the note content, and optional concurrency guard.

sha

string

required

Git object SHA to attach the note to.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

action

string

default:add

add creates a note and fails if one already exists. append adds new text to the existing note body.

author

object

Author object with name and email for the notes commit.

Show child attributes

expected_ref_sha

string

Optional compare-and-swap guard for the notes ref.

note

string

Plain-text note content. Required for add and append.

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.

Example:

"refs/notes/commits"

Response

Note removed from 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"

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

The notes reference (refs/notes/commits).

Example:

"refs/notes/commits"

base_commit

string

Previous notes ref commit SHA.

Example:

"0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"

List Notes RefsList Git notes refs under a notes ref prefix with cursor pagination. Use this to discover custom notes namespaces before reading individual notes. #### JWT claims Required scopes: `git:read` Requires per repo scope: Yes Deprecated: Use `/api/repos/{repo_name}/notes/refs` instead.

Notes Delete

curl --request DELETE \
  --url https://api.{cluster}.code.storage/api/v1/repos/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "author": {
    "email": "review@example.com",
    "name": "Review Bot"
  },
  "ref": "refs/notes/commits",
  "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
'

import requests

url = "https://api.{cluster}.code.storage/api/v1/repos/notes"

payload = {
    "author": {
        "email": "review@example.com",
        "name": "Review Bot"
    },
    "ref": "refs/notes/commits",
    "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    author: {email: 'review@example.com', name: 'Review Bot'},
    ref: 'refs/notes/commits',
    sha: 'b003fc78805954584e1ee364a4ad39d7c79e819a'
  })
};

fetch('https://api.{cluster}.code.storage/api/v1/repos/notes', 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.{cluster}.code.storage/api/v1/repos/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'author' => [
        'email' => 'review@example.com',
        'name' => 'Review Bot'
    ],
    'ref' => 'refs/notes/commits',
    'sha' => '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.{cluster}.code.storage/api/v1/repos/notes"

	payload := strings.NewReader("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.{cluster}.code.storage/api/v1/repos/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"author\": {\n    \"email\": \"review@example.com\",\n    \"name\": \"Review Bot\"\n  },\n  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/v1/repos/notes")

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

request = Net::HTTP::Delete.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  \"ref\": \"refs/notes/commits\",\n  \"sha\": \"b003fc78805954584e1ee364a4ad39d7c79e819a\"\n}"

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

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

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

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

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

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

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

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

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

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

Getting Started

Guides

Reference

JWT claims

Authorizations

Body

Response