notes

Accessed as client.repos.git.notes; the async client mirrors it.

SyncAsync

ReposGitNotes

The repos.git.notes namespace.

delete

delete(owner: str, repo: str, sha: str) -> None

Removes a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoRemoveNote

get

get(owner: str, repo: str, sha: str, *, verification: bool | None = None, files: bool | None = None) -> Note

Get a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required
`verification`	`bool \| None`	include verification for every commit (disable for speedup, default 'true')	`None`
`files`	`bool \| None`	include a list of affected files for every commit (disable for speedup, default 'true')	`None`

Returns:

Type	Description
`Note`	Note.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoGetNote

set

set(owner: str, repo: str, sha: str, *, message: str | None = None) -> Note

Set a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required
`message`	`str \| None`		`None`

Returns:

Type	Description
`Note`	Note.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoSetNote

AsyncReposGitNotes

The repos.git.notes namespace.

delete

delete(owner: str, repo: str, sha: str) -> None

Removes a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoRemoveNote

get

get(owner: str, repo: str, sha: str, *, verification: bool | None = None, files: bool | None = None) -> Note

Get a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required
`verification`	`bool \| None`	include verification for every commit (disable for speedup, default 'true')	`None`
`files`	`bool \| None`	include a list of affected files for every commit (disable for speedup, default 'true')	`None`

Returns:

Type	Description
`Note`	Note.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoGetNote

set

set(owner: str, repo: str, sha: str, *, message: str | None = None) -> Note

Set a note corresponding to a single commit from a repository.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`sha`	`str`	a git ref or commit sha	required
`message`	`str \| None`		`None`

Returns:

Type	Description
`Note`	Note.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: repoSetNote