Skip to content

stopwatch

Accessed as client.repos.issues.stopwatch; the async client mirrors it.

ReposIssuesStopwatch

The repos.issues.stopwatch namespace.

delete

delete(owner: str, repo: str, index: int) -> None

Delete an issue's existing stopwatch.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to stop the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot cancel a non existent stopwatch.

Operation ID: issueDeleteStopWatch

start

start(owner: str, repo: str, index: int) -> None

Start stopwatch on an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to create the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot start a stopwatch again if it already exists.

Operation ID: issueStartStopWatch

stop

stop(owner: str, repo: str, index: int) -> None

Stop an issue's existing stopwatch.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to stop the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot stop a non existent stopwatch.

Operation ID: issueStopStopWatch

AsyncReposIssuesStopwatch

The repos.issues.stopwatch namespace.

delete

delete(owner: str, repo: str, index: int) -> None

Delete an issue's existing stopwatch.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to stop the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot cancel a non existent stopwatch.

Operation ID: issueDeleteStopWatch

start

start(owner: str, repo: str, index: int) -> None

Start stopwatch on an issue.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to create the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot start a stopwatch again if it already exists.

Operation ID: issueStartStopWatch

stop

stop(owner: str, repo: str, index: int) -> None

Stop an issue's existing stopwatch.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
index int

index of the issue to stop the stopwatch on

required

Returns:

Type Description
None

No content.

Raises:

Type Description
ForbiddenError
  1. Not repo writer, user does not have rights to toggle stopwatch.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. Cannot stop a non existent stopwatch.

Operation ID: issueStopStopWatch