Interface Repository

Repository

Represents a repository, containing development information such as commits, pull requests, and branches.

interface Repository {
    avatar?: string;
    avatarDescription?: string;
    branches?: Branch[];
    commits?: Commit[];
    description?: string;
    forkOf?: string;
    id: string;
    name: string;
    pullRequests?: PullRequest[];
    updateSequenceId: number;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • Repository

Properties

avatar? avatarDescription? branches? commits? description? forkOf? id name pullRequests? updateSequenceId url

Properties

Optionalavatar

avatar?: string

The URL of the avatar for this repository. Max length is 2000 characters.

Example

http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32

OptionalavatarDescription

avatarDescription?: string

Description of the avatar for this repository. Max length is 1024 characters.

Example

Avatar description

Optionalbranches

branches?: Branch[]

List of branches to update in this repository. Must not contain duplicate entity IDs. Maximum number of branches is 400.

Optionalcommits

commits?: Commit[]

List of commits to update in this repository. Must not contain duplicate entity IDs. Maximum number of commits is 400

Optionaldescription

description?: string

Description of this repository. Max length is 1024 characters.

Example

The repository which stores code of the Atlassian Connect Add-on Devinfo application.

OptionalforkOf

forkOf?: string

The ID of the repository this repository was forked from, if it's a fork. Max length is 1024 characters.

Example

56c7c750-cee2-48e2-b920-d7706dfd11f7

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

name

name: string

The name of this repository. Max length is 255 characters.

Example

atlassian-connect-jira-example

OptionalpullRequests

pullRequests?: PullRequest[]

List of pull requests to update in this repository. Must not contain duplicate entity IDs. Maximum number of pull requests is 400

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 this repository. Max length is 2000 characters.

Example

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

Settings

Member Visibility

On This Page

Properties