repos.commits.list

GET

api

repos

{repo_name}

commits

TypeScript

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

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

for await (const commit of pierre.repos.commits.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  path: 'docs/guide.md',
  ref: 'main',
})) {
  console.log(commit);
}

from pierre import Pierre

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

for commit in pierre.repos.commits.list(
    repo_name="my-demo-repository",
    limit=20,
    path="docs/guide.md",
    ref="main",
):
    print(commit)

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.Commits.List(ctx, pierre.ReposCommitsListParams{
	RepoName: "my-demo-repository",
	Limit:    pierre.Int(20),
	Path:     pierre.String("docs/guide.md"),
	Ref:      pierre.String("main"),
})
if err != nil {
	return err
}
for commit, err := range page.All(ctx) {
	if err != nil {
		return err
	}
	fmt.Println(commit)
}

{
  "commits": [
    {
      "author_email": "jane@example.com",
      "author_name": "Jane Doe",
      "committer_date": "2024-01-16T09:05:41Z",
      "committer_email": "jane@example.com",
      "committer_name": "Jane Doe",
      "date": "2024-01-15T14:32:18Z",
      "message": "fix: resolve scrolling issue in dashboard",
      "parent_shas": [
        "f4f9df3b8db66c73f6bf67e8f8f4f14f6522731e"
      ],
      "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
      "signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----\n"
    }
  ],
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"
}

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

ref

string

Optional branch, tag, or commit to list commits from. When omitted, the repository default branch is used. Provide ref or the deprecated branch.

branch

string

Deprecated: use ref instead. Optional branch name to list commits from. When omitted, the repository default branch is used.

path

string

Optional repository-relative path to scope the history to commits that touched that path.

cursor

string

Pagination cursor returned by a previous list_commits response.

limit

integer

default:20

Maximum number of commits to return. Defaults to 20.

ephemeral

boolean

Whether ref should be resolved from the ephemeral namespace.

Response

Commit history ordered from newest to oldest.

Paginated commit history for the repository, optionally filtered by branch.

commits

object[]

required

List of commit objects.

Show child attributes

has_more

boolean

required

Whether another page is available.

Example:

true

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 commit of pierre.repos.commits.list({
  repo_name: 'my-demo-repository',
  limit: 20,
  path: 'docs/guide.md',
  ref: 'main',
})) {
  console.log(commit);
}

from pierre import Pierre

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

for commit in pierre.repos.commits.list(
    repo_name="my-demo-repository",
    limit=20,
    path="docs/guide.md",
    ref="main",
):
    print(commit)

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.Commits.List(ctx, pierre.ReposCommitsListParams{
	RepoName: "my-demo-repository",
	Limit:    pierre.Int(20),
	Path:     pierre.String("docs/guide.md"),
	Ref:      pierre.String("main"),
})
if err != nil {
	return err
}
for commit, err := range page.All(ctx) {
	if err != nil {
		return err
	}
	fmt.Println(commit)
}

{
  "commits": [
    {
      "author_email": "jane@example.com",
      "author_name": "Jane Doe",
      "committer_date": "2024-01-16T09:05:41Z",
      "committer_email": "jane@example.com",
      "committer_name": "Jane Doe",
      "date": "2024-01-15T14:32:18Z",
      "message": "fix: resolve scrolling issue in dashboard",
      "parent_shas": [
        "f4f9df3b8db66c73f6bf67e8f8f4f14f6522731e"
      ],
      "sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
      "signature": "-----BEGIN PGP SIGNATURE-----\n...\n-----END PGP SIGNATURE-----\n"
    }
  ],
  "has_more": true,
  "next_cursor": "MTcwNzU3MzQ1MTAwMDAwMDAwMHxyZXBvXzlhNGMyMWY"
}

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