repos.blame.get

GET

api

repos

{repo_name}

blame

TypeScript

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

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

const blame = await pierre.repos.blame.get({
  repo_name: 'my-demo-repository',
  path: 'src/main.go',
  range: ['10,20'],
  ref: 'main',
});
console.log(blame);

from pierre import Pierre

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

blame = pierre.repos.blame.get(
    repo_name="my-demo-repository",
    path="src/main.go",
    range=["10,20"],
    ref="main",
)
print(blame)

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
}
blame, err := client.Repos.Blame.Get(ctx, pierre.ReposBlameGetParams{
	RepoName: "my-demo-repository",
	Path:     "src/main.go",
	Range:    pierre.Value([]string{"10,20"}),
	Ref:      pierre.String("main"),
})
if err != nil {
	return err
}
fmt.Println(blame)

{
  "commit_sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
  "lines": [
    {
      "author_email": "jane@example.com",
      "author_name": "Jane Doe",
      "author_time": "2024-01-15T14:32:18Z",
      "commit_sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
      "committer_email": "jane@example.com",
      "committer_name": "Jane Doe",
      "committer_time": "2024-01-15T14:32:18Z",
      "line_number": 42,
      "original_line_number": 40,
      "original_path": "src/main.go",
      "previous_commit_sha": "a4d39d7c79e819ab003fc78805954584e1ee36",
      "summary": "fix: resolve scrolling issue in dashboard"
    }
  ],
  "path": "src/main.go",
  "ref": "main"
}

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

path

string

required

Repository-relative file path to blame.

ref

string

Optional branch, tag, or commit SHA to blame at. When omitted, the repository default branch is used.

ephemeral

boolean

Whether ref should be resolved from the ephemeral namespace.

range

string[]

Optional git blame -L-style range spec. May be repeated to blame multiple regions (max 16). Each value is one -L argument: e.g. 10,20, 10,+5, /getUser/,/^}/, /getUser/,+30, 10,, ,20, 10, :^func .*Foo, :funcname.

detect_moves

boolean

Follow the file across renames and copies.

Response

Per-line blame for the resolved file revision.

Per-line blame information for the requested file at the resolved revision.

commit_sha

string

required

Commit SHA the blame was computed at.

Example:

"b003fc78805954584e1ee364a4ad39d7c79e819a"

lines

object[]

required

Per-line blame results in file order.

Show child attributes

path

string

required

Repository-relative file path that was blamed.

Example:

"src/main.go"

ref

string

required

Resolved ref used for the blame.

Example:

"main"

TypeScript

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

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

const blame = await pierre.repos.blame.get({
  repo_name: 'my-demo-repository',
  path: 'src/main.go',
  range: ['10,20'],
  ref: 'main',
});
console.log(blame);

from pierre import Pierre

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

blame = pierre.repos.blame.get(
    repo_name="my-demo-repository",
    path="src/main.go",
    range=["10,20"],
    ref="main",
)
print(blame)

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
}
blame, err := client.Repos.Blame.Get(ctx, pierre.ReposBlameGetParams{
	RepoName: "my-demo-repository",
	Path:     "src/main.go",
	Range:    pierre.Value([]string{"10,20"}),
	Ref:      pierre.String("main"),
})
if err != nil {
	return err
}
fmt.Println(blame)

{
  "commit_sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
  "lines": [
    {
      "author_email": "jane@example.com",
      "author_name": "Jane Doe",
      "author_time": "2024-01-15T14:32:18Z",
      "commit_sha": "b003fc78805954584e1ee364a4ad39d7c79e819a",
      "committer_email": "jane@example.com",
      "committer_name": "Jane Doe",
      "committer_time": "2024-01-15T14:32:18Z",
      "line_number": 42,
      "original_line_number": 40,
      "original_path": "src/main.go",
      "previous_commit_sha": "a4d39d7c79e819ab003fc78805954584e1ee36",
      "summary": "fix: resolve scrolling issue in dashboard"
    }
  ],
  "path": "src/main.go",
  "ref": "main"
}

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