Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PullRequest

Pull Request containing the diff between a review branch and a destination branch

Properties

compartmentId

compartmentId: string

Compartment Identifier

createdBy

createdBy: PrincipalDetails

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

Optional description

description: undefined | string

Details of the pull request. Avoid entering confidential information.

destinationBranch

destinationBranch: string

The destination branch against which the changes are to be reviewed. Example: "main".

displayName

displayName: string

PullRequest title, can be renamed

freeformTags

freeformTags: object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {@code {"bar-key": "value"}}

Type declaration

  • [key: string]: string

id

id: string

Unique identifier that is immutable on creation

lifecycleDetails

lifecycleDetails: LifecycleDetails

The status of the Pull Request.

lifecycleState

lifecycleState: LifecycleState

The current state of the PullRequest.

Optional mergeBaseCommitIdAtTermination

mergeBaseCommitIdAtTermination: undefined | string

The merge base commit ID when the Pull Request status was last changed to merged or closed

Optional mergeChecks

mergeChecks: model.MergeCheckCollection

Optional mergedBy

mergedBy: model.PrincipalDetails

repositoryId

repositoryId: string

DevOps Repository Identifier tells which repository this pull request belongs to

Optional reviewers

reviewers: Array<Reviewer>

List of Reviewers.

sourceBranch

sourceBranch: string

The source branch which contains the changes to be reviewed. Example: "feature/JIRA-123"

Optional sourceCommitIdAtTermination

sourceCommitIdAtTermination: undefined | string

The source branch commit ID when the Pull Request status was last changed to merged or closed

Optional sourceRepositoryId

sourceRepositoryId: undefined | string

The OCID of the forked repository that will act as the source of the changes to be included in the pull request against the parent repository.

systemTags

systemTags: object

Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

timeCreated

timeCreated: Date

The time the PullRequest was created. An RFC3339 formatted datetime string

Optional timeUpdated

timeUpdated: Date

The time the PullRequest was updated. An RFC3339 formatted datetime string

totalComments

totalComments: number

The total number of comments on the pull request. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalReviewers

totalReviewers: number

The total number of reviewers on the pull request. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj