1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. GetUpdateTimelineResponse

GetUpdateTimelineResponse

    GetUpdateTimelineResponse is the response type returning the timeline for a given update.

    Properties

    • update UpdateInfo required
      Update is the information about the completed update for the stack.
    • ↳ info AppUpdateInfo required
      The underlying update information from the Pulumi CLI.
    • ↳ updateID string required
      UpdateID is the underlying Update’s ID on the PPC.
    • ↳ githubCommitInfo GitHubCommitInfo optional

      If the update’s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update.

      May not be set depending on which API is used to obtain the UpdateInfo object.

    • ↳ version integer required
      Version of the stack that this UpdateInfo describe.
    • ↳ latestVersion integer required
      LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.
    • ↳ requestedBy UserInfo required
      The user who requested the update.
    • ↳ policyPacks array[AppPolicyPackMetadata] optional
      The Policy Packs that were required for this update.
    • ↳ requestedByToken string optional
      The access token used to request the update, if applicable.
    • collatedUpdateEvents array[UpdateInfo] required

      CollatedUpdateEvents is the set of update events that are “relevant” to the update. It will contain the sequences of previews that were performed in the same “group”, e.g. a GitHub PR, that lead to the final update.

      If the sequence of previews happened spanned when the stack was updated, e.g. the first preview was at version N - 1 and the last preview was at version N + 1, then the update to stack version N will be included.

      Will be empty if the update couldn’t be associated with a particular sequence of previews.

    • ↳ info AppUpdateInfo required
      The underlying update information from the Pulumi CLI.
    • ↳ updateID string required
      UpdateID is the underlying Update’s ID on the PPC.
    • ↳ githubCommitInfo GitHubCommitInfo optional

      If the update’s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update.

      May not be set depending on which API is used to obtain the UpdateInfo object.

    • ↳ version integer required
      Version of the stack that this UpdateInfo describe.
    • ↳ latestVersion integer required
      LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.
    • ↳ requestedBy UserInfo required
      The user who requested the update.
    • ↳ policyPacks array[AppPolicyPackMetadata] optional
      The Policy Packs that were required for this update.
    • ↳ requestedByToken string optional
      The access token used to request the update, if applicable.
    • collatedPullRequest GitHubPullRequest optional
      CollatedPullRequest is the source pull request that was merged, which triggered the stack’s update.
    • ↳ title string required
      The title of the pull request
    • ↳ number integer required
      The pull request number
    • ↳ repoSlug string required
      The repository slug in owner/repo format
    • ↳ createdAt integer required
      Unix epoch timestamp (seconds) of when the PR was created.
    • ↳ closedAt integer optional
      Unix epoch timestamp (seconds) of when the PR was closed. Null if the PR is still open.
    • ↳ wasMerged boolean required
      Whether the PR was merged
    • ↳ sourceRef string required
      The source branch reference
    • ↳ targetRef string required
      The target branch reference
    • ↳ mergeCommitSHA string optional
      The SHA of the merge commit, if the PR was merged
    • previews array[UpdateInfo] required
      Previews contains all previews for the given stack update that weren’t part of the collated set. For example, from other GitHub pull requests that haven’t been merged, previews ran on developer machines, etc.
    • ↳ info AppUpdateInfo required
      The underlying update information from the Pulumi CLI.
    • ↳ updateID string required
      UpdateID is the underlying Update’s ID on the PPC.
    • ↳ githubCommitInfo GitHubCommitInfo optional

      If the update’s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update.

      May not be set depending on which API is used to obtain the UpdateInfo object.

    • ↳ version integer required
      Version of the stack that this UpdateInfo describe.
    • ↳ latestVersion integer required
      LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.
    • ↳ requestedBy UserInfo required
      The user who requested the update.
    • ↳ policyPacks array[AppPolicyPackMetadata] optional
      The Policy Packs that were required for this update.
    • ↳ requestedByToken string optional
      The access token used to request the update, if applicable.