GetRepository | /src/agile/models/getRepository.ts | jira@v3.0.2

interface GetRepository

import { type GetRepository } from "https://deno.land/x/jira@v3.0.2/src/agile/models/getRepository.ts";

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

Properties

name: string

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

optional

description: string

Description of this repository. Max length is 1024 characters.

optional

forkOf: string

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

url: string

The URL of this repository. Max length is 2000 characters.

optional

commits: { id: string; issueKeys: string[]; updateSequenceId: number; flags?: string[]; message: string; author: { email?: string; }; fileCount: number; url: string; files?: { path: string; url: string; changeType: string; linesAdded: number; linesRemoved: number; }[]; authorTimestamp: string; displayId: string; }[]

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

optional

branches: { id: string; issueKeys: string[]; updateSequenceId: number; name: string; lastCommit: { id: string; issueKeys: string[]; updateSequenceId: number; flags?: string[]; message: string; author: { email?: string; }; fileCount: number; url: string; files?: { path: string; url: string; changeType: string; linesAdded: number; linesRemoved: number; }[]; authorTimestamp: string; displayId: string; }; createPullRequestUrl?: string; url: string; }[]

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

optional

pullRequests: { id: string; issueKeys: string[]; updateSequenceId: number; status: string; title: string; author: { email?: string; }; commentCount: number; sourceBranch: string; sourceBranchUrl?: string; lastUpdate: string; destinationBranch?: string; destinationBranchUrl?: string; reviewers?: { approvalStatus?: string; email?: string; accountId?: string; }[]; url: string; displayId: string; }[]

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

optional

avatar: string

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

optional

avatarDescription: string

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

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.

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.