Interface Branch

Branch refers to a VCS branch. Branches are feature branches associated with Shortcut Stories.

Hierarchy

  • Branch

Properties

created_at?: string

The time/date the Branch was created.

Format

date-time

deleted: boolean

A true/false boolean indicating if the Branch has been deleted.

entity_type: string

A string description of this resource.

id?: number

The unique ID of the Branch.

Format

int64

merged_branch_ids: number[]

The IDs of the Branches the Branch has been merged into.

name: string

The name of the Branch.

persistent: boolean

A true/false boolean indicating if the Branch is persistent; e.g. master.

pull_requests: PullRequest[]

An array of PullRequests attached to the Branch (there is usually only one).

repository_id: number

The ID of the Repository that contains the Branch.

Format

int64

updated_at?: string

The time/date the Branch was updated.

Format

date-time

url: string

The URL of the Branch.

Generated using TypeDoc