Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/agile/parameters/storeDevelopmentInformation.ts>StoreDevelopmentInformation

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface StoreDevelopmentInformation
import { type StoreDevelopmentInformation } from "https://deno.land/x/jira@v3.0.2/src/agile/parameters/storeDevelopmentInformation.ts";

Properties

optional
repositories: { name: string; description?: string; forkOf?: string; url: string; commits?: { id: string; issueKeys: string[]; updateSequenceId: number; flags?: ("MERGE_COMMIT" | string)[]; message: string; author: { email?: string; }; fileCount: number; url: string; files?: { path: string; url: string; changeType:
| "ADDED"
| "COPIED"
| "DELETED"
| "MODIFIED"
| "MOVED"
| "UNKNOWN"
| string
; linesAdded: number; linesRemoved: number; }[]; authorTimestamp: string; displayId: string; }[]; branches?: { id: string; issueKeys: string[]; updateSequenceId: number; name: string; lastCommit: { id: string; issueKeys: string[]; updateSequenceId: number; flags?: ("MERGE_COMMIT" | string)[]; message: string; author: { email?: string; }; fileCount: number; url: string; files?: { path: string; url: string; changeType:
| "ADDED"
| "COPIED"
| "DELETED"
| "MODIFIED"
| "MOVED"
| "UNKNOWN"
| string
; linesAdded: number; linesRemoved: number; }[]; authorTimestamp: string; displayId: string; }; createPullRequestUrl?: string; url: string; }[]; pullRequests?: { id: string; issueKeys: string[]; updateSequenceId: number; status:
| "OPEN"
| "MERGED"
| "DECLINED"
| "DRAFT"
| "UNKNOWN"
| string
; title: string; author: { email?: string; }; commentCount: number; sourceBranch: string; sourceBranchUrl?: string; lastUpdate: string; destinationBranch?: string; destinationBranchUrl?: string; reviewers?: { approvalStatus?:
| "APPROVED"
| "NEEDSWORK"
| "UNAPPROVED"
| string
; email?: string; accountId?: string; }[]; url: string; displayId: string; taskCount?: number; }[]; avatar?: string; avatarDescription?: string; id: string; updateSequenceId: number; }[]

List of repositories containing development information. Must not contain duplicates. Maximum number of entities across all repositories is 1000.

optional
preventTransitions: boolean

Flag to prevent automatic issue transitions and smart commits being fired, default is false.

optional
operationType: "NORMAL" | "BACKFILL" | string

Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during normal operation (e.g. a user pushing a branch). "BACKFILL" - Data received while backfilling existing data (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations.

optional
properties: { }

Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to e.g. clean up all development information associated with an account in the event that the account is removed from the provider system. Note that these properties will never be returned with repository or entity data. They are not intended for use as metadata to associate with a repository. Maximum length of each key or value is 255 characters. Maximum allowed number of properties key/value pairs is 5. Properties keys cannot start with '_' character. Properties keys cannot contain ':' character.

optional
providerMetadata: { product?: string; }

Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.