Interface Branch

Branch

Represents a branch in the version control system

interface Branch {
    createPullRequestUrl?: string;
    id: string;
    issueKeys: string[];
    lastCommit: Commit;
    name: string;
    updateSequenceId: number;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • Branch

Properties

createPullRequestUrl? id issueKeys lastCommit name updateSequenceId url

Properties

OptionalcreatePullRequestUrl

createPullRequestUrl?: string

The URL of the page for creating a pull request from this branch. Max length is 2000 characters.

Example

https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new

id

id: string

The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.

Example

c6c7c750-cee2-48e2-b920-d7706dfd11f9

issueKeys

issueKeys: string[]

List of issues keys that this entity is associated with. They must be valid Jira issue keys.

Example

[
  "ISSUE-1",
  "TEST-2"
]

lastCommit

lastCommit: Commit

Commit

Represents a commit in the version control system.

name

name: string

The name of the branch. Max length is 512 characters.

Example

master

updateSequenceId

updateSequenceId: number

An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

Example

1523494301248

url

url: string

The URL of the branch. Max length is 2000 characters.

Example

https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master

Settings

Member Visibility

On This Page

Properties