repos.notes.get

GET

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 note = await pierre.repos.notes.get({
  repo_name: 'my-demo-repository',
  notes_ref: 'refs/notes/commits',
  object_ref: 'b003fc78805954584e1ee364a4ad39d7c79e819a',
});
console.log(note);

from pierre import Pierre

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

note = pierre.repos.notes.get(
    repo_name="my-demo-repository",
    notes_ref="refs/notes/commits",
    object_ref="b003fc78805954584e1ee364a4ad39d7c79e819a",
)
print(note)

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
}
note, err := client.Repos.Notes.Get(ctx, pierre.ReposNotesGetParams{
	RepoName:  "my-demo-repository",
	NotesRef:  pierre.String("refs/notes/commits"),
	ObjectRef: pierre.String("b003fc78805954584e1ee364a4ad39d7c79e819a"),
})
if err != nil {
	return err
}
fmt.Println(note)

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

{
  "note": "Reviewed. Ready for production.",
  "ref_sha": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "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.

Scopes

git:read

Path Parameters

repo_name

string

required

The repository name, for example acme/web.

Query Parameters

object_ref

string

Git object whose note should be fetched. A full object SHA today. Provide object_ref or the deprecated sha.

sha

string

Deprecated: use object_ref instead. Git object SHA whose note should be fetched.

notes_ref

string

Optional notes ref to read 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. Provide notes_ref or the deprecated ref.

ref

string

Deprecated: use notes_ref instead. Optional notes ref to read from. Defaults to refs/notes/commits.

Response

The note stored for the requested Git object.

A single Git note attached to a commit, including the current notes ref tip.

note

string

required

The note content.

Example:

"Reviewed. Ready for production."

ref_sha

string

required

Current SHA of the notes ref the note was read from.

Example:

"0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492"

sha

string

required

The commit SHA.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

TypeScript

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

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

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

from pierre import Pierre

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

note = pierre.repos.notes.get(
    repo_name="my-demo-repository",
    notes_ref="refs/notes/commits",
    object_ref="b003fc78805954584e1ee364a4ad39d7c79e819a",
)
print(note)

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
}
note, err := client.Repos.Notes.Get(ctx, pierre.ReposNotesGetParams{
	RepoName:  "my-demo-repository",
	NotesRef:  pierre.String("refs/notes/commits"),
	ObjectRef: pierre.String("b003fc78805954584e1ee364a4ad39d7c79e819a"),
})
if err != nil {
	return err
}
fmt.Println(note)

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

{
  "note": "Reviewed. Ready for production.",
  "ref_sha": "0c8b5bb9d550d58fcfd651a4fdce8024ef7f1492",
  "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

Scopes

Path Parameters

Query Parameters

Response