repos.notes.refs.list

GET

api

repos

{repo_name}

notes

refs

TypeScript

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

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

for await (const ref of pierre.repos.notes.refs.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  prefix: 'reviews/',
})) {
  console.log(ref);
}

from pierre import Pierre

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

for ref in pierre.repos.notes.refs.list(
    repo_name="my-demo-repository",
    limit=20,
    prefix="reviews/",
):
    print(ref)

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
}
page, err := client.Repos.Notes.Refs.List(ctx, pierre.ReposNotesRefsListParams{
	RepoName: "my-demo-repository",
	Limit:    pierre.Int(20),
	Prefix:   pierre.String("reviews/"),
})
if err != nil {
	return err
}
for ref, err := range page.All(ctx) {
	if err != nil {
		return err
	}
	fmt.Println(ref)
}

{
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY",
  "prefix": "refs/notes/reviews/",
  "refs": [
    {
      "cursor": "refs/notes/reviews/session-a",
      "ref": "refs/notes/reviews/session-a",
      "sha": "a1b2c3d4e5f6"
    }
  ]
}

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

prefix

string

Notes ref prefix to enumerate. A bare prefix like reviews is placed under refs/notes/; a fully-qualified refs/notes/* prefix is also accepted. Defaults to refs/notes/.

cursor

string

Pagination cursor returned by a previous list_notes_refs response.

limit

integer

default:20

Maximum number of notes refs to return. Defaults to 20.

Response

Notes refs in lexical order.

Paginated list of Git notes refs under the requested prefix.

has_more

boolean

required

Whether another page is available.

Example:

true

prefix

string

required

Normalized notes ref prefix used for the listing.

Example:

"refs/notes/reviews/"

refs

object[]

required

List of notes refs.

Show child attributes

next_cursor

string

Opaque cursor for the next page. Pass it as cursor to read the next page. Absent when there are no more results.

Example:

"MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"

TypeScript

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

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

for await (const ref of pierre.repos.notes.refs.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  prefix: 'reviews/',
})) {
  console.log(ref);
}

from pierre import Pierre

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

for ref in pierre.repos.notes.refs.list(
    repo_name="my-demo-repository",
    limit=20,
    prefix="reviews/",
):
    print(ref)

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
}
page, err := client.Repos.Notes.Refs.List(ctx, pierre.ReposNotesRefsListParams{
	RepoName: "my-demo-repository",
	Limit:    pierre.Int(20),
	Prefix:   pierre.String("reviews/"),
})
if err != nil {
	return err
}
for ref, err := range page.All(ctx) {
	if err != nil {
		return err
	}
	fmt.Println(ref)
}

{
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY",
  "prefix": "refs/notes/reviews/",
  "refs": [
    {
      "cursor": "refs/notes/reviews/session-a",
      "ref": "refs/notes/reviews/session-a",
      "sha": "a1b2c3d4e5f6"
    }
  ]
}

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