The identity and technical contract details declared by the specification.
BuildRunSummaryCollection
object
List of build run summary.
1 property
1 required
BuildPipelineStageSummary
object
Summary of the Stage.
15 properties
5 required
TriggerAction
object
The trigger action to be performed.
2 properties
1 required
DeploymentArgumentCollection
object
Specifies list of arguments passed along with the deployment.
1 property
1 required
DeployArtifactOverrideArgumentCollection
object
Specifies the list of artifact override arguments at the time of deployment.
1 property
1 required
ProjectSummary
object
Summary of the project.
13 properties
3 required
DeploymentExecutionProgress
object
The execution progress details of a deployment.
3 properties
ChangeProjectCompartmentDetails
object
The OCID of the compartment to which the project must be moved to.
1 property
1 required
SyncRepositoryDetails
object
Details required for syncing a repository with its upstream.
2 properties
2 required
RepositoryRefSummary
object
Summary of a reference.
7 properties
4 required
WorkRequestSummary
object
Details of the work request status.
9 properties
7 required
UpdateDeployEnvironmentDetails
object
The information to be updated.
5 properties
1 required
UpdateBuildPipelineStageDetails
object
The information to be updated.
6 properties
1 required
BuildPipelineParameter
object
Parameter name for which the values will be supplied at the time of running the build.
3 properties
2 required
ProtectedBranchSummary
object
Holds information used to restrict certain actions on branches
5 properties
2 required
DeployStageOverrideArgumentCollection
object
Specifies the list of arguments to be overriden per Stage at the time of deployment.
1 property
1 required
BuildPipelineParameterCollection
object
Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely.
1 property
1 required
UpdateProjectNotificationPreferenceDetails
object
Information to update notification preference settings on project resource
1 property
1 required
MergeStrategy
string
Merge strategies which can be enabled or disabled for a repository or project.
RepositoryRef
object
Reference object with name and commit ID.
6 properties
4 required
PullRequestAttachmentCollection
object
Result of list pullRequest attachment.
1 property
1 required
CancelDeploymentDetails
object
The information regarding the deployment to be canceled.
1 property
1 required
CreateBuildPipelineDetails
object
Information about the new build pipeline to be created.
6 properties
1 required
PullRequestAuthorSummary
object
Object containing summary of PR author.
1 property
1 required
DeployArtifactSummary
object
Summary of the deployment artifact.
15 properties
6 required
DeployPipeline
object
A set of stages whose predecessor relation forms a directed acyclic graph.
15 properties
4 required
ForkSyncStatusCollection
object
A collection of Fork Sync Status summaries.
1 property
1 required
PullRequestAuthorCollection
object
Result of listing PR authors.
1 property
1 required
DeploymentCollection
object
Results of a deployment search.
1 property
1 required
PullRequestAttachmentSummary
object
summary of a pullRequest attachment
5 properties
5 required
CreateConnectionDetails
object
The details for creating a connection.
6 properties
2 required
UpdateApprovalRuleDetails
object
A rule which must be satisfied for matching pull requests before the pull request can be merged
4 properties
2 required
CreateReviewerDetails
object
The reviewer to be created.
1 property
1 required
WorkRequestCollection
object
List of work requests.
1 property
1 required
DiffResponse
object
Response object for obtaining list of changed files.
8 properties
1 required
ConnectionValidationResult
object
The result of validating the credentials of a connection.
3 properties
DeliveredArtifact
object
Details of the artifacts delivered through the Deliver Artifacts stage.
3 properties
3 required
PrincipalDetails
object
The principal details
4 properties
1 required
UpdateReviewerDetails
object
The reviewer to be updated.
1 property
1 required
UpdateBuildPipelineDetails
object
The information to be updated for the given build pipeline.
5 properties
PullRequestNotificationPreference
object
The notification preference of the pull request.
3 properties
3 required
PullRequestActivitySummary
object
Summary of an activity record in a pull request
5 properties
5 required
ForkSyncStatusSummary
object
Object that contains the sync status for a specific branch name.
3 properties
3 required
MergeChecks
object
Criteria which must be satisfied to merge a pull request.
1 property
1 required
RepositoryCommit
object
Commit object with commit information.
9 properties
2 required
UpdateDeployArtifactDetails
object
The information to be updated for the artifact.
7 properties
CancelBuildRunDetails
object
Information about canceling the build run.
1 property
1 required
PullRequestAttachment
object
Pull Request attachment created by users.
5 properties
5 required
TriggerSchedule
object
Specifies a trigger schedule. Timing information for when to initiate automated syncs.
2 properties
1 required
BuildPipelineSummary
object
Summary of the build pipeline.
13 properties
3 required
WorkRequestErrorCollection
object
List of work request errors encountered while executing a work request.
1 property
1 required
SummarizeProjectRepositoryAnalyticsDetails
Details of the user configured settings for viewing the metrics at project level.
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
DeployPipelineParameter
object
Parameter name for which the values will be supplied at the time of deployment.
3 properties
1 required
CreateDeployEnvironmentDetails
object
The information about new deployment environment.
6 properties
2 required
PutRepositoryRefDetails
object
The information needed to create a reference. If the reference already exists, then it can be used to update the reference.
1 property
1 required
DeploymentArgument
object
Values for pipeline parameters to be supplied at the time of deployment.
2 properties
2 required
MergeCheck
object
Merge Check summary
1 property
1 required
DiffSummary
object
Response object for showing differences for a file between two revisions.
11 properties
1 required
DeployPipelineEnvironment
object
Environment used in the pipeline.
3 properties
2 required
Repository
object
Repositories containing the source code to build and deploy.
24 properties
3 required
BuildPipeline
object
A set of stages forming a directed acyclic graph that defines the build process.
13 properties
3 required
RepositorySettings
object
User configured settings for repository resources
3 properties
3 required
RepositoryMirrorRecordCollection
object
The collection of mirror entry.
1 property
1 required
VulnerabilityAuditSummary
object
Summary of vulnerability audit.
3 properties
2 required
VulnerabilityAuditSummaryCollection
object
List of vulnerability audit summary.
1 property
1 required
PullRequestSummary
object
Summary of the Pull Request.
20 properties
15 required
BuildRunArgumentCollection
object
Specifies list of arguments passed along with the build run.
1 property
1 required
PullRequestFileChangeSummary
object
Entry for description of change on a file.
13 properties
1 required
ApprovalRuleCollection
object
List of approval rules which must be statisfied before pull requests which match the rules can be merged
1 property
1 required
PullRequestCommentCollection
object
Result of list pullRequest comments.
1 property
1 required
UpdateDeployStageDetails
object
The information to be updated.
6 properties
1 required
TriggerSummary
object
Summary of the trigger.
13 properties
4 required
ReviewPullRequestDetails
object
Details to submit pull request review
1 property
1 required
BuildRunSource
object
The source from which the build run is triggered.
1 property
1 required
UpdatePullRequestCommentDetails
object
The new comment content to be updated.
1 property
UpdateProjectDetails
object
The information to be updated for the given project.
4 properties
BuildRunProgressSummary
object
The summary run progress details of a build run.
2 properties
ExportedVariable
object
Values for exported variables.
2 properties
2 required
RepositorySummary
object
Summary of the repository.
20 properties
3 required
CommitAnalyticsAuthorSummary
object
Object containing summary of Commit Analytics author.
2 properties
2 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties
2 required
CreateProjectDetails
object
The information about new project to be created.
6 properties
3 required
DeleteProtectedBranchDetails
object
Information to delete a protected branch
1 property
1 required
ApprovalRule
object
A rule which must be satisfied for matching pull requests before the pull request can be merged
4 properties
2 required
BuildRunSnapshotCollection
object
Results of a build run search. Contains build run summary items.
1 property
1 required
BuildPipelineStageCollection
object
Result of a stage search.
1 property
1 required
DeployPipelineArtifact
object
Artifact used in the pipeline.
3 properties
2 required
BuildRunSnapshotSummary
object
Summary of a single build run snapshot. Contains information including pipelineId, commitId.
8 properties
5 required
DiffResponseEntry
object
Entry for description of change on a file.
11 properties
1 required
DeployArtifactOverrideArgument
object
Values for artifact parameters to be supplied at the time of deployment.
3 properties
3 required
NotificationConfig
object
Notification configuration for the project.
1 property
1 required
DeployArtifactCollection
object
Results of a deployment artifact search.
1 property
1 required
BuildPipelineCollection
object
Results of a pipeline search.
1 property
1 required
ProjectRepositorySettings
object
User configured settings for project resources and their child repositories.
2 properties
2 required
MirrorRepositoryConfig
object
Configuration information for mirroring the repository.
3 properties
BuildPipelineStage
object
A single node in a build pipeline. A stage takes a specific designated action. There are many types of stages such as 'BUILD' and 'DELIVERARTIFACT'.
15 properties
5 required
DeployPipelineEnvironmentCollection
object
List of all environments used in the pipeline.
1 property
1 required
RepositoryPathSummary
object
Object containing information about files and directories in a repository.
9 properties
DeployEnvironment
object
The target OCI resources, such as Compute instances, Container Engine for Kubernetes(OKE) clusters, or Function, where artifacts are deployed.
13 properties
4 required
BuildRunProgress
object
The run progress details of a build run.
3 properties
RepositoryObject
object
Object containing information about files and directories in a repository.
4 properties
3 required
UpdateDeploymentDetails
object
The information to be updated.
4 properties
1 required
Trigger
object
Trigger the deployment pipeline to deploy the artifact.
14 properties
5 required
Project
object
DevOps project groups resources needed to implement the CI/CD workload. DevOps resources include artifacts, pipelines, and environments.
13 properties
4 required
CreateBuildRunDetails
object
Information about the new build run.
6 properties
1 required
Filter
object
The filters for the trigger.
1 property
1 required
DeployPipelineParameterCollection
object
Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing paramete…
1 property
1 required
CommitInfo
object
Commit details that need to be used for the build run.
3 properties
3 required
PullRequestComment
object
User comments created by reviewers during the pull request review.
16 properties
6 required
Reviewer
object
Reviewer information.
5 properties
1 required
WorkRequest
object
Details of the work request status.
9 properties
7 required
ProjectCollection
object
Results of an project search.
1 property
1 required
RepositoryPathCollection
object
Result of list paths in a repository.
1 property
1 required
PatchPullRequestDetails
object
Pull request details to patch
1 property
DeployStage
object
A single node in a pipeline. It is usually associated with some action on a specific set of OCI resources such as environments. For example, updating a Functio…
15 properties
5 required
BuildPipelineStageRunProgress
object
The details about the run progress of a stage in a build run.
7 properties
DiffLineDetails
object
Details about a line within the difference.
4 properties
CreatePullRequestCommentDetails
object
The information about new Comment.
6 properties
1 required
CreateOrUpdateProtectedBranchDetails
object
Information to create a protected branch
2 properties
1 required
ProtectedBranch
object
Holds information used to restrict certain actions on branches
4 properties
2 required
CreateBuildPipelineStageDetails
object
The information about a new stage.
7 properties
3 required
RepositoryCommitCollection
object
Result of a commit search.
1 property
1 required
RepositoryRefCollection
object
Result of a reference search.
1 property
1 required
DeploymentSummary
object
Summary of the deployment.
16 properties
5 required
DeployPipelineCollection
object
Results of an pipeline search.
1 property
1 required
DeployStagePredecessor
object
Metadata for defining a stage's predecessor.
1 property
1 required
DeployPipelineArtifactCollection
object
List of all artifacts used in the pipeline.
1 property
1 required
DeployStageExecutionStep
object
Details about each steps in stage execution for a target environment.
4 properties
RepositoryCommitSummary
object
Commit summary with commit information.
12 properties
9 required
DeployStageExecutionProgress
object
Details about the execution progress of a stage in a deployment.
8 properties
BuildRun
object
Each time you attempt to run a build pipeline you create one build run. A build can be running currently, or it can be a record of the run that happened in the…
17 properties
2 required
BuildPipelineStagePredecessorCollection
object
The collection containing the predecessors of a stage.
1 property
1 required
MergeCheckCollection
object
list of merge checks.
2 properties
SummarizeRepositoryAnalyticsDetails
Details of the user configured settings for viewing the metrics at repository level.
DiffSection
object
Details about a section of changes within a difference chunk.
2 properties
FileLineDetails
object
Object containing the details of a line in a file.
2 properties
2 required
DeployEnvironmentCollection
object
Results of a deployment environment search.
1 property
1 required
BuildRunSummary
object
Summary of the build run.
16 properties
5 required
DeleteGitRefDetails
object
The information needed to delete a reference.
1 property
1 required
DeliveredArtifactCollection
object
Specifies the list of artifacts delivered through the Deliver Artifacts stage.
1 property
1 required
CreateDeployPipelineDetails
object
The information about new deployment pipeline to be created.
6 properties
1 required
UpdateProjectRepositorySettingsDetails
object
Information to update custom project repository settings.
2 properties
RepositoryAuthorCollection
object
Result of list authors.
1 property
1 required
BuildPipelineStagePredecessor
object
Metadata for defining a stage's predecessor.
1 property
1 required
UpdateRepositoryNotificationPreferenceDetails
object
Information to update notification preference settings on repository resource
1 property
1 required
CreateDeployArtifactDetails
object
Information about a new deployment artifact.
8 properties
4 required
TriggerCollection
object
Results of a trigger search. Contains boh trigger summary items and other information such as metadata.
1 property
1 required
BuildRunArgument
object
Values for pipeline parameters to be supplied at the time of running the build.
2 properties
2 required
PullRequestCommentLikeCollection
object
Abstract of Pull Request Comment likes.
2 properties
2 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties
3 required
Deployment
object
A single execution or run of a pipeline.
19 properties
5 required
DeployPipelineSummary
object
Summary of the deployment pipeline.
13 properties
3 required
RepositoryMirrorRecord
object
Object containing information about a mirror record.
5 properties
1 required
MergePullRequestDetails
object
determines if this is a merge or a validation.
1 property
1 required
RepositoryCollection
object
Results of a repository search. Contains repository summary items and other information, such as metadata.
1 property
1 required
UpdateConnectionDetails
object
The details for updating a connection.
5 properties
1 required
PullRequestChangeSummaryMetrics
object
Response object for obtaining summary metric of Pull Request changed files.
3 properties
3 required
RepositoryMirrorRecordSummary
object
Object containing information about a mirror record.
8 properties
1 required
RepositoryMetricSummary
object
The metrics details of a repository resource.
6 properties
ConnectionCollection
object
Collection of connections.
1 property
1 required
ExportedVariableCollection
object
Specifies list of exported variables.
1 property
1 required
RepositoryMetricAggregation
object
The set of aggregated data returned for repository analytics.
1 property
1 required
BuildOutputs
object
Outputs from the build.
4 properties
UpdateBuildRunDetails
object
The build run information to be updated.
3 properties
UpdateApprovalRuleDetailsCollection
object
List of approval rules which must be statisfied before pull requests which match the rules can be merged
1 property
1 required
UpdateRepositorySettingsDetails
object
Information to update custom repository settings
3 properties
DiffCollection
object
Result of a compare difference.
1 property
1 required
CreateDeploymentDetails
object
The information about new deployment.
5 properties
2 required
RepositoryAnalyticsDetails
object
Details of the user configured settings for viewing the metrics.
6 properties
2 required
WorkRequestLogEntryCollection
object
List of log messages from the execution of a work request.
1 property
1 required
Connection
object
The properties that define a connection to external repositories.
14 properties
4 required
ProtectedBranchCollection
object
Collection of protected branches
1 property
1 required
CreatePullRequestDetails
object
The information about new Pull Request.
9 properties
3 required
UpdateDeployPipelineDetails
object
The information to be updated for the given deloyment pipeline.
5 properties
DeployArtifactSource
object
Specifies source of an artifact.
1 property
1 required
CreateOrUpdateGitRefDetails
object
The information needed to create a reference. If the reference already exists, then it can be used to update the reference.
2 properties
2 required
DeployArtifact
object
Artifacts are deployment manifests that are referenced in a pipeline stage for automated deployment to the target environment. DevOps artifacts can be an OCI C…
15 properties
6 required
CreateRepositoryDetails
object
Information about the new repository.
9 properties
3 required
ApproveDeploymentDetails
object
The stage information for submitting for approval.
3 properties
2 required
PullRequestActivityCollection
object
Result of list pullRequest activities.
1 property
1 required
UpdatePullRequestDetails
object
The information to be updated.
6 properties
RepositoryNotificationPreference
object
The notification preference of the repository.
3 properties
3 required
MergeSettings
object
Enabled and disabled merge strategies for a project or repository, also contains a default strategy.
2 properties
DeployStageCollection
object
Result of a stage search.
1 property
1 required
ConnectionSummary
object
Summary information for a connection.
14 properties
4 required
ProjectNotificationPreference
object
The notification preference of the project.
3 properties
3 required
DiffChunk
object
Details about a group of changes.
5 properties
PullRequest
object
Pull Request containing the diff between a review branch and a destination branch
23 properties
15 required
CommitAnalyticsAuthorCollection
object
Result of listing Commit Analytics authors.
1 property
1 required
DeployPipelineStageCollection
object
List of stages.
1 property
1 required
DeployStageExecutionProgressDetails
object
Details about stage execution for each target environment.
4 properties
RepositoryAuthorSummary
object
Object containing summary of authors in a repository.
4 properties
1 required
Error
object
Error Information.
2 properties
2 required
PullRequestCommentSummary
object
summary of a pullRequest comment
16 properties
6 required
RepositoryFileLines
object
Object containing the lines of a file in a repository.
1 property
1 required
DeployStageSummary
object
Summary of the deployment stage.
15 properties
5 required
DeployStagePredecessorCollection
object
Collection containing the predecessors of a stage.
1 property
1 required
UpdateTriggerDetails
object
The information to be updated.
6 properties
1 required
DeployStageOverrideArgument
object
Values for stage override of the pipeline parameters to be supplied at the time of deployment.
3 properties
3 required
FileDiffResponse
object
Response object for showing differences for a file between two commits.
8 properties
1 required
CreateDeployStageDetails
object
The information about new deployment stage.
7 properties
3 required
CreateTriggerDetails
object
Information about the new trigger.
7 properties
3 required
TriggerCreateResult
object
Details of the trigger create response.
14 properties
5 required
PullRequestCollection
object
Results of a Pull Request search. Contains both PullRequestSummary items and other information, such as metadata.
1 property
1 required
UpdatePullRequestNotificationPreferenceDetails
object
Information to update notification preference settings on pull request resource
1 property
1 required
PullRequestFileChangeCollection
object
Result of Pull Request difference.
1 property
1 required
DeployEnvironmentSummary
object
Summary of the deployment environment.
13 properties
4 required
UpdateRepositoryDetails
object
The information to be updated.
7 properties
PatchInstruction
object
A single instruction to be included as part of Patch request content.
2 properties
2 required
DeployPipelineStage
object
Stage used in the pipeline for an artifact or environment.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.