repos.notes.delete

DELETE

api

repos

{repo_name}

notes

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const result = await pierre.repos.notes.delete({
  repo_name: 'my-demo-repository',
  expected_notes_ref_sha: '0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492',
  notes_ref: 'refs/notes/commits',
  object_ref: 'b003fc78805954584e1ee364a4ad39d7c79e819a',
});
console.log(result);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

result = pierre.repos.notes.delete(
    repo_name="my-demo-repository",
    expected_notes_ref_sha="0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
    notes_ref="refs/notes/commits",
    object_ref="b003fc78805954584e1ee364a4ad39d7c79e819a",
)
print(result)

import (
	"context"
	"fmt"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
result, err := client.Repos.Notes.Delete(ctx, pierre.ReposNotesDeleteParams{
	RepoName:            "my-demo-repository",
	ExpectedNotesRefSHA: pierre.String("0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"),
	NotesRef:            pierre.String("refs/notes/commits"),
	ObjectRef:           pierre.String("b003fc78805954584e1ee364a4ad39d7c79e819a"),
})
if err != nil {
	return err
}
fmt.Println(result)

pierre repos:notes delete \
  --repo-name my-demo-repository \
  --expected-notes-ref-sha 0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492 \
  --notes-ref refs/notes/commits \
  --object-ref b003fc78805954584e1ee364a4ad39d7c79e819a

curl -X DELETE \
  "https://api.{org}.code.storage/api/repos/my-demo-repository/notes?expected_notes_ref_sha=0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492&notes_ref=refs/notes/commits&object_ref=b003fc78805954584e1ee364a4ad39d7c79e819a" \
  -H "Authorization: Bearer $PIERRE_TOKEN"

{
  "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>",
  "invalid_params": [
    {
      "name": "deployment.production_branch",
      "reason": "exceeds 255 characters"
    }
  ]
}

{
  "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.

Scopes

git:write

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

Query Parameters

object_ref

string

Git object whose note should be deleted: a full object SHA (a commit, tree, blob, or annotated tag), or a branch, tag, or other revision that resolves to a commit. Required unless the deprecated body names the object.

notes_ref

string

Optional notes ref to delete from. A bare name like reviews is placed under refs/notes/; a fully-qualified refs/notes/* ref is also accepted. Defaults to refs/notes/commits.

expected_notes_ref_sha

string

Optional compare-and-swap guard: the notes ref SHA that you read before the delete. The delete fails with 409 when the notes ref has a different SHA.

Body

application/json

Deprecated: send the object_ref, notes_ref, and expected_notes_ref_sha query parameters, and no body. A query parameter wins over its body field.

Deprecated delete-note body. Use the object_ref, notes_ref, and expected_notes_ref_sha query parameters.

action

string

deprecated

Deprecated: a delete ignores action.

author

object

deprecated

Deprecated: no replacement. Without author, the notes commit of a delete has the default author. Author object with name and email for the notes commit.

Show child attributes

expected_notes_ref_sha

string

deprecated

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

expected_ref_sha

string

deprecated

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

note

string

deprecated

Deprecated: a delete ignores note.

notes_ref

string

deprecated

Deprecated: use the notes_ref query parameter. Optional notes ref to target.

Example:

"refs/notes/commits"

object_ref

string

deprecated

Deprecated: use the object_ref query parameter. Git object the note attaches to.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

ref

string

deprecated

Deprecated: use the notes_ref query parameter. Optional notes ref to target.

Example:

"refs/notes/commits"

sha

string

deprecated

Deprecated: use the object_ref query parameter. Git object SHA the note attaches to.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

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"

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"

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const result = await pierre.repos.notes.delete({
  repo_name: 'my-demo-repository',
  expected_notes_ref_sha: '0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492',
  notes_ref: 'refs/notes/commits',
  object_ref: 'b003fc78805954584e1ee364a4ad39d7c79e819a',
});
console.log(result);

from pierre import Pierre

# The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
pierre = Pierre()

result = pierre.repos.notes.delete(
    repo_name="my-demo-repository",
    expected_notes_ref_sha="0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
    notes_ref="refs/notes/commits",
    object_ref="b003fc78805954584e1ee364a4ad39d7c79e819a",
)
print(result)

import (
	"context"
	"fmt"

	pierre "github.com/pierrecomputer/sdk/go"
)

ctx := context.Background()
// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
client, err := pierre.NewClient()
if err != nil {
	return err
}
result, err := client.Repos.Notes.Delete(ctx, pierre.ReposNotesDeleteParams{
	RepoName:            "my-demo-repository",
	ExpectedNotesRefSHA: pierre.String("0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"),
	NotesRef:            pierre.String("refs/notes/commits"),
	ObjectRef:           pierre.String("b003fc78805954584e1ee364a4ad39d7c79e819a"),
})
if err != nil {
	return err
}
fmt.Println(result)

pierre repos:notes delete \
  --repo-name my-demo-repository \
  --expected-notes-ref-sha 0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492 \
  --notes-ref refs/notes/commits \
  --object-ref b003fc78805954584e1ee364a4ad39d7c79e819a

curl -X DELETE \
  "https://api.{org}.code.storage/api/repos/my-demo-repository/notes?expected_notes_ref_sha=0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492&notes_ref=refs/notes/commits&object_ref=b003fc78805954584e1ee364a4ad39d7c79e819a" \
  -H "Authorization: Bearer $PIERRE_TOKEN"

{
  "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>",
  "invalid_params": [
    {
      "name": "deployment.production_branch",
      "reason": "exceeds 255 characters"
    }
  ]
}

{
  "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

Scopes

Path Parameters

Query Parameters

Body

Response