Tasks

On this page, we'll dive into the Task model.

The Task model

The Task model contains the metadata of the work to be done to collect the bounty, such as resolving a bug, implementing a new feature or submitting a code review.

Required properties

Name: id
Type: string
Description: Unique identifier for the object.

Name

forge

Type

string

Description

Platform where the task to be done resides.

Can be one of: github

If you'd like to use another forge, please get in touch with us.

Name: repo_owner
Type: string
Description: Owner of the repository.

Name: repo_name
Type: string
Description: Name of the repository.

Name: number
Type: integer
Description: Number of the issue/pull request.

Name

source

Type

object

Description

The type of source is the discriminated union of the following types.

{ type: "unknown" }

{ type: "issue", data: Issue }

{ type: "pull_request", data: Pull Request }

The unknown case is returned if and only if the source is currently being fetched (which happens asynchronously after the bounty is created) or it couldn't be fetched at all.