jira.js
    Preparing search index...

    Function storeDevelopmentInformation

    • Stores development information provided in the request to make it available when viewing issues in Jira. Existing repository and entity data for the same ID will be replaced if the updateSequenceId of existing data is less than the incoming data. Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times.

      Parameters

      • client: Client
      • parameters: {
            operationType?: string & {} | "NORMAL" | "BACKFILL";
            preventTransitions?: boolean;
            properties?: Record<string, any>;
            providerMetadata?: { product?: string };
            repositories: {
                avatar?: string;
                avatarDescription?: string;
                branches?: {
                    associations?: {
                        associationType: (...) & (...) | "issueKeys" | "issueIdOrKeys";
                        values: string[];
                        [key: string]: unknown;
                    }[];
                    createPullRequestUrl?: string;
                    id: string;
                    lastCommit: {
                        author: {
                            avatar?: string;
                            email?: string;
                            name?: string;
                            url?: string;
                            username?: string;
                        };
                        authorTimestamp: string;
                        displayId: string;
                        fileCount: number;
                        files?: {
                            changeType: (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                            linesAdded: number;
                            linesRemoved: number;
                            path: string;
                            url: string;
                        }[];
                        flags?: ((...) & (...) | "MERGE_COMMIT")[];
                        id: string;
                        issueKeys: string[];
                        message: string;
                        updateSequenceId: number;
                        url: string;
                    };
                    name: string;
                    updateSequenceId: number;
                    url: string;
                }[];
                commits?: {
                    associations?: {
                        associationType: (...) & (...)
                        | "issueKeys"
                        | "issueIdOrKeys";
                        values: string[];
                        [key: string]: unknown;
                    }[];
                    author: {
                        avatar?: string;
                        email?: string;
                        name?: string;
                        url?: string;
                        username?: string;
                    };
                    authorTimestamp: string;
                    displayId: string;
                    fileCount: number;
                    files?: {
                        changeType: | (...) & (...)
                        | "ADDED"
                        | "COPIED"
                        | "DELETED"
                        | "MODIFIED"
                        | "MOVED"
                        | "UNKNOWN";
                        linesAdded: number;
                        linesRemoved: number;
                        path: string;
                        url: string;
                    }[];
                    flags?: (string & {} | "MERGE_COMMIT")[];
                    id: string;
                    message: string;
                    updateSequenceId: number;
                    url: string;
                }[];
                description?: string;
                forkOf?: string;
                id: string;
                name: string;
                pullRequests?: {
                    associations?: {
                        associationType: (...) & (...)
                        | "issueKeys"
                        | "issueIdOrKeys";
                        values: string[];
                        [key: string]: unknown;
                    }[];
                    author: {
                        avatar?: string;
                        email?: string;
                        name?: string;
                        url?: string;
                        username?: string;
                    };
                    commentCount: number;
                    destinationBranch?: string;
                    destinationBranchUrl?: string;
                    displayId: string;
                    id: string;
                    lastUpdate: string;
                    reviewers?: {
                        accountId?: string;
                        approvalStatus?: (...) & (...)
                        | "APPROVED"
                        | "UNAPPROVED";
                        avatar?: string;
                        email?: string;
                        name?: string;
                        url?: string;
                    }[];
                    sourceBranch: string;
                    sourceBranchUrl?: string;
                    status: string & {}
                    | "OPEN"
                    | "UNKNOWN"
                    | "MERGED"
                    | "DECLINED";
                    title: string;
                    updateSequenceId: number;
                    url: string;
                }[];
                updateSequenceId: number;
                url: string;
            }[];
        }
        • OptionaloperationType?: string & {} | "NORMAL" | "BACKFILL"

          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.

        • OptionalpreventTransitions?: boolean

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

        • Optionalproperties?: Record<string, any>

          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.

        • OptionalproviderMetadata?: { 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.

          • Optionalproduct?: string

            An optional name of the source of the development information data.

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

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              acceptedDevinfoEntities?: Record<string, any>;
              failedDevinfoEntities?: Record<string, any>;
              unknownAssociations?: {
                  associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              unknownIssueKeys?: string[];
              [key: string]: unknown;
          },
      >