openapi: 3.2.0 info: description: Use the DevOps API to create DevOps projects, configure code repositories, add artifacts to deploy, build and test software applications, configure target deployment environments, and deploy software applications. For more information, see [DevOps](/Content/devops/using/home.htm). title: Devops API version: '20210630' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/1d632ce78020a0d7fa6c8161bdef77b8ef9d426c524acb2c80e580ff02d26b5c.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the DevOps API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/1d632ce78020a0d7fa6c8161bdef77b8ef9d426c524acb2c80e580ff02d26b5c.yaml what: the harvested document for DevOps API servers: - url: http://127.0.0.1/20210630 - url: https://127.0.0.1/20210630 tags: - name: devops paths: /buildPipelineStages: get: description: 'Returns a list of all stages in a compartment or build pipeline. ' operationId: ListBuildPipelineStages parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/BuildPipelineIdQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/BuildPipelineStageLifeCycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of stage collection objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipelineStageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Stages in a compartment or buildPipeline tags: - devops x-related-resource: '#/definitions/BuildPipelineStageSummary' post: description: 'Creates a new stage. ' operationId: CreateBuildPipelineStage parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Stage that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipelineStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Stage tags: - devops x-related-resource: '#/definitions/BuildPipelineStage' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuildPipelineStageDetails' description: Details for the new stage. required: true /buildPipelineStages/{buildPipelineStageId}: delete: description: Deletes a stage based on the stage ID provided in the request. operationId: DeleteBuildPipelineStage parameters: - $ref: '#/components/parameters/BuildPipelineStageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the stage. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Stage tags: - devops x-related-resource: '#/definitions/BuildPipelineStage' get: description: Retrieves a stage based on the stage ID provided in the request. operationId: GetBuildPipelineStage parameters: - $ref: '#/components/parameters/BuildPipelineStageIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the stage with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipelineStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Stage tags: - devops put: description: Updates the stage based on the stage ID provided in the request. operationId: UpdateBuildPipelineStage parameters: - $ref: '#/components/parameters/BuildPipelineStageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the stage. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipelineStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Stage identified by the id tags: - devops x-related-resource: '#/definitions/BuildPipelineStage' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBuildPipelineStageDetails' description: The information to be updated. required: true /buildPipelines: get: description: 'Returns a list of build pipelines. ' operationId: ListBuildPipelines parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/BuildPipelineLifeCycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of build pipeline summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipelineCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all BuildPipelines in a Compartment or a Project. tags: - devops x-related-resource: '#/definitions/BuildPipelineCollection' post: description: 'Creates a new build pipeline. ' operationId: CreateBuildPipeline parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The build pipeline that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new BuildPipeline tags: - devops x-related-resource: '#/definitions/BuildPipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuildPipelineDetails' description: Details for the new build pipeline. required: true /buildPipelines/{buildPipelineId}: delete: description: Deletes a build pipeline resource by identifier. operationId: DeleteBuildPipeline parameters: - $ref: '#/components/parameters/BuildPipelineIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the build pipeline. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned BuildPipeline tags: - devops x-related-resource: '#/definitions/BuildPipeline' get: description: Retrieves a build pipeline by identifier. operationId: GetBuildPipeline parameters: - $ref: '#/components/parameters/BuildPipelineIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the build pipeline with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get BuildPipeline tags: - devops put: description: Updates the build pipeline. operationId: UpdateBuildPipeline parameters: - $ref: '#/components/parameters/BuildPipelineIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the build pipeline. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the BuildPipeline identified by the id tags: - devops x-related-resource: '#/definitions/BuildPipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBuildPipelineDetails' description: The information to be updated. required: true /buildRuns: get: description: 'Returns a list of build run summary. ' operationId: ListBuildRuns parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/BuildPipelineIdentifierQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BuildRunLifeCycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of build run summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRunSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all build runs summary tags: - devops x-related-resource: '#/definitions/BuildRunSummary' post: description: 'Starts a build pipeline run for a predefined build pipeline. Please ensure the completion of any work request for creation/updation of Build Pipeline before starting a Build Run. ' operationId: CreateBuildRun parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The build run that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Start a code build run tags: - devops x-related-resource: '#/definitions/BuildRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuildRunDetails' description: Parameter details required to create a new build run. required: true /buildRuns/{buildRunId}: get: description: 'Returns the details of a build run for a given build run ID. ' operationId: GetBuildRun parameters: - $ref: '#/components/parameters/BuildRunIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of build run object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a build run detail tags: - devops put: description: Updates the build run. operationId: UpdateBuildRun parameters: - $ref: '#/components/parameters/BuildRunIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The build run is updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the BuildRun identified by the id tags: - devops x-related-resource: '#/definitions/BuildRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBuildRunDetails' description: The information to be updated. required: true /buildRuns/{buildRunId}/actions/cancel: post: description: Cancels the build run based on the build run ID provided in the request. operationId: CancelBuildRun parameters: - $ref: '#/components/parameters/BuildRunIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Details of build run object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the Build Run based on build run id provided in request tags: - devops x-related-resource: '#/definitions/BuildRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelBuildRunDetails' description: Parameter details required to cancel a build run. required: true /connections: get: description: 'Returns a list of connections. ' operationId: ListConnections parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ConnectionLifeCycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ConnectionTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of connection summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConnectionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Connections in a Compartment or a Project. tags: - devops x-related-resource: '#/definitions/ConnectionCollection' post: description: 'Creates a new connection. ' operationId: CreateConnection parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The connection that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Connection tags: - devops x-related-resource: '#/definitions/Connection' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConnectionDetails' description: Details for the new connection. required: true /connections/{connectionId}: delete: description: Deletes a connection resource by identifier. operationId: DeleteConnection parameters: - $ref: '#/components/parameters/ConnectionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the connection. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Connection tags: - devops x-related-resource: '#/definitions/Connection' get: description: Retrieves a connection by identifier. operationId: GetConnection parameters: - $ref: '#/components/parameters/ConnectionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the connection with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Connection tags: - devops put: description: Updates the connection. operationId: UpdateConnection parameters: - $ref: '#/components/parameters/ConnectionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the source connection. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Connection identified by the id tags: - devops x-related-resource: '#/definitions/Connection' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConnectionDetails' description: The information to be updated. required: true /connections/{connectionId}/actions/validate: post: description: 'Return whether the credentials of the connection are valid. ' operationId: ValidateConnection parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ConnectionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Return the connection with ConnectionValidationResult field. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Validate the connection's credentials. tags: - devops x-related-resource: '#/definitions/Connection' /deployArtifacts: get: description: Returns a list of deployment artifacts. operationId: ListDeployArtifacts parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - description: A filter to return only DeployArtifacts that matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DeployArtifact/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page displaying the deployment artifact details. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployArtifactCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all DeployArtifacts in a compartment. tags: - devops x-related-resource: '#/definitions/DeployArtifactSummary' post: description: Creates a new deployment artifact. operationId: CreateDeployArtifact parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The deployment artifact is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployArtifact' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DeployArtifact tags: - devops x-related-resource: '#/definitions/DeployArtifact' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeployArtifactDetails' description: Details for the new deployment artifact. required: true /deployArtifacts/{deployArtifactId}: delete: description: Deletes a deployment artifact resource by identifier. operationId: DeleteDeployArtifact parameters: - $ref: '#/components/parameters/DeployArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The artifact will be deleted. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned DeployArtifact tags: - devops x-related-resource: '#/definitions/DeployArtifact' get: description: Retrieves a deployment artifact by identifier. operationId: GetDeployArtifact parameters: - $ref: '#/components/parameters/DeployArtifactIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a deployment artifact with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployArtifact' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DeployArtifact tags: - devops put: description: Updates the deployment artifact. operationId: UpdateDeployArtifact parameters: - $ref: '#/components/parameters/DeployArtifactIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The deployment artifact will be updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployArtifact' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the DeployArtifact identified by the id tags: - devops x-related-resource: '#/definitions/DeployArtifact' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeployArtifactDetails' description: The information to be updated. required: true /deployEnvironments: get: description: Returns a list of deployment environments. operationId: ListDeployEnvironments parameters: - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - description: A filter to return only DeployEnvironments that matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DeployEnvironment/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of deployment environment collection objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployEnvironmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all DeployEnvironments in a compartment tags: - devops x-related-resource: '#/definitions/DeployEnvironmentSummary' post: description: Creates a new deployment environment. operationId: CreateDeployEnvironment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The deployment environment that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployEnvironment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DeployEnvironment tags: - devops x-related-resource: '#/definitions/DeployEnvironment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeployEnvironmentDetails' description: Details for the new deployment environment. required: true /deployEnvironments/{deployEnvironmentId}: delete: description: Deletes a deployment environment resource by identifier. operationId: DeleteDeployEnvironment parameters: - $ref: '#/components/parameters/DeployEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the deployment environment. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned DeployEnvironment tags: - devops x-related-resource: '#/definitions/DeployEnvironment' get: description: Retrieves a deployment environment by identifier. operationId: GetDeployEnvironment parameters: - $ref: '#/components/parameters/DeployEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a deployment environment with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployEnvironment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DeployEnvironment tags: - devops put: description: Updates the deployment environment. operationId: UpdateDeployEnvironment parameters: - $ref: '#/components/parameters/DeployEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the deployment environment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployEnvironment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the DeployEnvironment identified by the id tags: - devops x-related-resource: '#/definitions/DeployEnvironment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeployEnvironmentDetails' description: The information to be updated. required: true /deployPipelines: get: description: Returns a list of deployment pipelines. operationId: ListDeployPipelines parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - description: A filter to return only DeployPipelines that matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DeployPipeline/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of deployment pipelines summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployPipelineCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all DeployPipelines in a Compartment or a Project. tags: - devops x-related-resource: '#/definitions/DeployPipelineSummary' post: description: Creates a new deployment pipeline. operationId: CreateDeployPipeline parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The deployment pipeline that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DeployPipeline tags: - devops x-related-resource: '#/definitions/DeployPipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeployPipelineDetails' description: Details for the new deployment pipeline. required: true /deployPipelines/{deployPipelineId}: delete: description: Deletes a deployment pipeline resource by identifier. operationId: DeleteDeployPipeline parameters: - $ref: '#/components/parameters/DeployPipelineIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the deployment pipeline. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned DeployPipeline tags: - devops x-related-resource: '#/definitions/DeployPipeline' get: description: Retrieves a deployment pipeline by identifier. operationId: GetDeployPipeline parameters: - $ref: '#/components/parameters/DeployPipelineIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a deployment pipeline with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DeployPipeline tags: - devops put: description: Updates the deployment pipeline. operationId: UpdateDeployPipeline parameters: - $ref: '#/components/parameters/DeployPipelineIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the deployment pipeline. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployPipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the DeployPipeline identified by the id tags: - devops x-related-resource: '#/definitions/DeployPipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeployPipelineDetails' description: The information to be updated. required: true /deployStages: get: description: Retrieves a list of deployment stages. operationId: ListDeployStages parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/DeployPipelineIdQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - description: A filter to return only deployment stages that matches the given lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DeployStage/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of deployment stages collection objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployStageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all DeployStages in a compartment tags: - devops x-related-resource: '#/definitions/DeployStageSummary' post: description: Creates a new deployment stage. operationId: CreateDeployStage parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Deployment stage that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DeployStage tags: - devops x-related-resource: '#/definitions/DeployStage' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeployStageDetails' description: Details for the new deployment stage. required: true /deployStages/{deployStageId}: delete: description: Deletes a deployment stage resource by identifier. operationId: DeleteDeployStage parameters: - $ref: '#/components/parameters/DeployStageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the deployment stage. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned DeployStage tags: - devops x-related-resource: '#/definitions/DeployStage' get: description: Retrieves a deployment stage by identifier. operationId: GetDeployStage parameters: - $ref: '#/components/parameters/DeployStageIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a deployment stage with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DeployStage tags: - devops put: description: Updates the deployment stage. operationId: UpdateDeployStage parameters: - $ref: '#/components/parameters/DeployStageIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the deployment stage. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeployStage' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the DeployStage identified by the id tags: - devops x-related-resource: '#/definitions/DeployStage' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeployStageDetails' description: The information to be updated. required: true /deployments: get: description: Returns a list of deployments. operationId: ListDeployments parameters: - $ref: '#/components/parameters/DeployPipelineIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - description: A filter to return only Deployments that matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Deployment/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' responses: 200: description: A page of deployment collection objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Deployments in a compartment tags: - devops x-related-resource: '#/definitions/DeploymentSummary' post: description: Creates a new deployment. operationId: CreateDeployment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request accepted to create a deployment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Deployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Deployment tags: - devops x-related-resource: '#/definitions/Deployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDeploymentDetails' description: Details for the new deployment. required: true /deployments/{deploymentId}: get: description: Retrieves a deployment by identifier. operationId: GetDeployment parameters: - $ref: '#/components/parameters/DeploymentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a deployment with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Deployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Deployment tags: - devops put: description: Updates the deployment. operationId: UpdateDeployment parameters: - $ref: '#/components/parameters/DeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request accepted to update the deployment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Deployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Deployment identified by the id tags: - devops x-related-resource: '#/definitions/Deployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeploymentDetails' description: The information to be updated. required: true /deployments/{deploymentId}/actions/approve: post: description: Submit stage approval. operationId: ApproveDeployment parameters: - $ref: '#/components/parameters/DeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Approved the pending deployment successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Deployment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Submit stage approval. tags: - devops x-related-resource: '#/definitions/Deployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApproveDeploymentDetails' description: The stage information for approval. required: true /deployments/{deploymentId}/actions/cancel: post: description: Cancels a deployment resource by identifier. operationId: CancelDeployment parameters: - $ref: '#/components/parameters/DeploymentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Request accepted to cancel the deployment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Deployment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a provisioned Deployment tags: - devops x-related-resource: '#/definitions/Deployment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelDeploymentDetails' description: The information regarding the deployment to be canceled. required: true /projects: get: description: Returns a list of projects. operationId: ListProjects parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - description: A filter to return only Projects that matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Project/lifecycleState' schema: type: string - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of project summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all projects in a compartment tags: - devops x-related-resource: '#/definitions/ProjectSummary' post: description: Creates a new project. operationId: CreateProject parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The project that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Project tags: - devops x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProjectDetails' description: Details for the new project. required: true /projects/{projectId}: delete: description: Deletes a project resource by identifier operationId: DeleteProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete a project. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Project tags: - devops x-related-resource: '#/definitions/Project' get: description: Retrieves a project by identifier. operationId: GetProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a project with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Project tags: - devops put: description: Updates the project. operationId: UpdateProject parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the project. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Project identified by the id tags: - devops x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectDetails' description: The information to be updated. required: true /projects/{projectId}/actions/cancelScheduledCascadingProjectDeletion: post: description: Cascading operation that restores Project and child resources from a DELETING state to an active state operationId: CancelScheduledCascadingProjectDeletion parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted to cancel cascading delete. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Restores parent and children resources from DELETING state tags: - devops x-related-resource: '#/definitions/Project' /projects/{projectId}/actions/changeCompartment: post: description: Moves a project resource from one compartment OCID to another. operationId: ChangeProjectCompartment parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted to move a project from one compartment to another. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - devops x-related-resource: '#/definitions/Project' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProjectCompartmentDetails' description: The information to be updated. required: true /projects/{projectId}/actions/scheduleCascadingProjectDeletion: post: description: Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period operationId: ScheduleCascadingProjectDeletion parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted to schedule cascading delete. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Marks parent and children resources in a DELETING state tags: - devops x-related-resource: '#/definitions/Project' /projects/{projectId}/commitAnalyticsAuthors: get: description: 'Retrieve a list of all the Commit Analytics authors. ' operationId: ListProjectCommitAnalyticsAuthors parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuthorSortByQueryParam' responses: 200: description: A list of Commit Analytics authors. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommitAnalyticsAuthorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of all the Commit Analytics authors tags: - devops x-related-resource: '#/definitions/Repository' /projects/{projectId}/principals/{principalId}/pullRequestNotificationPreference: get: description: Get the project notification preference for the user passed as path param operationId: GetProjectNotificationPreference parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the notification preference information for the given project id. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the project notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/ProjectNotificationPreference' put: description: Update the project notification preference for the user passed as path param operationId: UpdateProjectNotificationPreference parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Completed request to update project notification preference. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the project notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/ProjectNotificationPreference' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectNotificationPreferenceDetails' description: The information to be updated. required: true /projects/{projectId}/repositoryAnalytics: post: description: Retrieves repository analytics for a given project. operationId: SummarizeProjectRepositoryAnalytics parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of metrics for the given project id. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryMetricAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves repository analytics for a given project. tags: - devops x-related-resource: '#/definitions/RepositoryMetricAggregation' requestBody: content: application/json: schema: $ref: '#/components/schemas/SummarizeProjectRepositoryAnalyticsDetails' description: Details to fetch the repository analytics. required: true /projects/{projectId}/repositorySettings: delete: description: Removes the custom repository settings configured for a project. operationId: DeleteProjectRepositorySettings parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Completed request to delete custom project repsitory settings. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes custom repository settings configured for a project. tags: - devops x-related-resource: '#/definitions/ProjectRepositorySettings' get: description: Retrieves a project's repository settings details. operationId: GetProjectRepositorySettings parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the settings information for the given project id. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectRepositorySettings' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets project repository settings. tags: - devops x-related-resource: '#/definitions/ProjectRepositorySettings' put: description: Updates the repository settings for a project. operationId: UpdateProjectRepositorySettings parameters: - $ref: '#/components/parameters/ProjectIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Completed request to update project repository settings. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProjectRepositorySettings' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the repository settings for a project. tags: - devops x-related-resource: '#/definitions/ProjectRepositorySettings' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectRepositorySettingsDetails' description: Details to update the repository settings for a project. required: true /pullRequests: get: description: 'Returns a list of PullRequests. ' operationId: ListPullRequests parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/PullRequestLifeCycleStateQueryParam' - $ref: '#/components/parameters/PullRequestLifeCycleDetailsQueryParam' - $ref: '#/components/parameters/RepositoryIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/PullRequestCreatedByQueryParam' - $ref: '#/components/parameters/PullRequestDestinationBranchQueryParam' - $ref: '#/components/parameters/PullRequestSourceBranchQueryParam' - $ref: '#/components/parameters/PullRequestReviewerIdQueryParam' - $ref: '#/components/parameters/PullRequestSourceRepositoryIdQueryParam' - $ref: '#/components/parameters/CodeRepositoryPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PullRequestSummary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Pull Requests in a compartment tags: - devops x-related-resource: '#/definitions/PullRequestCollection' post: description: 'Creates a new PullRequest. ' operationId: CreatePullRequest parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request accepted to create the pull request. headers: content-location: description: Relative URL of the newly created resource. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new PullRequest tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePullRequestDetails' description: Details for the new PullRequest. required: true /pullRequests/{pullRequestId}: delete: description: Deletes a PullRequest resource by identifier operationId: DeletePullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The PullRequest is deleted. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned PullRequest tags: - devops x-related-resource: '#/definitions/PullRequest' get: description: Gets a PullRequest by identifier operationId: GetPullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the PullRequest with the given id headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get PullRequest tags: - devops patch: description: 'Updates the reviewer list of a pull request ' operationId: PatchPullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Patched the pull request. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a pull request's reviewer list tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchPullRequestDetails' description: Details for the PullRequest update. required: true put: description: Updates the PullRequest operationId: UpdatePullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Pull Request will be updated. headers: content-location: description: Relative URL of the newly created resource. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the PullRequest identified by the id tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePullRequestDetails' description: The information to be updated. required: true /pullRequests/{pullRequestId}/actions/decline: post: description: 'Decline a PullRequest ' operationId: DeclinePullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Declined the pull request successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Decline a PullRequest tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/actions/merge: post: description: Merge the PullRequest operationId: MergePullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: merge process stared successfully. headers: content-location: description: Relative URL of the newly created resource. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Merge the PullRequest identified by the id tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/MergePullRequestDetails' description: The details about the merge operation. required: true /pullRequests/{pullRequestId}/actions/reopen: post: description: 'Reopen a PullRequest ' operationId: ReopenPullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Reopened the pull request successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Reopen a PullRequest tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/actions/review: post: description: 'Review a PullRequest ' operationId: ReviewPullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Reviewed the pull request successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Review a PullRequest tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReviewPullRequestDetails' description: Details to submit a review. required: true /pullRequests/{pullRequestId}/actions/unsubscribe: get: description: unsubscribe the PullRequest operationId: UnsubscribePullRequest parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/UnsubscribePullRequestTokenQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: unsubscribed successfully. headers: content-location: description: Relative URL of the newly created resource. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: text/html: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Unsubscribe from the PullRequest identified by the id tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/activities: get: description: List actions that have been taken on a pull request operationId: ListPullRequestActivities parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestActivityTypeQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CodeRepositoryPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a list of activities that were performed on a given pull request. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestActivityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List PullRequest activities tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/attachments: get: description: List PullRequest level attachments by identifier operationId: ListPullRequestAttachments parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PullRequestAttachmentSortByQueryParam' - $ref: '#/components/parameters/FileNameQueryParam' - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/CodeRepositoryPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the array of PullRequest level attachments with the given pull request id headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestAttachmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List PullRequest attachments tags: - devops x-related-resource: '#/definitions/PullRequest' post: description: 'Creates PullRequest attachment ' operationId: CreatePullRequestAttachment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/ContentDispositionHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the pull request attachment. headers: content-location: description: Relative URL of the newly created resource. schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates PullRequest attachment tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: format: binary type: string description: Uploads the content of the attachment. required: true /pullRequests/{pullRequestId}/attachments/{attachmentId}: delete: description: Deletes a PullRequest attachment metadata by identifier operationId: DeletePullRequestAttachment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestAttachmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The PullRequest attachment metadata is deleted. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a PullRequest attachment tags: - devops x-related-resource: '#/definitions/PullRequest' get: description: Get PullRequest attachment metadata by identifier operationId: GetPullRequestAttachment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestAttachmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the PullRequest attachment metadata with the given id headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get PullRequest attachment metadata tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/attachments/{attachmentId}/content: get: description: Gets the content of the attachment. operationId: GetPullRequestAttachmentContent parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestAttachmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The content of the attachment was retrieved successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: GetPullRequestAttachmentContent tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/buildRunSnapshots: get: description: 'Returns a list of build run snapshots for a given commit or the latest commit on a pull request if no commit is provided. ' operationId: ListBuildRunSnapshots parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/BuildPipelineIdentifierOptionalQueryParam' - $ref: '#/components/parameters/BuildRunIdentifierOptionalQueryParam' - $ref: '#/components/parameters/CommitIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RepositorySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of build run snapshot summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BuildRunSnapshotCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all build run snapshots for the provided filters. tags: - devops x-related-resource: '#/definitions/Repository' /pullRequests/{pullRequestId}/changeSummaryMetrics: get: description: Get pull request diff summary metric operationId: GetPullRequestChangeSummaryMetrics parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the summary metric of Pull Request differences. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestChangeSummaryMetrics' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get PullRequest Diff summary metric tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/comments: get: description: List PullRequest level comments by identifier operationId: ListPullRequestComments parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PullRequestCommentSortByQueryParam' - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierQueryParam' - $ref: '#/components/parameters/PullRequestCommitIdQueryParam' - $ref: '#/components/parameters/PullRequestFilePathQueryParam' - $ref: '#/components/parameters/CodeRepositoryPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Pre-order traverse array of PullRequest level comments with the given pull request id headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestCommentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List PullRequest comments tags: - devops x-related-resource: '#/definitions/PullRequest' post: description: 'Creates a new PullRequest comment. ' operationId: CreatePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the pull request comment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new PullRequest comment tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePullRequestCommentDetails' description: Details for the new PullRequest comment. required: true /pullRequests/{pullRequestId}/comments/{commentId}: delete: description: Deletes a PullRequest comment by identifier operationId: DeletePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The PullRequest comment is deleted. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a PullRequest comment tags: - devops x-related-resource: '#/definitions/PullRequest' get: description: Get PullRequest comment by identifier operationId: GetPullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the PullRequest level comment with the given id headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get PullRequest comment tags: - devops x-related-resource: '#/definitions/PullRequest' put: description: Updates the PullRequest comment operationId: UpdatePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated Pull Request comment. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the PullRequest comment identified by the id tags: - devops x-related-resource: '#/definitions/PullRequest' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePullRequestCommentDetails' description: The new comment content to be updated. required: true /pullRequests/{pullRequestId}/comments/{commentId}/actions/like: post: description: 'Like a PullRequest comment ' operationId: LikePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The pull request comment is liked. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Like a PullRequest comment tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/comments/{commentId}/actions/reopen: post: description: 'Reopen a PullRequest Comment ' operationId: ReopenPullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The pull request task is reopened. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Reopen a PullRequest Comment tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/comments/{commentId}/actions/resolve: post: description: 'Resolve a PullRequest Comment ' operationId: ResolvePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The pull request task is resolved. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Resolve a PullRequest Comment tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/comments/{commentId}/actions/unlike: post: description: 'Unlike a PullRequest comment ' operationId: UnlikePullRequestComment parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestCommentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The pull request comment is unliked. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestComment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Unlike a PullRequest comment tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/commits: get: description: List pull request commits operationId: ListPullRequestCommits parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a list of GIT commits of the Pull Request. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryCommitCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List PullRequest commits tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/fileChanges: get: description: List pull request file changes operationId: ListPullRequestFileChanges parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PullRequestFilePathQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a list of GIT commits of the Pull Request. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestFileChangeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List PullRequest file changes tags: - devops x-related-resource: '#/definitions/PullRequest' /pullRequests/{pullRequestId}/principals/{principalId}/pullRequestNotificationPreference: get: description: Get the pull request notification preference for the user passed as path param operationId: GetPullRequestNotificationPreference parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the notification preference information for the given pull request id. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the pull request notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/PullRequestNotificationPreference' put: description: Update the pull request notification preference for the user passed as path param operationId: UpdatePullRequestNotificationPreference parameters: - $ref: '#/components/parameters/PullRequestIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Completed request to update pull request notification preference. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the pull request notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/PullRequestNotificationPreference' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePullRequestNotificationPreferenceDetails' description: The information to be updated. required: true /repositories: get: description: 'Returns a list of repositories given a compartment ID or a project ID. ' operationId: ListRepositories parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - $ref: '#/components/parameters/RepositoryIdentifierQueryParam' - $ref: '#/components/parameters/LifecycleStateRepositoryQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RepositorySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of repository summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Repositories in a compartment tags: - devops x-related-resource: '#/definitions/Repository' post: description: 'Creates a new repository. ' operationId: CreateRepository parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Request accepted to create the repository. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Repository' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Repository tags: - devops x-related-resource: '#/definitions/Repository' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRepositoryDetails' description: Details for the new repository. required: true /repositories/{repositoryId}: delete: description: Deletes a repository resource by identifier. operationId: DeleteRepository parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the repository. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Repository tags: - devops x-related-resource: '#/definitions/Repository' get: description: Retrieves a repository by identifier. operationId: GetRepository parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RepositoryFieldsQueryParam' responses: 200: description: Retrieves the repository with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Repository' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Repository tags: - devops put: description: Updates the repository. operationId: UpdateRepository parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request fulfilled to update the repository. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Repository' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Repository identified by the id tags: - devops requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRepositoryDetails' description: The information to be updated. required: true /repositories/{repositoryId}/actions/createOrUpdateGitRef: post: description: 'Creates a new reference or updates an existing one. ' operationId: CreateOrUpdateGitRef parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request fulfilled to create the reference. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryRef' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Ref in the Repository or update an existing one tags: - devops x-related-resource: '#/definitions/Repository' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateGitRefDetails' description: The information to create a reference with the type specified in the query. required: true /repositories/{repositoryId}/actions/createOrUpdateProtectedBranch: post: description: Creates a restriction on a branch that prevents certain actions on it. operationId: CreateOrUpdateProtectedBranch parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request fulfilled to create the protected branch. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectedBranch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Defines a restriction on a branch. tags: - devops requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateProtectedBranchDetails' description: Details for a protected branch required: true /repositories/{repositoryId}/actions/deleteGitRef: post: description: Deletes a Repository's Ref by its name. Returns an error if the name is ambiguous. Can be disambiguated by using full names like "heads/" or "tags/". operationId: DeleteGitRef parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the reference. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Ref tags: - devops x-related-resource: '#/definitions/Repository' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteGitRefDetails' description: The information to delete a reference. required: true /repositories/{repositoryId}/actions/deleteProtectedBranch: post: description: Removes the protection from a branch operationId: DeleteProtectedBranch parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request fulfilled to delete the protected branch. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes the protection from a branch tags: - devops x-related-resource: '#/definitions/ProtectedBranch' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteProtectedBranchDetails' description: Details for a protected branch required: true /repositories/{repositoryId}/actions/mirror: post: description: 'Synchronize a mirrored repository to the latest version from external providers. ' operationId: MirrorRepository parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is sent to the workflow queue. A work request is returned to track the status. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 422: $ref: '#/components/responses/422' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Synchronize a mirrored repository tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/actions/sync: post: description: 'Synchronize a forked repository to the latest version ' operationId: SyncRepository parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SyncMergeStrategyQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request is sent to the workflow queue. A work request is returned to track the status. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Synchronize a repository tags: - devops x-related-resource: '#/definitions/Repository' requestBody: content: application/json: schema: $ref: '#/components/schemas/SyncRepositoryDetails' description: Details required for syncing a repository with its upstream. required: true /repositories/{repositoryId}/archive/content: get: description: 'Returns the archived repository information. ' operationId: GetRepositoryArchiveContent parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNameQueryParam' - $ref: '#/components/parameters/ArchiveFormatQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Download the repository successfully. headers: Content-Disposition: description: The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file. schema: type: string Content-Type: description: Content type refers to content of a file which is transferred via HTTP schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Download a specific branch of a repository tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/authors: get: description: 'Retrieve a list of all the authors. ' operationId: ListAuthors parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of authors. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryAuthorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of all the authors tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/commitAnalyticsAuthors: get: description: 'Retrieve a list of all the Commit Analytics authors. ' operationId: ListRepositoryCommitAnalyticsAuthors parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AuthorSortByQueryParam' responses: 200: description: A list of Commit Analytics authors. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/CommitAnalyticsAuthorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of all the Commit Analytics authors tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/commits: get: description: 'Returns a list of commits. ' operationId: ListCommits parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNameQueryParam' - $ref: '#/components/parameters/ExcludeRefNameQueryParam' - $ref: '#/components/parameters/FilePathQueryParam' - $ref: '#/components/parameters/CommitTimestampGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/CommitTimestampLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/CommitMessageQueryParam' - $ref: '#/components/parameters/AuthorNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of commit objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryCommitCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all commits of a given ref in a Repository. If a ref is not provided, commits from all branches will be returned tags: - devops x-related-resource: '#/definitions/RepositoryCommit' /repositories/{repositoryId}/commits/{commitId}: get: description: Retrieves a repository's commit by commit ID. operationId: GetCommit parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/CommitIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the commit with the given commit ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryCommit' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a Commit tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/diff: get: description: 'Compares two revisions for their differences. Supports comparison between two references or commits. ' operationId: GetCommitDiff parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - description: The commit or reference name to compare changes against. If base version is not provided, the difference goes against an empty tree. in: query name: baseVersion required: false x-default-description: 'null' schema: type: string - description: The commit or reference name that represents the newer changes against the base version. in: query name: targetVersion required: true x-default-description: 'null' schema: type: string - description: The target repository identifier in: query name: targetRepositoryId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 - description: Boolean value to indicate whether to use merge base or most recent revision. in: query name: isComparisonFromMergeBase required: false x-default-description: 'null' schema: type: boolean - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Differences between the branches. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiffResponse' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the differences between two revisions tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/diffs: get: description: 'Compares two revisions and lists the differences. Supports comparison between two references or commits. ' operationId: ListCommitDiffs parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - description: The commit or reference name to compare changes against. in: query name: baseVersion required: true schema: type: string - description: The commit or reference name where changes are coming from. in: query name: targetVersion required: true schema: type: string - description: The target repository identifier in: query name: targetRepositoryId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 - description: Boolean value to indicate whether to use merge base or most recent revision. in: query name: isComparisonFromMergeBase required: false x-default-description: 'null' schema: type: boolean - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Detailed differences between the revisions. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiffCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists the differences with details between two revisions tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/diffs/{filePath}: get: deprecated: true description: 'Gets the line-by-line difference between file on different commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ''/''. This will be replaced by "/repositories/{repositoryId}/file/diffs" ' operationId: GetFileDiff parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/FilePathPathParam' - description: The branch to compare changes against. in: query name: baseVersion required: true schema: type: string - description: The branch where changes are coming from. in: query name: targetVersion required: true schema: type: string - description: Boolean to indicate whether to use merge base or most recent revision. in: query name: isComparisonFromMergeBase required: false x-default-description: 'null' schema: type: boolean - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Differences between the given file on the two given commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT. Please use "/repositories/{repositoryId}/file/diffs" headers: Sunset: description: This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT. Please use "/repositories/{repositoryId}/file/diffs" schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/FileDiffResponse' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the line-by-line difference between file on different commits. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has '/'. This will be replaced by "/repositories/{repositoryId}/file/diffs" tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/file/diffs: get: description: 'Gets the line-by-line difference between file on different commits. ' operationId: GetRepoFileDiff parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/FilePathQueryParam' - description: The branch to compare changes against. in: query name: baseVersion required: true schema: type: string - description: The branch where changes are coming from. in: query name: targetVersion required: true schema: type: string - description: Boolean to indicate whether to use merge base or most recent revision. in: query name: isComparisonFromMergeBase required: false x-default-description: 'null' schema: type: boolean - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Differences between the given file on the two given commits. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/FileDiffResponse' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the line-by-line difference between file on different commits tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/file/lines: get: description: 'Retrieve lines of a specified file. Supports starting line number and limit. ' operationId: GetRepoFileLines parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/FilePathQueryParam' - description: Retrieve file lines from specific revision. in: query name: revision required: true schema: type: string - description: Line number from where to start returning file lines. in: query name: startLineNumber required: false schema: type: integer default: 1 minimum: 1 - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieve the lines of a file successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryFileLines' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get lines of a specified file tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/files/{filePath}/lines: get: deprecated: true description: 'Retrieve lines of a specified file. Supports starting line number and limit. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ''/''. This will be replaced by "/repositories/{repositoryId}/file/lines" ' operationId: GetRepositoryFileLines parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/FilePathPathParam' - description: Retrieve file lines from specific revision. in: query name: revision required: true schema: type: string - description: Line number from where to start returning file lines. in: query name: startLineNumber required: false schema: type: integer default: 1 minimum: 1 - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieve the lines of a file successfully. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT. Please use "/repositories/{repositoryId}/file/lines" headers: Sunset: description: This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT. Please use "/repositories/{repositoryId}/file/lines" schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryFileLines' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get lines of a specified file. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has '/'. This will be replaced by "/repositories/{repositoryId}/file/lines" tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/forkSyncStatuses: get: description: LIST operation that returns a collection of fork sync status objects. operationId: ListForkSyncStatuses parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - description: Specifies the branch for which the fork sync status will be checked. in: query name: branchNameQueryParam required: true schema: type: string maxLength: 255 minLength: 1 responses: 200: description: Returns a filtered collection of fork sync statuses. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ForkSyncStatusCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: LIST operation that returns a collection of fork sync status objects tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/mirrorRecords: get: description: 'Returns a list of mirror entry in history within 30 days. ' operationId: ListMirrorRecords parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of mirror entry objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryMirrorRecordCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of mirror entry in history within 30 days tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/mirrorRecords/{mirrorRecordType}: get: description: 'Returns either current mirror record or last successful mirror record for a specific mirror repository. ' operationId: GetMirrorRecord parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/MirrorRecordTypePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves either current mirror record or last successful mirror record of a mirror repository. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryMirrorRecord' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets either current mirror record or last successful mirror record for a specific mirror repository tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/object: get: description: 'Retrieves blob of specific branch name/commit ID and file path. ' operationId: GetObject parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/FilePathQueryParam' - $ref: '#/components/parameters/RefNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieve the object successfully. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryObject' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get data about a blob/tree of specific branch name/commit id and file path tags: - devops x-related-resource: '#/definitions/RepositoryObject' /repositories/{repositoryId}/objects/{sha}/content: get: description: 'Retrieve contents of a specified object. ' operationId: GetObjectContent parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/ShaPathParam' - $ref: '#/components/parameters/FilePathQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieve the contents of an object successfully. headers: Content-Disposition: description: The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file. schema: type: string Content-Type: description: Content type refers to content of a file which is transferred via HTTP schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get contents of a specified Object tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/paths: get: description: 'Retrieves a list of files and directories in a repository. ' operationId: ListPaths parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - description: 'The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag. You can disambiguate with "heads/foobar" and "tags/foobar". If left blank repository''s default branch will be used. ' in: query name: ref required: false x-default-description: 'null' schema: type: string - description: Flag to determine if files must be retrived recursively. Flag is False by default. in: query name: pathsInSubtree required: false x-default-description: false schema: type: boolean - $ref: '#/components/parameters/FolderPathQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RepositoryObjectSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of files and directories provided in the repository. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryPathCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Fetches a list of files and directories in a repository. This API describes a snapshot of a repository's workspace as of a specific commit. tags: - devops x-related-resource: '#/definitions/RepositoryPathSummary' /repositories/{repositoryId}/principals/{principalId}/pullRequestNotificationPreference: get: description: Get the repository notification preference for the user passed as path param operationId: GetRepositoryNotificationPreference parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the notification preference information for the given repository id. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the repository notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/RepositoryNotificationPreference' put: description: Update the repository notification preference for the user passed as path param operationId: UpdateRepositoryNotificationPreference parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PrincipalIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Completed request to update repository notification preference. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryNotificationPreference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the repository notification preference for the user passed as path param tags: - devops x-related-resource: '#/definitions/RepositoryNotificationPreference' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRepositoryNotificationPreferenceDetails' description: The information to be updated. required: true /repositories/{repositoryId}/protectedBranches: get: description: 'Returns a list of Protected Branches. ' operationId: ListProtectedBranches parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/BranchNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BranchSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of protected branch summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ProtectedBranchCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Protected Branches in a Repository tags: - devops /repositories/{repositoryId}/pullRequestAuthors: get: description: 'Retrieve a list of all the PR authors. ' operationId: ListPullRequestAuthors parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of PR authors. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PullRequestAuthorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of all the PR authors tags: - devops x-related-resource: '#/definitions/Repository' /repositories/{repositoryId}/refs: get: description: 'Returns a list of references. ' operationId: ListRefs parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefTypeOptionalQueryParam' - $ref: '#/components/parameters/CommitIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RefNameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RefSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of reference summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryRefCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Refs in a Repository tags: - devops x-related-resource: '#/definitions/RepositoryRef' /repositories/{repositoryId}/refs/{refName}: delete: deprecated: true description: Deletes a Repository's Ref by its name. Returns an error if the name is ambiguous. Can be disambiguated by using full names like "heads/" or "tags/". This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef". operationId: DeleteRef parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the reference. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef". headers: Sunset: description: This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef". schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a Ref. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef". tags: - devops x-related-resource: '#/definitions/Repository' get: deprecated: true description: This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/refs". Retrieves a repository's reference by its name with preference for branches over tags if the name is ambiguous. This can be disambiguated by using full names like "heads/" or "tags/". operationId: GetRef parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the reference with the given name and type. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/refs". headers: Sunset: description: This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/refs". schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryRef' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a Ref. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/refs". tags: - devops x-related-resource: '#/definitions/Repository' put: deprecated: true description: 'Creates a new reference or updates an existing one. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ''/''. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef". ' operationId: PutRepositoryRef parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RefNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Request fulfilled to create the reference. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef". headers: Sunset: description: This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef". schema: type: string etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryRef' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Ref in the Repository or update an existing one. This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has '/'. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef". tags: - devops x-related-resource: '#/definitions/Repository' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutRepositoryRefDetails' description: The information to create a reference with the type specified in the query. required: true /repositories/{repositoryId}/repositorySettings: delete: description: Removes the custom settings configured for a repository operationId: DeleteRepositorySettings parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Completed request to delete custom repsitory settings. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes custom settings configured for a repository tags: - devops x-related-resource: '#/definitions/RepositorySettings' get: description: Retrieves a repository's settings details. operationId: GetRepositorySettings parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the settings information for the given repository id. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositorySettings' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets repository settings. tags: - devops x-related-resource: '#/definitions/RepositorySettings' put: description: Updates the settings for a repository. operationId: UpdateRepositorySettings parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Completed request to update repository settings. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositorySettings' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the settings of a repository. tags: - devops x-related-resource: '#/definitions/RepositorySettings' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRepositorySettingsDetails' description: Details to update settings for a repository. required: true /repository/{repositoryId}/repositoryAnalytics: post: description: Retrieves repository analytics for a given repository. operationId: SummarizeRepositoryAnalytics parameters: - $ref: '#/components/parameters/RepositoryIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the metrics for the given repository id. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RepositoryMetricAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieves repository analytics for a given repository. tags: - devops x-related-resource: '#/definitions/RepositoryMetricAggregation' requestBody: content: application/json: schema: $ref: '#/components/schemas/SummarizeRepositoryAnalyticsDetails' description: Details to fetch the repository analytics. required: true /triggers: get: description: 'Returns a list of triggers. ' operationId: ListTriggers parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/ProjectIdentifierQueryParam' - description: A filter to return only triggers that matches the given lifecycle state. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Trigger/lifecycleState' schema: type: string - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TriggerIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of trigger summary objects. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TriggerCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Triggers in a compartment tags: - devops x-related-resource: '#/definitions/TriggerCollection' post: description: 'Creates a new trigger. ' operationId: CreateTrigger parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Trigger that is created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TriggerCreateResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Trigger tags: - devops x-related-resource: '#/definitions/Trigger' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTriggerDetails' description: Details for the new trigger. required: true /triggers/{triggerId}: delete: description: Deletes a trigger resource by identifier. operationId: DeleteTrigger parameters: - $ref: '#/components/parameters/TriggerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to delete the trigger. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Trigger tags: - devops x-related-resource: '#/definitions/Trigger' get: description: Retrieves a trigger by identifier. operationId: GetTrigger parameters: - $ref: '#/components/parameters/TriggerIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the trigger with the given ID. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Trigger' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Trigger tags: - devops put: description: Updates the trigger. operationId: UpdateTrigger parameters: - $ref: '#/components/parameters/TriggerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted to update the trigger. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: Relative URL of the newly created resource. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Trigger' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Trigger identified by the id tags: - devops x-related-resource: '#/definitions/Trigger' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTriggerDetails' description: The information to be updated. required: true /workRequests: get: description: Lists the work requests in a compartment. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/WorkRequestOperationTypeMultiValueQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - devops x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Retrieves the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of the work request. headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - devops x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: Returns a list of errors for a given work request. operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - devops x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: Returns a list of logs for a given work request. operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - devops x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: DeployPipelineStage: description: Stage used in the pipeline for an artifact or environment. properties: deployStageId: description: The OCID of a stage type: string displayName: description: Display name of the stage. Avoid entering confidential information. type: string required: - deployStageId type: object ProjectRepositorySettings: description: User configured settings for project resources and their child repositories. properties: approvalRules: $ref: '#/components/schemas/ApprovalRuleCollection' mergeSettings: $ref: '#/components/schemas/MergeSettings' required: - mergeSettings - approvalRules type: object BuildRunSource: description: The source from which the build run is triggered. discriminator: propertyName: sourceType properties: sourceType: description: The source from which the build run is triggered. enum: - MANUAL - GITHUB - GITLAB - GITLAB_SERVER - BITBUCKET_CLOUD - BITBUCKET_SERVER - DEVOPS_CODE_REPOSITORY - VBS type: string required: - sourceType type: object PullRequest: description: Pull Request containing the diff between a review branch and a destination branch properties: compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/PrincipalDetails' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the pull request. Avoid entering confidential information. maxLength: 32000 type: string destinationBranch: description: 'The destination branch against which the changes are to be reviewed. Example: "main".' type: string displayName: description: PullRequest title, can be renamed maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation type: string lifecycleDetails: description: The status of the Pull Request. enum: - OPEN - CONFLICT - CLOSED - MERGING - MERGED type: string lifecycleState: description: The current state of the PullRequest. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string mergeBaseCommitIdAtTermination: description: The merge base commit ID when the Pull Request status was last changed to merged or closed type: string mergeChecks: $ref: '#/components/schemas/MergeCheckCollection' mergedBy: $ref: '#/components/schemas/PrincipalDetails' repositoryId: description: DevOps Repository Identifier tells which repository this pull request belongs to maxLength: 255 minLength: 1 type: string reviewers: description: List of Reviewers. items: $ref: '#/components/schemas/Reviewer' maxItems: 200 type: array sourceBranch: description: 'The source branch which contains the changes to be reviewed. Example: "feature/JIRA-123"' type: string sourceCommitIdAtTermination: description: The source branch commit ID when the Pull Request status was last changed to merged or closed type: string sourceRepositoryId: description: 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. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the PullRequest was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the PullRequest was updated. An RFC3339 formatted datetime string format: date-time type: string totalComments: description: The total number of comments on the pull request. type: integer totalReviewers: description: The total number of reviewers on the pull request. type: integer required: - id - displayName - compartmentId - repositoryId - sourceBranch - destinationBranch - lifecycleState - lifecycleDetails - timeCreated - createdBy - freeformTags - definedTags - systemTags - totalComments - totalReviewers type: object CreateDeployStageDetails: description: The information about new deployment stage. discriminator: propertyName: deployStageType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineId: description: The OCID of a pipeline. maxLength: 255 minLength: 1 type: string deployStagePredecessorCollection: $ref: '#/components/schemas/DeployStagePredecessorCollection' deployStageType: description: Deployment stage type. type: string x-obmcs-enumref: '#/definitions/DeployStage/deployStageType' description: description: Optional description about the deployment stage. maxLength: 400 type: string displayName: description: Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - deployStageType - deployPipelineId - deployStagePredecessorCollection type: object UpdateProjectDetails: description: The information to be updated for the given project. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Project description. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object notificationConfig: $ref: '#/components/schemas/NotificationConfig' type: object PullRequestAuthorSummary: description: Object containing summary of PR author. properties: principalDetails: $ref: '#/components/schemas/PrincipalDetails' required: - principalDetails type: object BuildPipelineStageSummary: description: Summary of the Stage. discriminator: propertyName: buildPipelineStageType properties: buildPipelineId: description: The OCID of the build pipeline. type: string buildPipelineStagePredecessorCollection: $ref: '#/components/schemas/BuildPipelineStagePredecessorCollection' buildPipelineStageType: description: 'Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE. ' type: string x-obmcs-enumref: '#/definitions/BuildPipelineStage/buildPipelineStageType' compartmentId: description: The OCID of the compartment where the pipeline is created. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build stage. maxLength: 400 type: string displayName: description: Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: 'The current state of the stage. ' type: string x-obmcs-enumref: '#/definitions/BuildPipelineStage/lifecycleState' projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - buildPipelineId - compartmentId - projectId - buildPipelineStageType type: object CreateBuildPipelineStageDetails: description: The information about a new stage. discriminator: propertyName: buildPipelineStageType properties: buildPipelineId: description: The OCID of the build pipeline. maxLength: 255 minLength: 1 type: string buildPipelineStagePredecessorCollection: $ref: '#/components/schemas/BuildPipelineStagePredecessorCollection' buildPipelineStageType: description: 'Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE. ' type: string x-obmcs-enumref: '#/definitions/BuildPipelineStage/buildPipelineStageType' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the stage. maxLength: 400 type: string displayName: description: Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - buildPipelineStageType - buildPipelineId - buildPipelineStagePredecessorCollection type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message CreateDeployPipelineDetails: description: The information about new deployment pipeline to be created. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineParameters: $ref: '#/components/schemas/DeployPipelineParameterCollection' description: description: Optional description about the deployment pipeline. maxLength: 400 type: string displayName: description: Deployment pipeline display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of a project. maxLength: 255 minLength: 1 type: string required: - projectId type: object ChangeProjectCompartmentDetails: description: The OCID of the compartment to which the project must be moved to. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the resource must be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object TriggerCollection: description: Results of a trigger search. Contains boh trigger summary items and other information such as metadata. properties: items: description: List of triggers. items: $ref: '#/components/schemas/TriggerSummary' type: array required: - items type: object DeployPipelineEnvironmentCollection: description: List of all environments used in the pipeline. properties: items: description: List of all environments used in the pipeline. items: $ref: '#/components/schemas/DeployPipelineEnvironment' type: array required: - items type: object Connection: description: The properties that define a connection to external repositories. discriminator: propertyName: connectionType properties: compartmentId: description: The OCID of the compartment containing the connection. maxLength: 255 minLength: 1 type: string connectionType: description: The type of connection. enum: - GITHUB_ACCESS_TOKEN - GITLAB_ACCESS_TOKEN - GITLAB_SERVER_ACCESS_TOKEN - BITBUCKET_SERVER_ACCESS_TOKEN - BITBUCKET_CLOUD_APP_PASSWORD - VBS_ACCESS_TOKEN type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the connection. maxLength: 400 type: string displayName: description: Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lastConnectionValidationResult: $ref: '#/components/schemas/ConnectionValidationResult' lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the connection. enum: - ACTIVE - DELETING type: string projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the connection was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the connection was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - connectionType type: object PullRequestFileChangeSummary: description: Entry for description of change on a file. properties: addedLinesCount: description: The number of lines added in whole difference. format: int32 minimum: 0 type: integer changeType: description: Type of change made to file. type: string commitId: description: The ID of the commit where the change is coming from. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deletedLinesCount: description: The number of lines deleted in whole difference. format: int32 minimum: 0 type: integer freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object hasConflicts: description: Indicates whether the changed file contains conflicts. type: boolean newId: description: The ID of the changed object on the source. type: string newPath: description: The path on the source to the changed object. type: string objectType: description: The type of the changed object. type: string oldId: description: The ID of the changed object on the target. type: string oldPath: description: The path on the target to the changed object. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object required: - changeType type: object RepositoryRef: description: Reference object with name and commit ID. discriminator: propertyName: refType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object fullRefName: description: Unique full reference name inside a repository. type: string refName: description: Unique reference name inside a repository. type: string refType: description: The type of reference (BRANCH or TAG). enum: - BRANCH - TAG type: string repositoryId: description: The OCID of the repository containing the reference. type: string required: - refName - refType - fullRefName - repositoryId type: object DeleteGitRefDetails: description: The information needed to delete a reference. properties: refName: description: A filter to return only resources that match the given reference name. maxLength: 255 minLength: 1 type: string required: - refName type: object DeploymentArgumentCollection: description: Specifies list of arguments passed along with the deployment. properties: items: description: List of arguments provided at the time of deployment. items: $ref: '#/components/schemas/DeploymentArgument' maxItems: 100 type: array required: - items type: object SyncRepositoryDetails: description: Details required for syncing a repository with its upstream. properties: destinationBranch: description: The branch in the repository we want to be updated with changes from the upstream. maxLength: 255 minLength: 1 type: string sourceBranch: description: The branch in the upstream repository we want to sync from. maxLength: 255 minLength: 1 type: string required: - sourceBranch - destinationBranch type: object PatchPullRequestDetails: description: Pull request details to patch properties: items: description: List of patch instructions items: $ref: '#/components/schemas/PatchInstruction' type: array type: object DeployStageSummary: description: Summary of the deployment stage. discriminator: propertyName: deployStageType properties: compartmentId: description: The OCID of a compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineId: description: The OCID of a pipeline. type: string deployStagePredecessorCollection: $ref: '#/components/schemas/DeployStagePredecessorCollection' deployStageType: description: Deployment stage type. type: string x-obmcs-enumref: '#/definitions/DeployStage/deployStageType' description: description: Optional description about the deployment stage. maxLength: 400 type: string displayName: description: Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment stage. type: string x-obmcs-enumref: '#/definitions/DeployStage/lifecycleState' projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - deployPipelineId - compartmentId - projectId - deployStageType type: object BuildPipelineCollection: description: Results of a pipeline search. properties: items: description: Array of build pipeline summary items. items: $ref: '#/components/schemas/BuildPipelineSummary' type: array required: - items type: object DeployArtifactOverrideArgumentCollection: description: Specifies the list of artifact override arguments at the time of deployment. properties: items: description: List of artifact override arguments at the time of deployment. items: $ref: '#/components/schemas/DeployArtifactOverrideArgument' maxItems: 100 type: array required: - items type: object SummarizeProjectRepositoryAnalyticsDetails: allOf: - $ref: '#/components/schemas/RepositoryAnalyticsDetails' description: Details of the user configured settings for viewing the metrics at project level. PutRepositoryRefDetails: description: The information needed to create a reference. If the reference already exists, then it can be used to update the reference. discriminator: propertyName: refType properties: refType: description: The type of reference (BRANCH or TAG). enum: - BRANCH - TAG type: string required: - refType type: object ConnectionValidationResult: description: The result of validating the credentials of a connection. properties: message: description: A message describing the result of connection validation in more detail. type: string result: description: The latest result of whether the credentials pass the validation. enum: - PASS - FAIL type: string timeValidated: description: The latest timestamp when the connection was validated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string type: object ApproveDeploymentDetails: description: The stage information for submitting for approval. properties: action: description: The action of Approve or Reject. enum: - APPROVE - REJECT type: string deployStageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the stage which is marked for approval. maxLength: 255 minLength: 1 type: string reason: description: The reason for approving or rejecting the deployment. maxLength: 512 minLength: 1 type: string required: - deployStageId - action type: object UpdateBuildPipelineDetails: description: The information to be updated for the given build pipeline. properties: buildPipelineParameters: $ref: '#/components/schemas/BuildPipelineParameterCollection' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build pipeline. maxLength: 400 type: string displayName: description: Build pipeline display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object type: object UpdateDeployEnvironmentDetails: description: The information to be updated. discriminator: propertyName: deployEnvironmentType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployEnvironmentType: description: Deployment environment type. type: string x-obmcs-enumref: '#/definitions/DeployEnvironment/deployEnvironmentType' description: description: Optional description about the deployment environment. maxLength: 400 type: string displayName: description: Deployment environment display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - deployEnvironmentType type: object Filter: description: The filters for the trigger. discriminator: propertyName: triggerSource properties: triggerSource: description: Source of the trigger. Allowed values are, GITHUB and GITLAB. type: string x-obmcs-enumref: '#/definitions/Trigger/triggerSource' required: - triggerSource type: object PullRequestChangeSummaryMetrics: description: Response object for obtaining summary metric of Pull Request changed files. properties: addedLinesCount: description: The number of lines added in whole difference. format: int32 minimum: 0 type: integer changedFilesCount: description: The number of lines added in whole difference. format: int32 minimum: 0 type: integer deletedLinesCount: description: The number of lines deleted in whole difference. format: int32 minimum: 0 type: integer required: - changedFilesCount - addedLinesCount - deletedLinesCount type: object RepositoryCollection: description: Results of a repository search. Contains repository summary items and other information, such as metadata. properties: items: description: List of repositories. items: $ref: '#/components/schemas/RepositorySummary' type: array required: - items type: object BuildRunArgument: description: Values for pipeline parameters to be supplied at the time of running the build. properties: name: description: 'Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: ''Build_Pipeline_param'' is not same as ''build_pipeline_Param'' ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string value: description: Value of the argument. maxLength: 1024 minLength: 1 type: string required: - name - value type: object UpdateRepositorySettingsDetails: description: Information to update custom repository settings properties: approvalRules: $ref: '#/components/schemas/UpdateApprovalRuleDetailsCollection' mergeChecks: $ref: '#/components/schemas/MergeChecks' mergeSettings: $ref: '#/components/schemas/MergeSettings' type: object DeployArtifactSummary: description: Summary of the deployment artifact. properties: argumentSubstitutionMode: description: Mode for artifact parameter substitution. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/argumentSubstitutionMode' compartmentId: description: The OCID of a compartment. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactSource: $ref: '#/components/schemas/DeployArtifactSource' deployArtifactType: description: Type of the deployment artifact. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/deployArtifactType' description: description: Optional description about the deployment artifact. maxLength: 400 type: string displayName: description: Deployment artifact identifier, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Current state of the deployment artifact. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/lifecycleState' projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment artifact was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment artifact was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - deployArtifactType - deployArtifactSource - argumentSubstitutionMode type: object CreateConnectionDetails: description: 'The details for creating a connection. ' discriminator: propertyName: connectionType properties: connectionType: description: The type of connection. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the connection. maxLength: 400 type: string displayName: description: Optional connection display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of the DevOps project. maxLength: 255 minLength: 1 type: string required: - projectId - connectionType type: object UpdateApprovalRuleDetails: description: A rule which must be satisfied for matching pull requests before the pull request can be merged properties: destinationBranch: description: Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests type: string minApprovalsCount: description: Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied type: integer name: description: Name which is used to uniquely identify an approval rule. format: x-obmcs-ascii-identifier maxLength: 100 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string reviewers: description: List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. items: $ref: '#/components/schemas/UpdateReviewerDetails' maxItems: 50 type: array required: - name - minApprovalsCount type: object BuildPipelineSummary: description: Summary of the build pipeline. properties: buildPipelineParameters: $ref: '#/components/schemas/BuildPipelineParameterCollection' compartmentId: description: The OCID of the compartment where the build pipeline is created. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build pipeline. maxLength: 400 type: string displayName: description: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the build pipeline. type: string x-obmcs-enumref: '#/definitions/BuildPipeline/lifecycleState' projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the build pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the build pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - compartmentId - projectId type: object CreateBuildPipelineDetails: description: Information about the new build pipeline to be created. properties: buildPipelineParameters: $ref: '#/components/schemas/BuildPipelineParameterCollection' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build pipeline. maxLength: 400 type: string displayName: description: Build pipeline display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of the DevOps project. maxLength: 255 minLength: 1 type: string required: - projectId type: object TriggerAction: description: The trigger action to be performed. discriminator: propertyName: type properties: filter: $ref: '#/components/schemas/Filter' type: description: The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. enum: - TRIGGER_BUILD_PIPELINE type: string required: - type type: object MergeStrategy: description: Merge strategies which can be enabled or disabled for a repository or project. enum: - MERGE_COMMIT - FAST_FORWARD - FAST_FORWARD_ONLY - REBASE_AND_MERGE - REBASE_AND_FAST_FORWARD - SQUASH - SQUASH_FAST_FORWARD_ONLY type: string WorkRequestSummary: description: Details of the work request status. properties: compartmentId: description: The OCID of the compartment that contains the work request. Work requests must be scoped to the same compartment as the resource that the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, the service team must pick the primary resource whose compartment must be used. type: string id: description: The OCID of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_PROJECT - UPDATE_PROJECT - DELETE_PROJECT - MOVE_PROJECT - CREATE_DEPLOY_PIPELINE - UPDATE_DEPLOY_PIPELINE - DELETE_DEPLOY_PIPELINE - CREATE_DEPLOY_STAGE - UPDATE_DEPLOY_STAGE - DELETE_DEPLOY_STAGE - CREATE_DEPLOY_ARTIFACT - UPDATE_DEPLOY_ARTIFACT - DELETE_DEPLOY_ARTIFACT - CREATE_DEPLOY_ENVIRONMENT - UPDATE_DEPLOY_ENVIRONMENT - DELETE_DEPLOY_ENVIRONMENT - CREATE_DEPLOYMENT - UPDATE_DEPLOYMENT - DELETE_DEPLOYMENT - CREATE_BUILD_PIPELINE - UPDATE_BUILD_PIPELINE - DELETE_BUILD_PIPELINE - CREATE_BUILD_PIPELINE_STAGE - UPDATE_BUILD_PIPELINE_STAGE - DELETE_BUILD_PIPELINE_STAGE - CREATE_CONNECTION - UPDATE_CONNECTION - DELETE_CONNECTION - CREATE_TRIGGER - UPDATE_TRIGGER - DELETE_TRIGGER - EXECUTE_TRIGGER - CREATE_REPOSITORY - UPDATE_REPOSITORY - DELETE_REPOSITORY - MIRROR_REPOSITORY - FORK_REPOSITORY - SYNC_FORK_REPOSITORY - SCHEDULE_CASCADING_PROJECT_DELETION - CANCEL_SCHEDULED_CASCADING_PROJECT_DELETION - CREATE_PULL_REQUEST - UPDATE_PULL_REQUEST - DELETE_PULL_REQUEST - MOVE_PULL_REQUEST - MERGE_PULL_REQUEST type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - WAITING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: Date and time the request was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeFinished: description: Date and time the request was completed. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: Date and time the request was started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted FileDiffResponse: description: Response object for showing differences for a file between two commits. properties: areConflictsInFile: description: Indicates whether the changed file contains conflicts. type: boolean changes: description: List of changed section in the file. items: $ref: '#/components/schemas/DiffChunk' type: array isBinary: description: Indicates whether the file is binary. type: boolean isLarge: description: Indicates whether the file is large. type: boolean newId: description: The ID of the changed object on the target version. type: string newPath: description: The path on the target version to the changed object. type: string oldId: description: The ID of the changed object on the base version. type: string oldPath: description: The path on the base version to the changed object. type: string required: - changes type: object CreateOrUpdateGitRefDetails: description: The information needed to create a reference. If the reference already exists, then it can be used to update the reference. discriminator: propertyName: refType properties: refName: description: The name of the reference to create or update. maxLength: 255 minLength: 1 type: string refType: description: The type of reference (BRANCH or TAG). enum: - BRANCH - TAG type: string required: - refName - refType type: object SummarizeRepositoryAnalyticsDetails: allOf: - $ref: '#/components/schemas/RepositoryAnalyticsDetails' description: Details of the user configured settings for viewing the metrics at repository level. NotificationConfig: description: Notification configuration for the project. properties: topicId: description: The topic ID for notifications. maxLength: 255 minLength: 1 type: string required: - topicId type: object PullRequestComment: description: User comments created by reviewers during the pull request review. properties: commentContext: description: 4 line snippet to be displayed as context for inline comments items: $ref: '#/components/schemas/DiffLineDetails' type: array commitId: description: Commit SHA type: string contextStatus: description: Shows the status of an inline comments context enum: - PROCESSED - NEEDS_PROCESSING type: string createdBy: $ref: '#/components/schemas/PrincipalDetails' data: description: Content of the Comment. maxLength: 16000 type: string filePath: description: File path in the commit type: string fileType: description: File path in the target commit enum: - SOURCE - DESTINATION type: string id: description: Unique identifier that is immutable on creation type: string likes: $ref: '#/components/schemas/PullRequestCommentLikeCollection' lineNumber: description: Line number in the file type: integer parentId: description: ID of parent Comment type: string pullRequestId: description: OCID of the pull request that this comment belongs to type: string status: description: Status of the Comment enum: - ACTIVE - OUTDATED type: string timeCreated: description: Creation timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Latest update timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string updatedBy: $ref: '#/components/schemas/PrincipalDetails' required: - id - pullRequestId - data - timeCreated - createdBy - status type: object PullRequestAttachmentCollection: description: Result of list pullRequest attachment. properties: items: description: List of pullRequest attachment objects. items: $ref: '#/components/schemas/PullRequestAttachmentSummary' type: array required: - items type: object ReviewPullRequestDetails: description: Details to submit pull request review properties: action: description: The review action taken enum: - APPROVE - UNAPPROVE type: string required: - action type: object PullRequestSummary: description: Summary of the Pull Request. properties: compartmentId: description: Compartment Identifier maxLength: 255 minLength: 1 type: string createdBy: $ref: '#/components/schemas/PrincipalDetails' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the pull request. Avoid entering confidential information. maxLength: 32000 type: string destinationBranch: description: The destination branch against which the changes are to be reviewed. type: string displayName: description: Pull Request title, can be renamed type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation type: string lifecycleDetails: description: The status of the Pull Request. type: string x-obmcs-enumref: '#/definitions/PullRequest/lifecycleDetails' lifecycleState: description: The current state of the Pull Request. type: string x-obmcs-enumref: '#/definitions/PullRequest/lifecycleState' mergeBaseCommitIdAtTermination: description: The merge base commit ID when the Pull Request status was last changed to merged or closed type: string repositoryId: description: DevOps Repository Identifier maxLength: 255 minLength: 1 type: string sourceBranch: description: The review branch which contains the changes to be reviewed. type: string sourceCommitIdAtTermination: description: The source branch commit ID when the Pull Request status was last changed to merged or closed type: string sourceRepositoryId: description: 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. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the the Pull Request was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Pull Request was updated. An RFC3339 formatted datetime string format: date-time type: string totalComments: description: The total number of comments on the pull request. type: integer totalReviewers: description: The total number of reviewers on the pull request. type: integer required: - id - displayName - compartmentId - repositoryId - sourceBranch - destinationBranch - lifecycleState - lifecycleDetails - timeCreated - freeformTags - definedTags - systemTags - createdBy - totalComments - totalReviewers type: object BuildPipelineStagePredecessorCollection: description: The collection containing the predecessors of a stage. properties: items: description: A list of build pipeline stage predecessors for a stage. items: $ref: '#/components/schemas/BuildPipelineStagePredecessor' type: array required: - items type: object RepositoryPathSummary: description: Object containing information about files and directories in a repository. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object name: description: Name of file or directory. type: string path: description: Path to file or directory in a repository. type: string sha: description: SHA-1 checksum of blob or tree. type: string sizeInBytes: description: Size of file or directory. format: int64 type: integer submoduleGitUrl: description: The git URL of the submodule. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object type: description: File or directory. type: string type: object TriggerSummary: description: Summary of the trigger. discriminator: propertyName: triggerSource properties: compartmentId: description: The OCID of the compartment that contains the trigger. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Description about the trigger. maxLength: 400 type: string displayName: description: Trigger display name. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the trigger. type: string x-obmcs-enumref: '#/definitions/Trigger/lifecycleState' projectId: description: The OCID of the DevOps project to which the trigger belongs to. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the trigger was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the trigger was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string triggerSource: description: Source of the trigger. Allowed values are, GITHUB and GITLAB. type: string x-obmcs-enumref: '#/definitions/Trigger/triggerSource' required: - id - projectId - compartmentId - triggerSource type: object DeployStagePredecessor: description: Metadata for defining a stage's predecessor. properties: id: description: The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID. type: string required: - id type: object CommitAnalyticsAuthorSummary: description: Object containing summary of Commit Analytics author. properties: authorEmail: description: Author email. type: string authorName: description: Author name. type: string required: - authorName - authorEmail type: object DeployStagePredecessorCollection: description: Collection containing the predecessors of a stage. properties: items: description: A list of stage predecessors for a stage. items: $ref: '#/components/schemas/DeployStagePredecessor' type: array required: - items type: object DiffChunk: description: Details about a group of changes. properties: baseLine: description: Line number in base version where changes begin. type: integer baseSpan: description: Number of lines chunk spans in base version. type: integer diffSections: description: List of difference section. items: $ref: '#/components/schemas/DiffSection' type: array targetLine: description: Line number in target version where changes begin. type: integer targetSpan: description: Number of lines chunk spans in target version. type: integer type: object DeployStageOverrideArgumentCollection: description: Specifies the list of arguments to be overriden per Stage at the time of deployment. properties: items: description: List of artifact override arguments at the time of deployment. items: $ref: '#/components/schemas/DeployStageOverrideArgument' maxItems: 100 type: array required: - items type: object CreateDeploymentDetails: description: The information about new deployment. discriminator: propertyName: deploymentType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineId: description: The OCID of a pipeline. maxLength: 255 minLength: 1 type: string deploymentType: description: Specifies type for this deployment. type: string x-obmcs-enumref: '#/definitions/Deployment/deploymentType' displayName: description: Deployment display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - deploymentType - deployPipelineId type: object ProjectCollection: description: Results of an project search. properties: items: description: List of project summary items. items: $ref: '#/components/schemas/ProjectSummary' type: array required: - items type: object BuildRunArgumentCollection: description: 'Specifies list of arguments passed along with the build run. ' properties: items: description: List of arguments provided at the time of running the build. items: $ref: '#/components/schemas/BuildRunArgument' type: array required: - items type: object RepositoryCommit: description: Commit object with commit information. properties: authorEmail: description: Email of the author of the repository. type: string authorName: description: Name of the author of the repository. type: string commitId: description: Commit hash pointed to by reference name. type: string commitMessage: description: The commit message. type: string committerEmail: description: Email of who creates the commit. type: string committerName: description: Name of who creates the commit. type: string parentCommitIds: description: An array of parent commit IDs of created commit. items: type: string type: array timeCreated: description: The time at which commit was created. format: date-time type: string treeId: description: Tree information for the specified commit. type: string required: - commitId - commitMessage type: object DeployStage: description: 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 Function or a Kubernetes cluster. discriminator: propertyName: deployStageType properties: compartmentId: description: The OCID of a compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineId: description: The OCID of a pipeline. type: string deployStagePredecessorCollection: $ref: '#/components/schemas/DeployStagePredecessorCollection' deployStageType: description: Deployment stage type. enum: - WAIT - COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT - COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT - COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT - COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT - COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT - COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL - OKE_BLUE_GREEN_DEPLOYMENT - OKE_BLUE_GREEN_TRAFFIC_SHIFT - OKE_CANARY_DEPLOYMENT - OKE_CANARY_TRAFFIC_SHIFT - OKE_CANARY_APPROVAL - OKE_DEPLOYMENT - DEPLOY_FUNCTION - INVOKE_FUNCTION - LOAD_BALANCER_TRAFFIC_SHIFT - MANUAL_APPROVAL - OKE_HELM_CHART_DEPLOYMENT - SHELL type: string description: description: Optional description about the deployment stage. maxLength: 400 type: string displayName: description: Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment stage. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - deployPipelineId - compartmentId - projectId - deployStageType type: object DeploymentExecutionProgress: description: The execution progress details of a deployment. properties: deployStageExecutionProgress: additionalProperties: $ref: '#/components/schemas/DeployStageExecutionProgress' description: Map of stage OCIDs to deploy stage execution progress model. type: object timeFinished: description: Time the deployment is finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: Time the deployment is started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string type: object PrincipalDetails: description: The principal details properties: principalId: description: the OCID of the principal type: string principalName: description: the name of the principal type: string principalState: description: The state of the principal, it can be active or inactive or suppressed for emails enum: - ACTIVE - INACTIVE - SUPPRESSED type: string principalType: description: the type of principal enum: - SERVICE - USER - INSTANCE - RESOURCE type: string required: - principalId type: object ApprovalRuleCollection: description: List of approval rules which must be statisfied before pull requests which match the rules can be merged properties: items: description: List of approval rules. items: $ref: '#/components/schemas/ApprovalRule' maxItems: 30 type: array required: - items type: object PullRequestCommentLikeCollection: description: Abstract of Pull Request Comment likes. properties: totalLikes: description: Total like counter type: integer users: description: List of liked users of whom liked the pull request comment (max size is 50). items: $ref: '#/components/schemas/PrincipalDetails' maxItems: 50 type: array required: - users - totalLikes type: object PullRequestCommentSummary: description: summary of a pullRequest comment properties: commentContext: description: 4 line snippet to be displayed as context for inline comments items: $ref: '#/components/schemas/DiffLineDetails' type: array commitId: description: Commit SHA type: string contextStatus: description: Shows the status of an inline comments context type: string x-obmcs-enumref: '#/definitions/PullRequestComment/contextStatus' createdBy: $ref: '#/components/schemas/PrincipalDetails' data: description: Content of the Comment. maxLength: 16000 type: string filePath: description: File path in the commit type: string fileType: description: File path in the target commit type: string x-obmcs-enumref: '#/definitions/PullRequestComment/fileType' id: description: Unique identifier that is immutable on creation type: string likes: $ref: '#/components/schemas/PullRequestCommentLikeCollection' lineNumber: description: Line number in the file type: integer parentId: description: ID of parent Comment type: string pullRequestId: description: OCID of the pull request that this comment belongs to type: string status: description: Status of the Comment type: string x-obmcs-enumref: '#/definitions/PullRequestComment/status' timeCreated: description: Creation timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Latest update timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string updatedBy: $ref: '#/components/schemas/PrincipalDetails' required: - id - pullRequestId - data - timeCreated - createdBy - status type: object UpdateBuildRunDetails: description: The build run information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object displayName: description: Build run display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object type: object DeployPipelineStageCollection: description: List of stages. properties: items: description: List of stages. items: $ref: '#/components/schemas/DeployPipelineStage' type: array required: - items type: object TriggerSchedule: description: Specifies a trigger schedule. Timing information for when to initiate automated syncs. properties: customSchedule: description: 'Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. ' format: x-obmcs-recurring-time maxLength: 400 type: string scheduleType: default: DEFAULT description: 'Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule. ' enum: - NONE - DEFAULT - CUSTOM type: string required: - scheduleType type: object RepositoryRefCollection: description: Result of a reference search. properties: items: description: List of references. items: $ref: '#/components/schemas/RepositoryRefSummary' type: array required: - items type: object DeployEnvironmentCollection: description: Results of a deployment environment search. properties: items: description: Deployment environment summary items found for the search. items: $ref: '#/components/schemas/DeployEnvironmentSummary' type: array required: - items type: object RepositoryMirrorRecordSummary: description: Object containing information about a mirror record. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object mirrorStatus: description: 'Mirror status of current mirror entry. QUEUED - Mirroring Queued RUNNING - Mirroring is Running PASSED - Mirroring Passed FAILED - Mirroring Failed ' enum: - NONE - QUEUED - RUNNING - PASSED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCompleted: description: The time to complete a mirror operation. format: date-time type: string timeEnqueued: description: The time to enqueue a mirror operation. format: date-time type: string timeStarted: description: The time to start a mirror operation. format: date-time type: string workRequestId: description: Workrequest ID to track current mirror operation. type: string required: - mirrorStatus type: object CreateReviewerDetails: description: The reviewer to be created. properties: principalId: description: Pull Request reviewer id maxLength: 255 minLength: 1 type: string required: - principalId type: object ProjectSummary: description: Summary of the project. properties: compartmentId: description: The OCID of the compartment where the project is created. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Project description. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the project. type: string x-obmcs-enumref: '#/definitions/Project/lifecycleState' name: description: Project name (case-sensitive). type: string namespace: description: Namespace associated with the project. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the project was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the project was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - name - compartmentId type: object RepositoryMetricSummary: description: The metrics details of a repository resource. properties: count: description: Represents the total number of the metric being calculated. format: double type: number dimensions: additionalProperties: type: string description: The qualifiers provided in the definition of the returned metric. type: object durationInSeconds: description: The duration of the returned aggregated data in seconds. format: int64 type: integer metricName: description: Type of metric enum: - COMMITS - LINES_ADDED - LINES_DELETED - PULL_REQUEST_CREATED - PULL_REQUEST_MERGED - PULL_REQUEST_DECLINED - PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS - PULL_REQUEST_REVIEW_DURATION_IN_DAYS - PULL_REQUEST_APPROVED - PULL_REQUEST_REVIEWED - PULL_REQUEST_COMMENTS type: string x-obmcs-top-level-enum: '#/definitions/MetricName' startTimestampInEpochSeconds: description: The start time associated with the value of the metric. format: int64 type: integer sum: description: 'Represents the total duration in days calculated corresponding to the total no. of PRs. This is used only for "PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS" and "PULL_REQUEST_REVIEW_DURATION_IN_DAYS" metrics. ' format: double type: number type: object MergeCheck: description: Merge Check summary discriminator: propertyName: type properties: type: description: the type of this merge check. enum: - CONFLICT - APPROVAL_RULE - BUILD type: string required: - type type: object BuildPipeline: description: A set of stages forming a directed acyclic graph that defines the build process. properties: buildPipelineParameters: $ref: '#/components/schemas/BuildPipelineParameterCollection' compartmentId: description: The OCID of the compartment where the build pipeline is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build pipeline. maxLength: 400 type: string displayName: description: Build pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the build pipeline. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the build pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the build pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId type: object UpdateConnectionDetails: description: 'The details for updating a connection. ' discriminator: propertyName: connectionType properties: connectionType: description: The type of connection. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the connection. maxLength: 400 type: string displayName: description: Optional connection display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - connectionType type: object PullRequestFileChangeCollection: description: Result of Pull Request difference. properties: items: description: List of objects describing Pull Request differences for changed files. items: $ref: '#/components/schemas/PullRequestFileChangeSummary' type: array required: - items type: object DeployArtifact: description: Artifacts are deployment manifests that are referenced in a pipeline stage for automated deployment to the target environment. DevOps artifacts can be an OCI Container image repository, Kubernetes manifest, an Artifact Registry artifact, or defined inline. properties: argumentSubstitutionMode: description: Mode for artifact parameter substitution. enum: - NONE - SUBSTITUTE_PLACEHOLDERS type: string compartmentId: description: The OCID of a compartment. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactSource: $ref: '#/components/schemas/DeployArtifactSource' deployArtifactType: description: Type of the deployment artifact. enum: - DEPLOYMENT_SPEC - JOB_SPEC - KUBERNETES_MANIFEST - GENERIC_FILE - DOCKER_IMAGE - HELM_CHART - HELM_COMMAND_SPEC - COMMAND_SPEC type: string description: description: Optional description about the artifact to be deployed. maxLength: 400 type: string displayName: description: Deployment artifact identifier, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Current state of the deployment artifact. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment artifact was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment artifact was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - deployArtifactType - deployArtifactSource - argumentSubstitutionMode type: object ForkSyncStatusCollection: description: A collection of Fork Sync Status summaries. properties: items: description: List of fork sync status objects. items: $ref: '#/components/schemas/ForkSyncStatusSummary' maxItems: 1 minItems: 1 type: array required: - items type: object MergePullRequestDetails: description: determines if this is a merge or a validation. discriminator: propertyName: actionType properties: actionType: description: the type of action for this merge. enum: - EXECUTE - VALIDATE type: string required: - actionType type: object DeploymentCollection: description: Results of a deployment search. properties: items: description: Array of deployment summary items. items: $ref: '#/components/schemas/DeploymentSummary' type: array required: - items type: object CreateDeployArtifactDetails: description: Information about a new deployment artifact. properties: argumentSubstitutionMode: description: Mode for artifact parameter substitution. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/argumentSubstitutionMode' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactSource: $ref: '#/components/schemas/DeployArtifactSource' deployArtifactType: description: Type of the deployment artifact. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/deployArtifactType' description: description: Optional description about the deployment artifact. maxLength: 400 type: string displayName: description: Deployment artifact display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of a project. maxLength: 255 minLength: 1 type: string required: - deployArtifactType - deployArtifactSource - projectId - argumentSubstitutionMode type: object RepositoryFileLines: description: Object containing the lines of a file in a repository. properties: lines: description: The list of lines in the file. items: $ref: '#/components/schemas/FileLineDetails' type: array required: - lines type: object PullRequestNotificationPreference: description: The notification preference of the pull request. properties: notificationPreference: description: The override value of pull request notification preference. enum: - WATCH - IGNORE - MENTION type: string pullRequestId: description: The ocid of pull request resource maxLength: 255 minLength: 1 type: string userId: description: The ocid of user. maxLength: 255 minLength: 1 type: string required: - pullRequestId - userId - notificationPreference type: object DeployPipelineSummary: description: Summary of the deployment pipeline. properties: compartmentId: description: The OCID of a compartment where the pipeline is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineParameters: $ref: '#/components/schemas/DeployPipelineParameterCollection' description: description: Optional description about the deployment pipeline. maxLength: 400 type: string displayName: description: Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment pipeline. type: string x-obmcs-enumref: '#/definitions/DeployPipeline/lifecycleState' projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId type: object DeployStageCollection: description: Result of a stage search. properties: items: description: Deployment stage summary items found for the search. items: $ref: '#/components/schemas/DeployStageSummary' type: array required: - items type: object MirrorRepositoryConfig: description: Configuration information for mirroring the repository. properties: connectorId: description: Upstream git repository connection identifier. type: string repositoryUrl: description: URL of external repository you want to mirror. type: string triggerSchedule: $ref: '#/components/schemas/TriggerSchedule' type: object CancelBuildRunDetails: description: Information about canceling the build run. properties: reason: description: The reason for canceling the build run. maxLength: 1024 minLength: 1 type: string required: - reason type: object PullRequestAttachment: description: Pull Request attachment created by users. properties: createdBy: $ref: '#/components/schemas/PrincipalDetails' fileName: description: name to display in description or comment type: string id: description: Unique identifier that is immutable on creation type: string pullRequestId: description: OCID of the pull request that this attachment belongs to type: string timeCreated: description: Creation timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - pullRequestId - fileName - timeCreated - createdBy type: object BuildRunSummary: description: Summary of the build run. properties: buildPipelineId: description: The OCID of the build pipeline. type: string buildRunArguments: $ref: '#/components/schemas/BuildRunArgumentCollection' buildRunProgressSummary: $ref: '#/components/schemas/BuildRunProgressSummary' buildRunSource: $ref: '#/components/schemas/BuildRunSource' commitInfo: $ref: '#/components/schemas/CommitInfo' compartmentId: description: The OCID of the compartment where the build is running. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object displayName: description: Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the build run. type: string x-obmcs-enumref: '#/definitions/BuildRun/lifecycleState' projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the build run was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the build run was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - buildPipelineId - compartmentId - buildRunSource type: object RepositoryCommitCollection: description: Result of a commit search. properties: items: description: List of commit objects. items: $ref: '#/components/schemas/RepositoryCommitSummary' type: array required: - items type: object UpdateDeployPipelineDetails: description: The information to be updated for the given deloyment pipeline. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineParameters: $ref: '#/components/schemas/DeployPipelineParameterCollection' description: description: Optional description about the deloyment pipeline. maxLength: 400 type: string displayName: description: Deloyment pipeline display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object type: object DeployPipeline: description: A set of stages whose predecessor relation forms a directed acyclic graph. properties: compartmentId: description: The OCID of the compartment where the pipeline is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployPipelineArtifacts: $ref: '#/components/schemas/DeployPipelineArtifactCollection' deployPipelineEnvironments: $ref: '#/components/schemas/DeployPipelineEnvironmentCollection' deployPipelineParameters: $ref: '#/components/schemas/DeployPipelineParameterCollection' description: description: Optional description about the deployment pipeline. maxLength: 400 type: string displayName: description: Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment pipeline. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - deployPipelineParameters type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: Time the log message was written. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - message - timestamp VulnerabilityAuditSummary: description: Summary of vulnerability audit. properties: buildStageId: description: Build stage OCID where scan was configured. maxLength: 255 minLength: 1 type: string commitHash: description: Commit hash used while retrieving the pom file for vulnerabilityAudit. maxLength: 255 minLength: 1 type: string vulnerabilityAuditId: description: The OCID of the vulnerability audit. maxLength: 255 minLength: 1 type: string required: - vulnerabilityAuditId - buildStageId UpdateReviewerDetails: description: The reviewer to be updated. properties: principalId: description: Pull Request reviewer id maxLength: 255 minLength: 1 type: string required: - principalId type: object PullRequestCollection: description: Results of a Pull Request search. Contains both PullRequestSummary items and other information, such as metadata. properties: items: description: List of Pull Requests. items: $ref: '#/components/schemas/PullRequestSummary' type: array required: - items type: object DeployPipelineCollection: description: Results of an pipeline search. properties: items: description: Array of deployment pipeline summary items. items: $ref: '#/components/schemas/DeployPipelineSummary' type: array required: - items type: object UpdateDeployArtifactDetails: description: The information to be updated for the artifact. properties: argumentSubstitutionMode: description: Mode for artifact parameter substitution. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/argumentSubstitutionMode' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactSource: $ref: '#/components/schemas/DeployArtifactSource' deployArtifactType: description: Type of the deployment artifact. type: string x-obmcs-enumref: '#/definitions/DeployArtifact/deployArtifactType' description: description: Optional description about the deployment artifact. maxLength: 400 type: string displayName: description: Deployment artifact display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object type: object WorkRequest: description: Details of the work request status. properties: compartmentId: description: The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. type: string id: description: The OCID of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_PROJECT - UPDATE_PROJECT - DELETE_PROJECT - MOVE_PROJECT - CREATE_DEPLOY_PIPELINE - UPDATE_DEPLOY_PIPELINE - DELETE_DEPLOY_PIPELINE - CREATE_DEPLOY_STAGE - UPDATE_DEPLOY_STAGE - DELETE_DEPLOY_STAGE - CREATE_DEPLOY_ARTIFACT - UPDATE_DEPLOY_ARTIFACT - DELETE_DEPLOY_ARTIFACT - CREATE_DEPLOY_ENVIRONMENT - UPDATE_DEPLOY_ENVIRONMENT - DELETE_DEPLOY_ENVIRONMENT - CREATE_DEPLOYMENT - UPDATE_DEPLOYMENT - DELETE_DEPLOYMENT - CREATE_BUILD_PIPELINE - UPDATE_BUILD_PIPELINE - DELETE_BUILD_PIPELINE - CREATE_BUILD_PIPELINE_STAGE - UPDATE_BUILD_PIPELINE_STAGE - DELETE_BUILD_PIPELINE_STAGE - CREATE_CONNECTION - UPDATE_CONNECTION - DELETE_CONNECTION - CREATE_TRIGGER - UPDATE_TRIGGER - DELETE_TRIGGER - EXECUTE_TRIGGER - CREATE_REPOSITORY - UPDATE_REPOSITORY - DELETE_REPOSITORY - MIRROR_REPOSITORY - FORK_REPOSITORY - SYNC_FORK_REPOSITORY - SCHEDULE_CASCADING_PROJECT_DELETION - CANCEL_SCHEDULED_CASCADING_PROJECT_DELETION - CREATE_PULL_REQUEST - UPDATE_PULL_REQUEST - DELETE_PULL_REQUEST - MOVE_PULL_REQUEST - MERGE_PULL_REQUEST type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - WAITING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: Date and time the request was created, Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeFinished: description: Date and time the request was completed. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: Date and time the request was started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CancelDeploymentDetails: description: The information regarding the deployment to be canceled. properties: reason: description: The reason for canceling the deployment. maxLength: 512 minLength: 1 type: string required: - reason type: object BuildPipelineStage: description: "A single node in a build pipeline. A stage takes a specific designated action. \nThere are many types of stages such as 'BUILD' and 'DELIVER_ARTIFACT'.\n" discriminator: propertyName: buildPipelineStageType properties: buildPipelineId: description: The OCID of the build pipeline. type: string buildPipelineStagePredecessorCollection: $ref: '#/components/schemas/BuildPipelineStagePredecessorCollection' buildPipelineStageType: description: 'Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE. ' enum: - WAIT - BUILD - DELIVER_ARTIFACT - TRIGGER_DEPLOYMENT_PIPELINE type: string compartmentId: description: The OCID of the compartment where the pipeline is created. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build stage. maxLength: 400 type: string displayName: description: Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: 'The current state of the stage. ' enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - buildPipelineId - compartmentId - projectId - buildPipelineStageType type: object DiffLineDetails: description: Details about a line within the difference. properties: baseLine: description: The number of a line in the base version. type: integer conflictMarker: description: Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. enum: - BASE - TARGET - MARKER - NONE type: string lineContent: description: The contents of a line. type: string targetLine: description: The number of a line in the target version. type: integer type: object BuildRunSnapshotCollection: description: Results of a build run search. Contains build run summary items. properties: items: description: List of build runs. items: $ref: '#/components/schemas/BuildRunSnapshotSummary' type: array required: - items type: object MergeChecks: description: Criteria which must be satisfied to merge a pull request. properties: lastBuildSucceeded: description: Indicates whether or not a pull request must have a successful build run and no queued builds before it can be merged enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/MergeCheckSettingsValue' required: - lastBuildSucceeded type: object UpdateProjectRepositorySettingsDetails: description: Information to update custom project repository settings. properties: approvalRules: $ref: '#/components/schemas/UpdateApprovalRuleDetailsCollection' mergeSettings: $ref: '#/components/schemas/MergeSettings' type: object ExportedVariable: description: Values for exported variables. properties: name: description: 'Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string value: description: Value of the argument. maxLength: 255 minLength: 1 type: string required: - name - value type: object TriggerCreateResult: description: Details of the trigger create response. discriminator: propertyName: triggerSource properties: actions: description: The list of actions that are to be performed for this trigger. items: $ref: '#/components/schemas/TriggerAction' maxItems: 20 type: array compartmentId: description: The OCID of the compartment that contains the trigger. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Description about the trigger. maxLength: 400 type: string displayName: description: Trigger display name. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the trigger. type: string x-obmcs-enumref: '#/definitions/Trigger/lifecycleState' projectId: description: The OCID of the DevOps project to which the trigger belongs to. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the trigger was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the trigger was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string triggerSource: description: Source of the trigger. Allowed values are, GITHUB and GITLAB. type: string x-obmcs-enumref: '#/definitions/Trigger/triggerSource' required: - id - projectId - compartmentId - triggerSource - actions type: object ExportedVariableCollection: description: 'Specifies list of exported variables. ' properties: items: description: List of exported variables. items: $ref: '#/components/schemas/ExportedVariable' type: array required: - items type: object DeployArtifactCollection: description: Results of a deployment artifact search. properties: items: description: Deployment artifact summary items found for the search. items: $ref: '#/components/schemas/DeployArtifactSummary' type: array required: - items type: object BuildRunSummaryCollection: description: List of build run summary. properties: items: description: Array of build run summary items. items: $ref: '#/components/schemas/BuildRunSummary' type: array required: - items type: object RepositoryRefSummary: description: Summary of a reference. discriminator: propertyName: refType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object fullRefName: description: Unique full reference name inside a repository. type: string refName: description: Reference name inside a repository. type: string refType: description: The type of reference (BRANCH or TAG). type: string x-obmcs-enumref: '#/definitions/RepositoryRef/refType' repositoryId: description: The OCID of the repository containing the reference. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object required: - refName - refType - fullRefName - repositoryId type: object Trigger: description: Trigger the deployment pipeline to deploy the artifact. discriminator: propertyName: triggerSource properties: actions: description: The list of actions that are to be performed for this trigger. items: $ref: '#/components/schemas/TriggerAction' maxItems: 20 type: array compartmentId: description: The OCID of the compartment that contains the trigger. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Description about the trigger. maxLength: 400 type: string displayName: description: Trigger display name. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the trigger. enum: - ACTIVE - DELETING type: string projectId: description: The OCID of the DevOps project to which the trigger belongs to. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the trigger was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the trigger was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string triggerSource: description: Source of the trigger. enum: - GITHUB - GITLAB - GITLAB_SERVER - BITBUCKET_CLOUD - BITBUCKET_SERVER - VBS - DEVOPS_CODE_REPOSITORY type: string required: - id - projectId - compartmentId - triggerSource - actions type: object DeployStageExecutionProgress: description: Details about the execution progress of a stage in a deployment. discriminator: propertyName: deployStageType properties: deployStageDisplayName: description: Stage display name. Avoid entering confidential information. type: string deployStageExecutionProgressDetails: description: Details about stage execution for all the target environments. items: $ref: '#/components/schemas/DeployStageExecutionProgressDetails' type: array deployStageId: description: The OCID of the stage. type: string deployStagePredecessors: $ref: '#/components/schemas/DeployStagePredecessorCollection' deployStageType: description: Deployment stage type. type: string x-obmcs-enumref: '#/definitions/DeployStage/deployStageType' status: description: The current state of the stage. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - ROLLBACK_IN_PROGRESS - ROLLBACK_SUCCEEDED - ROLLBACK_FAILED type: string timeFinished: description: Time the stage finished executing. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: Time the stage started executing. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string BuildOutputs: description: Outputs from the build. properties: artifactOverrideParameters: $ref: '#/components/schemas/DeployArtifactOverrideArgumentCollection' deliveredArtifacts: $ref: '#/components/schemas/DeliveredArtifactCollection' exportedVariables: $ref: '#/components/schemas/ExportedVariableCollection' vulnerabilityAuditSummaryCollection: $ref: '#/components/schemas/VulnerabilityAuditSummaryCollection' type: object WorkRequestCollection: description: List of work requests. properties: items: description: Work request items found for the search. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object DiffResponse: description: Response object for obtaining list of changed files. properties: addedLinesCount: description: The number of lines added in whole difference. format: int32 minimum: 0 type: integer areAllChangesIncluded: description: Boolean value to indicate if all changes are included in the response. type: boolean changeTypeCount: additionalProperties: type: integer description: Count of each type of change in difference. example: Add: 1 Modify: 1 type: object changes: description: List of changes in the difference. items: $ref: '#/components/schemas/DiffResponseEntry' type: array commitsAheadCount: description: The number of commits source is ahead of target by. format: int32 minimum: 0 type: integer commitsBehindCount: description: The number of commits source is behind target by. format: int32 minimum: 0 type: integer commonCommit: description: The ID of the common commit between source and target. type: string deletedLinesCount: description: The number of lines deleted in whole difference. format: int32 minimum: 0 type: integer required: - changes type: object DeployEnvironmentSummary: description: Summary of the deployment environment. discriminator: propertyName: deployEnvironmentType properties: compartmentId: description: The OCID of a compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployEnvironmentType: description: Deployment environment type. type: string x-obmcs-enumref: '#/definitions/DeployEnvironment/deployEnvironmentType' description: description: Optional description about the deployment environment. maxLength: 400 type: string displayName: description: Deployment environment display name, which can be renamed and is not necessarily unique. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment environment. type: string x-obmcs-enumref: '#/definitions/DeployEnvironment/lifecycleState' projectId: description: The OCID of a project. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment environment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment environment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - deployEnvironmentType type: object BuildRunProgressSummary: description: The summary run progress details of a build run. properties: timeFinished: description: The time the build run finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: The time the build run started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string type: object MergeSettings: description: Enabled and disabled merge strategies for a project or repository, also contains a default strategy. properties: allowedMergeStrategies: description: List of merge strategies which are allowed for a Project or Repository. items: $ref: '#/components/schemas/MergeStrategy' maxItems: 7 type: array defaultMergeStrategy: description: Default type of merge strategy associated with the a Project or Repository. enum: - MERGE_COMMIT - FAST_FORWARD - FAST_FORWARD_ONLY - REBASE_AND_MERGE - REBASE_AND_FAST_FORWARD - SQUASH - SQUASH_FAST_FORWARD_ONLY type: string x-obmcs-top-level-enum: '#/definitions/MergeStrategy' type: object UpdateBuildPipelineStageDetails: description: The information to be updated. discriminator: propertyName: buildPipelineStageType properties: buildPipelineStagePredecessorCollection: $ref: '#/components/schemas/BuildPipelineStagePredecessorCollection' buildPipelineStageType: description: Stage types. type: string x-obmcs-enumref: '#/definitions/BuildPipelineStage/buildPipelineStageType' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the build stage. maxLength: 400 type: string displayName: description: Stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - buildPipelineStageType type: object Deployment: description: A single execution or run of a pipeline. discriminator: propertyName: deploymentType properties: compartmentId: description: The OCID of a compartment. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactOverrideArguments: $ref: '#/components/schemas/DeployArtifactOverrideArgumentCollection' deployPipelineArtifacts: $ref: '#/components/schemas/DeployPipelineArtifactCollection' deployPipelineEnvironments: $ref: '#/components/schemas/DeployPipelineEnvironmentCollection' deployPipelineId: description: The OCID of a pipeline. type: string deployStageOverrideArguments: $ref: '#/components/schemas/DeployStageOverrideArgumentCollection' deploymentArguments: $ref: '#/components/schemas/DeploymentArgumentCollection' deploymentExecutionProgress: $ref: '#/components/schemas/DeploymentExecutionProgress' deploymentType: description: Specifies type of deployment. enum: - PIPELINE_DEPLOYMENT - PIPELINE_REDEPLOYMENT - SINGLE_STAGE_DEPLOYMENT - SINGLE_STAGE_REDEPLOYMENT type: string displayName: description: Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - deploymentType - id - projectId - deployPipelineId - compartmentId type: object BuildRunProgress: description: The run progress details of a build run. properties: buildPipelineStageRunProgress: additionalProperties: $ref: '#/components/schemas/BuildPipelineStageRunProgress' description: Map of stage OCIDs to build pipeline stage run progress model. type: object timeFinished: description: The time the build run finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: The time the build run started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string type: object DeployEnvironment: description: The target OCI resources, such as Compute instances, Container Engine for Kubernetes(OKE) clusters, or Function, where artifacts are deployed. discriminator: propertyName: deployEnvironmentType properties: compartmentId: description: The OCID of a compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployEnvironmentType: description: Deployment environment type. enum: - OKE_CLUSTER - COMPUTE_INSTANCE_GROUP - FUNCTION type: string description: description: Optional description about the deployment environment. maxLength: 400 type: string displayName: description: Deployment environment display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment environment. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string projectId: description: The OCID of a project. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment environment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment environment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - deployEnvironmentType type: object CommitAnalyticsAuthorCollection: description: Result of listing Commit Analytics authors. properties: items: description: List of authors. items: $ref: '#/components/schemas/CommitAnalyticsAuthorSummary' type: array required: - items type: object DeployStageExecutionStep: description: Details about each steps in stage execution for a target environment. properties: name: description: Name of the step. type: string state: description: State of the step. enum: - WAITING - IN_PROGRESS - FAILED - SUCCEEDED - CANCELED type: string timeFinished: description: Time when the step finished. format: date-time type: string timeStarted: description: Time when the step started. format: date-time type: string CreatePullRequestCommentDetails: description: The information about new Comment. properties: commitId: description: Commit SHA type: string x-default-description: 'null' data: description: Content of the Comment. maxLength: 16000 type: string filePath: description: File path in the commit type: string x-default-description: 'null' fileType: description: File path in the target commit type: string x-default-description: 'null' x-obmcs-enumref: '#/definitions/PullRequestComment/fileType' lineNumber: description: Line number in the file type: integer x-default-description: 'null' parentId: description: ID of parent Comment type: string required: - data type: object PullRequestCommentCollection: description: Result of list pullRequest comments. properties: items: description: List of pullRequest comment objects. items: $ref: '#/components/schemas/PullRequestCommentSummary' type: array required: - items type: object PullRequestActivitySummary: description: Summary of an activity record in a pull request discriminator: propertyName: activityType properties: activityType: description: The type of activity performed enum: - LIFECYCLE - APPROVAL - COMMIT - REVIEWER - COMMENT type: string x-default-description: 'null' id: description: activity identifier type: string principal: $ref: '#/components/schemas/PrincipalDetails' pullRequestId: description: pullRequest OCID type: string timeOccurred: description: The time the action was performed. An RFC3339 formatted datetime string format: date-time type: string required: - id - principal - pullRequestId - activityType - timeOccurred type: object RepositorySettings: description: User configured settings for repository resources properties: approvalRules: $ref: '#/components/schemas/ApprovalRuleCollection' mergeChecks: $ref: '#/components/schemas/MergeChecks' mergeSettings: $ref: '#/components/schemas/MergeSettings' required: - mergeChecks - mergeSettings - approvalRules type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: The way how the work is tracked in the work request affects this resource. A resource that is created, updated, or deleted remains in the IN PROGRESS state until the work is complete for that resource. Thereafter it transitions to CREATED, UPDATED, or DELETED state. enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can use to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier RepositoryNotificationPreference: description: The notification preference of the repository. properties: notificationPreference: description: The override value of repository notification preference. enum: - WATCH - IGNORE - MENTION - INHERITED type: string repositoryId: description: The ocid of repository resource maxLength: 255 minLength: 1 type: string userId: description: The ocid of user. maxLength: 255 minLength: 1 type: string required: - repositoryId - userId - notificationPreference type: object DeploymentSummary: description: Summary of the deployment. discriminator: propertyName: deploymentType properties: compartmentId: description: The OCID of a compartment. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployArtifactOverrideArguments: $ref: '#/components/schemas/DeployArtifactOverrideArgumentCollection' deployPipelineId: description: The OCID of a pipeline. type: string deployStageOverrideArguments: $ref: '#/components/schemas/DeployStageOverrideArgumentCollection' deploymentArguments: $ref: '#/components/schemas/DeploymentArgumentCollection' deploymentType: description: Specifies type for this deployment. type: string x-obmcs-enumref: '#/definitions/Deployment/deploymentType' displayName: description: Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the deployment. type: string x-obmcs-enumref: '#/definitions/Deployment/lifecycleState' projectId: description: The OCID of a project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the deployment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the deployment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - deploymentType - id - projectId - deployPipelineId - compartmentId type: object CreateRepositoryDetails: description: Information about the new repository. properties: defaultBranch: default: main description: The default branch of the repository. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the repository. Avoid entering confidential information. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object mirrorRepositoryConfig: $ref: '#/components/schemas/MirrorRepositoryConfig' name: description: Name of the repository. Should be unique within the project. maxLength: 255 minLength: 1 type: string parentRepositoryId: description: The OCID of the parent repository. maxLength: 255 minLength: 1 type: string projectId: description: The OCID of the DevOps project containing the repository. maxLength: 255 minLength: 1 type: string repositoryType: description: "Type of repository. Allowed values: \n`MIRRORED` \n`HOSTED`\n`FORKED`\n" type: string x-obmcs-enumref: '#/definitions/Repository/repositoryType' required: - name - projectId - repositoryType type: object BuildPipelineStageCollection: description: Result of a stage search. properties: items: description: Summary of the list of stages found for the search. items: $ref: '#/components/schemas/BuildPipelineStageSummary' type: array required: - items type: object UpdatePullRequestNotificationPreferenceDetails: description: Information to update notification preference settings on pull request resource properties: notificationPreference: description: The override value of pull request notification preference. type: string x-obmcs-enumref: '#/definitions/PullRequestNotificationPreference/notificationPreference' required: - notificationPreference type: object BuildPipelineStagePredecessor: description: Metadata for defining a stage's predecessor. properties: id: description: 'The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline''s OCID. ' type: string required: - id type: object ProtectedBranchSummary: description: Holds information used to restrict certain actions on branches properties: branchName: description: Branch name inside a repository. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object protectionLevels: description: Protection level to be added on the branch. items: enum: - READ_ONLY - PULL_REQUEST_MERGE_ONLY type: string x-obmcs-top-level-enum: '#/definitions/ProtectionLevel' type: array systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object required: - branchName - protectionLevels type: object PullRequestActivityCollection: description: Result of list pullRequest activities. properties: items: description: List of pullRequest activity objects. items: $ref: '#/components/schemas/PullRequestActivitySummary' type: array required: - items type: object CreateDeployEnvironmentDetails: description: The information about new deployment environment. discriminator: propertyName: deployEnvironmentType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployEnvironmentType: description: Deployment environment type. type: string x-obmcs-enumref: '#/definitions/DeployEnvironment/deployEnvironmentType' description: description: Optional description about the deployment environment. maxLength: 400 type: string displayName: description: Deployment environment display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of a project. maxLength: 255 minLength: 1 type: string required: - deployEnvironmentType - projectId type: object DeployStageExecutionProgressDetails: description: Details about stage execution for each target environment. properties: rollbackSteps: description: Details about all the rollback steps for one target environment. items: $ref: '#/components/schemas/DeployStageExecutionStep' type: array steps: description: Details about all the steps for one target environment. items: $ref: '#/components/schemas/DeployStageExecutionStep' type: array targetGroup: description: Group for the target environment for example, the batch number for an Instance Group deployment. type: string targetId: description: The function ID, instance ID or the cluster ID. For Wait stage it will be the stage ID. type: string DiffSummary: description: Response object for showing differences for a file between two revisions. properties: areConflictsInFile: description: Indicates whether the changed file contains conflicts. type: boolean changes: description: List of changed section in the file. items: $ref: '#/components/schemas/DiffChunk' type: array definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object isBinary: description: Indicates whether the file is binary. type: boolean isLarge: description: Indicates whether the file is large. type: boolean newId: description: The ID of the changed object on the target version. type: string newPath: description: The path on the target version to the changed object. type: string oldId: description: The ID of the changed object on the base version. type: string oldPath: description: The path on the base version to the changed object. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object required: - changes type: object FileLineDetails: description: Object containing the details of a line in a file. properties: lineContent: description: The content of the line. type: string lineNumber: description: The line number. format: int32 type: integer required: - lineNumber - lineContent type: object UpdateRepositoryDetails: description: The information to be updated. properties: defaultBranch: description: The default branch of the repository. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the repository. Avoid entering confidential information. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object mirrorRepositoryConfig: $ref: '#/components/schemas/MirrorRepositoryConfig' name: description: Name of the repository. Should be unique within the project. maxLength: 255 minLength: 1 type: string repositoryType: description: "Type of repository. Allowed values: \n`MIRRORED` \n`HOSTED`\n`FORKED`\n" type: string x-obmcs-enumref: '#/definitions/Repository/repositoryType' type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: A machine-usable code for the error that occured. Error codes are listed in [API Errors](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: Time the error occured. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - code - message - timestamp UpdateRepositoryNotificationPreferenceDetails: description: Information to update notification preference settings on repository resource properties: notificationPreference: description: The override value of repository notification preference. type: string x-obmcs-enumref: '#/definitions/RepositoryNotificationPreference/notificationPreference' required: - notificationPreference type: object RepositoryMirrorRecord: description: Object containing information about a mirror record. properties: mirrorStatus: description: 'Mirror status of current mirror entry. QUEUED - Mirroring Queued RUNNING - Mirroring is Running PASSED - Mirroring Passed FAILED - Mirroring Failed ' enum: - NONE - QUEUED - RUNNING - PASSED - FAILED type: string timeEnded: description: The time taken to complete a mirror operation. Value is null if not completed. format: date-time type: string timeEnqueued: description: The time to enqueue a mirror operation. format: date-time type: string timeStarted: description: The time to start a mirror operation. format: date-time type: string workRequestId: description: Workrequest ID to track current mirror operation. type: string required: - mirrorStatus type: object CreateProjectDetails: description: The information about new project to be created. properties: compartmentId: description: The OCID of the compartment where the project is created. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Project description. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object name: description: Project name (case-sensitive). maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' required: - name - compartmentId - notificationConfig type: object RepositoryAuthorCollection: description: Result of list authors. properties: items: description: List of author objects. items: $ref: '#/components/schemas/RepositoryAuthorSummary' type: array required: - items type: object DeployPipelineEnvironment: description: Environment used in the pipeline. properties: deployEnvironmentId: description: The OCID of an Environment type: string deployPipelineStages: $ref: '#/components/schemas/DeployPipelineStageCollection' displayName: description: Display name of the environment. Avoid entering confidential information. type: string required: - deployEnvironmentId - deployPipelineStages type: object DeploymentArgument: description: Values for pipeline parameters to be supplied at the time of deployment. properties: name: description: Name of the parameter (case-sensitive). maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string value: description: value of the argument. maxLength: 255 minLength: 1 type: string required: - name - value type: object RepositoryCommitSummary: description: Commit summary with commit information. properties: authorEmail: description: Email of the author of the repository. type: string authorName: description: Name of the author of the repository. type: string commitId: description: Commit hash pointed to by reference name. type: string commitMessage: description: The commit message. type: string committerEmail: description: Email of who creates the commit. type: string committerName: description: Name of who creates the commit. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object parentCommitIds: description: An array of parent commit IDs of created commit. items: type: string type: array systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time to create the commit. format: date-time type: string treeId: description: Tree information for the specified commit. type: string required: - commitId - commitMessage - authorName - authorEmail - committerName - committerEmail - parentCommitIds - timeCreated - treeId type: object CommitInfo: description: Commit details that need to be used for the build run. properties: commitHash: description: Commit hash pertinent to the repository URL and the specified branch. maxLength: 255 minLength: 1 type: string repositoryBranch: description: Name of the repository branch. maxLength: 255 minLength: 1 type: string repositoryUrl: description: Repository URL. maxLength: 255 minLength: 1 type: string required: - repositoryUrl - repositoryBranch - commitHash type: object ProtectedBranch: description: Holds information used to restrict certain actions on branches properties: branchName: description: The branchName can either be exact branch name or branch pattern. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object protectionLevels: description: Protection levels to be added on the branch. items: enum: - READ_ONLY - PULL_REQUEST_MERGE_ONLY type: string x-obmcs-top-level-enum: '#/definitions/ProtectionLevel' type: array required: - branchName - protectionLevels type: object UpdateDeploymentDetails: description: The information to be updated. discriminator: propertyName: deploymentType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deploymentType: description: Specifies type for this deployment. type: string x-obmcs-enumref: '#/definitions/Deployment/deploymentType' displayName: description: Deployment display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - deploymentType type: object PullRequestAttachmentSummary: description: summary of a pullRequest attachment properties: createdBy: $ref: '#/components/schemas/PrincipalDetails' fileName: description: name to display in description or comment type: string id: description: Unique identifier that is immutable on creation type: string pullRequestId: description: OCID of the pull request that this attachment belongs to type: string timeCreated: description: Creation timestamp. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - pullRequestId - fileName - timeCreated - createdBy type: object VulnerabilityAuditSummaryCollection: description: List of vulnerability audit summary. properties: items: description: List of vulnerability audit summary. items: $ref: '#/components/schemas/VulnerabilityAuditSummary' maxItems: 10 type: array required: - items DiffSection: description: Details about a section of changes within a difference chunk. properties: lines: description: The lines within changed section. items: $ref: '#/components/schemas/DiffLineDetails' type: array type: description: Type of change. type: string type: object CreatePullRequestDetails: description: The information about new Pull Request. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the pull request. Avoid entering confidential information. maxLength: 32000 type: string x-default-description: 'null' destinationBranch: description: The destination branch of the pull request. If not provided, default branch will be used as the destination branch. maxLength: 255 minLength: 1 type: string displayName: description: Pull Request title maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object repositoryId: description: The OCID of the repository. maxLength: 255 minLength: 1 type: string reviewers: description: Reviewers for this pull request. items: $ref: '#/components/schemas/CreateReviewerDetails' maxItems: 200 type: array sourceBranch: description: The source branch of the pull request. maxLength: 255 minLength: 1 type: string sourceRepositoryId: description: 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. maxLength: 255 minLength: 1 type: string x-default-description: 'null' required: - displayName - sourceBranch - repositoryId type: object DeployPipelineParameterCollection: description: Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported. properties: items: description: List of parameters defined for a deployment pipeline. items: $ref: '#/components/schemas/DeployPipelineParameter' maxItems: 100 type: array required: - items type: object ApprovalRule: description: A rule which must be satisfied for matching pull requests before the pull request can be merged properties: destinationBranch: description: Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests type: string minApprovalsCount: description: Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied type: integer name: description: Name which is used to uniquely identify an approval rule. format: x-obmcs-ascii-identifier maxLength: 100 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string reviewers: description: List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. items: $ref: '#/components/schemas/PrincipalDetails' maxItems: 50 type: array required: - name - minApprovalsCount type: object ForkSyncStatusSummary: description: Object that contains the sync status for a specific branch name. properties: branchName: description: The branch in the child repository we are checking the sync status of. maxLength: 255 minLength: 1 type: string repositoryId: description: The OCID of the child repository. maxLength: 255 minLength: 1 type: string syncStatus: description: Sync status for the provided branch. enum: - IN_SYNC - SYNC_IN_PROGRESS - OUT_OF_SYNC type: string required: - syncStatus - repositoryId - branchName type: object CreateOrUpdateProtectedBranchDetails: description: Information to create a protected branch properties: branchName: description: The branchName can either be exact branch name or branch pattern. maxLength: 255 minLength: 1 type: string protectionLevels: description: Level of protection to add on a branch. items: enum: - READ_ONLY - PULL_REQUEST_MERGE_ONLY type: string x-obmcs-top-level-enum: '#/definitions/ProtectionLevel' maxItems: 10 type: array required: - branchName type: object DeployPipelineArtifact: description: Artifact used in the pipeline. properties: deployArtifactId: description: The OCID of an artifact type: string deployPipelineStages: $ref: '#/components/schemas/DeployPipelineStageCollection' displayName: description: Display name of the artifact. Avoid entering confidential information. type: string required: - deployArtifactId - deployPipelineStages type: object UpdateProjectNotificationPreferenceDetails: description: Information to update notification preference settings on project resource properties: notificationPreference: description: The override value of project notification preference. type: string x-obmcs-enumref: '#/definitions/ProjectNotificationPreference/notificationPreference' required: - notificationPreference type: object BuildPipelineParameter: description: Parameter name for which the values will be supplied at the time of running the build. properties: defaultValue: description: Default value of the parameter. maxLength: 1024 minLength: 1 type: string description: description: Description of the parameter. maxLength: 400 type: string name: description: 'Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: ''Build_Pipeline_param'' is not same as ''build_pipeline_Param'' ' maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string required: - name - defaultValue type: object RepositoryMirrorRecordCollection: description: The collection of mirror entry. properties: items: description: List of mirror entry objects. items: $ref: '#/components/schemas/RepositoryMirrorRecordSummary' type: array required: - items type: object ProtectedBranchCollection: description: Collection of protected branches properties: items: description: List of objects describing protected branches items: $ref: '#/components/schemas/ProtectedBranchSummary' type: array required: - items type: object UpdateTriggerDetails: description: The information to be updated. discriminator: propertyName: triggerSource properties: actions: description: The list of actions that are to be performed for this trigger. items: $ref: '#/components/schemas/TriggerAction' maxItems: 20 type: array definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the trigger. maxLength: 400 type: string displayName: description: Trigger display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object triggerSource: description: Source of the trigger. Allowed values are, GITHUB and GITLAB. type: string x-obmcs-enumref: '#/definitions/Trigger/triggerSource' required: - triggerSource type: object ConnectionCollection: description: Collection of connections. properties: items: description: Collection of connections. items: $ref: '#/components/schemas/ConnectionSummary' type: array required: - items type: object RepositoryAnalyticsDetails: description: Details of the user configured settings for viewing the metrics. properties: aggregationDuration: description: Metrics aggregated for the defined period. enum: - DAILY - WEEKLY - MONTHLY - YEARLY type: string authorEmail: description: Email address of the author. type: string endTime: description: The end of the metric data query time range. format: date-time type: string x-default-description: The timestamp representing when the call was invoked. groupBy: description: Attribute by which metric data has to be grouped enum: - AUTHOR type: string repositoryMetrics: description: The name of the metric to be filtered. items: enum: - COMMITS - LINES_ADDED - LINES_DELETED - PULL_REQUEST_CREATED - PULL_REQUEST_MERGED - PULL_REQUEST_DECLINED - PULL_REQUEST_REVIEW_START_DURATION_IN_DAYS - PULL_REQUEST_REVIEW_DURATION_IN_DAYS - PULL_REQUEST_APPROVED - PULL_REQUEST_REVIEWED - PULL_REQUEST_COMMENTS type: string x-obmcs-top-level-enum: '#/definitions/MetricName' minItems: 1 type: array uniqueItems: true startTime: description: The beginning of the metric data query time range. format: date-time type: string required: - startTime - repositoryMetrics type: object DeployPipelineParameter: description: Parameter name for which the values will be supplied at the time of deployment. properties: defaultValue: description: Default value of the parameter. maxLength: 512 minLength: 1 type: string description: description: Description of the parameter. maxLength: 400 minLength: 1 type: string name: description: Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string required: - name type: object UpdateDeployStageDetails: description: The information to be updated. discriminator: propertyName: deployStageType properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object deployStagePredecessorCollection: $ref: '#/components/schemas/DeployStagePredecessorCollection' deployStageType: description: Deployment stage type. type: string x-obmcs-enumref: '#/definitions/DeployStage/deployStageType' description: description: Optional description about the deployment stage. maxLength: 400 type: string displayName: description: Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - deployStageType type: object RepositoryObject: description: Object containing information about files and directories in a repository. properties: isBinary: description: Flag to determine if the object contains binary file content or not. type: boolean sha: description: SHA-1 hash of git object. type: string sizeInBytes: description: Size in bytes. format: int64 type: integer type: description: The type of git object. enum: - BLOB - TREE - COMMIT type: string required: - type - sizeInBytes - sha type: object DeployStageOverrideArgument: description: Values for stage override of the pipeline parameters to be supplied at the time of deployment. properties: deployStageId: description: The OCID of the stage. maxLength: 255 minLength: 1 type: string name: description: Name of the parameter (case-sensitive). maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string value: description: Value of the parameter. maxLength: 255 minLength: 1 type: string required: - deployStageId - name - value type: object DeployArtifactOverrideArgument: description: Values for artifact parameters to be supplied at the time of deployment. properties: deployArtifactId: description: The OCID of the artifact to which this parameter applies. type: string name: description: Name of the parameter (case-sensitive). maxLength: 255 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z_0-9]*$ type: string value: description: Value of the parameter. maxLength: 255 minLength: 1 type: string required: - deployArtifactId - name - value type: object Reviewer: description: Reviewer information. properties: principalId: description: Pull Request reviewer id maxLength: 255 minLength: 1 type: string principalName: description: the name of the principal type: string principalState: description: The state of the principal, it can be active or inactive or suppressed for emails enum: - ACTIVE - INACTIVE - SUPPRESSED type: string principalType: description: the type of principal enum: - SERVICE - USER - INSTANCE - RESOURCE type: string status: description: The current state of the Review. enum: - APPROVED - REVIEW_PENDING type: string required: - principalId type: object CreateTriggerDetails: description: Information about the new trigger. discriminator: propertyName: triggerSource properties: actions: description: The list of actions that are to be performed for this trigger. items: $ref: '#/components/schemas/TriggerAction' maxItems: 20 type: array definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the trigger. maxLength: 400 type: string displayName: description: Trigger display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object projectId: description: The OCID of the DevOps project to which the trigger belongs to. maxLength: 255 minLength: 1 type: string triggerSource: description: Source of the trigger. Allowed values are, GITHUB and GITLAB. type: string x-obmcs-enumref: '#/definitions/Trigger/triggerSource' required: - projectId - triggerSource - actions type: object Project: description: DevOps project groups resources needed to implement the CI/CD workload. DevOps resources include artifacts, pipelines, and environments. properties: compartmentId: description: The OCID of the compartment where the project is created. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Project description. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the project. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string name: description: Project name (case-sensitive). type: string namespace: description: Namespace associated with the project. type: string notificationConfig: $ref: '#/components/schemas/NotificationConfig' systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: Time the project was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: Time the project was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - name - compartmentId - notificationConfig type: object ConnectionSummary: description: Summary information for a connection. discriminator: propertyName: connectionType properties: compartmentId: description: The OCID of the compartment containing the connection. type: string connectionType: description: The type of connection. type: string x-obmcs-enumref: '#/definitions/Connection/connectionType' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Optional description about the connection. maxLength: 400 type: string displayName: description: Connection display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lastConnectionValidationResult: $ref: '#/components/schemas/ConnectionValidationResult' lifecycleDetails: description: A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: 'The current state of the connection. ' type: string x-obmcs-enumref: '#/definitions/Connection/lifecycleState' projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the connection was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the connection was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - projectId - compartmentId - connectionType type: object PullRequestAuthorCollection: description: Result of listing PR authors. properties: items: description: List of authors who has ever created PR before. items: $ref: '#/components/schemas/PullRequestAuthorSummary' type: array required: - items type: object DiffResponseEntry: description: Entry for description of change on a file. properties: addedLinesCount: description: The number of lines added in whole difference. format: int32 minimum: 0 type: integer areConflictsInFile: description: Indicates whether the changed file contains conflicts. type: boolean changeType: description: Type of change made to file. type: string commitId: description: The ID of the commit where the change is coming from. type: string deletedLinesCount: description: The number of lines deleted in whole difference. format: int32 minimum: 0 type: integer newId: description: The ID of the changed object on the source. type: string newPath: description: The path on the source to the changed object. type: string objectType: description: The type of the changed object. type: string oldId: description: The ID of the changed object on the target. type: string oldPath: description: The path on the target to the changed object. type: string url: description: The URL of the changed object. type: string required: - changeType type: object UpdateApprovalRuleDetailsCollection: description: List of approval rules which must be statisfied before pull requests which match the rules can be merged properties: items: description: List of approval rules. items: $ref: '#/components/schemas/UpdateApprovalRuleDetails' maxItems: 30 type: array required: - items type: object UpdatePullRequestCommentDetails: description: The new comment content to be updated. properties: data: description: Pull Request comment content maxLength: 16000 minLength: 1 type: string type: object BuildRunSnapshotSummary: description: Summary of a single build run snapshot. Contains information including pipelineId, commitId. properties: buildPipelineId: description: The OCID of the build pipeline where the build was triggered. type: string buildRunId: description: The OCID of the build run. type: string commitId: description: The commit id which the build was triggered from. type: string displayName: description: The display name of the build run. type: string lifecycleDetails: description: A message describing the current state in more detail. type: string lifecycleState: description: The current status of the build run. type: string x-obmcs-enumref: '#/definitions/BuildRunSnapshot/lifecycleState' timeCreated: description: The time the build run was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the build run was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - buildPipelineId - commitId - buildRunId - lifecycleState - lifecycleDetails type: object BuildPipelineStageRunProgress: description: The details about the run progress of a stage in a build run. discriminator: propertyName: buildPipelineStageType properties: buildPipelineStageId: description: The stage OCID. type: string buildPipelineStagePredecessors: $ref: '#/components/schemas/BuildPipelineStagePredecessorCollection' buildPipelineStageType: description: Stage types. type: string x-obmcs-enumref: '#/definitions/BuildPipelineStage/buildPipelineStageType' stageDisplayName: description: Build Run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string status: description: The current status of the stage. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeFinished: description: The time the stage finished executing. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeStarted: description: The time the stage started executing. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string PatchInstruction: description: A single instruction to be included as part of Patch request content. discriminator: propertyName: operation properties: operation: enum: - REQUIRE - PROHIBIT - REPLACE - INSERT - REMOVE - MOVE - MERGE type: string selection: description: 'The set of values to which the operation applies as a [JMESPath expression](https://jmespath.org/specification.html) for evaluation against the context resource. An operation fails if the selection yields an exception, except as otherwise specified. Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false. ' type: string required: - operation - selection DeliveredArtifact: description: Details of the artifacts delivered through the Deliver Artifacts stage. discriminator: propertyName: artifactType properties: artifactType: description: Type of artifact delivered. enum: - GENERIC_ARTIFACT - OCIR type: string deployArtifactId: description: The OCID of the deployment artifact definition. type: string outputArtifactName: description: Name of the output artifact defined in the build specification file. type: string required: - deployArtifactId - outputArtifactName - artifactType type: object RepositoryPathCollection: description: Result of list paths in a repository. properties: items: description: List of objects describing files or directories in a repository. items: $ref: '#/components/schemas/RepositoryPathSummary' type: array required: - items type: object ProjectNotificationPreference: description: The notification preference of the project. properties: notificationPreference: description: The override value of project notification preference. enum: - WATCH - IGNORE - MENTION type: string projectId: description: The ocid of project resource maxLength: 255 minLength: 1 type: string userId: description: The ocid of user. maxLength: 255 minLength: 1 type: string required: - projectId - userId - notificationPreference type: object WorkRequestErrorCollection: description: List of work request errors encountered while executing a work request. properties: items: description: Work request error items. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object MergeCheckCollection: description: list of merge checks. properties: items: description: "List of pullRequest mergeCheck objects.\n Example: {\"items\": [{ \"type\" : \"CONFLICT(ENUM values)\",\n \"status\" : \"FAILED(ENUM values)\"},\n {\"type\": \"APPROVAL_RULE(ENUM VALUE)\",\n \"ruleName\": \"rule 1\",\n \"status\" : \"NEEDS_APPROVAL(ENUM values)\",\n \"totalApprovalCount\":\"5\",\n \"currentApprovalCount\":\"1\",\n \"reviewers\":[],\n \"level\": \"PROJECT/REPOSITORY(ENUM values)\"},\n {\"type\": \"APPROVAL_RULE(ENUM VALUE)\",\n \"ruleName\": \"rule 2\",\n \"status\" : \"SUCCEEDED(ENUM values)\",\n \"totalApprovalCount\":\"5\",\n \"currentApprovalCount\":\"5\",\n \"reviewers\":[],\n \"level\": \"PROJECT/REPOSITORY(ENUM values)\"} ,\n {\"type\": \"BUILD(ENUM VALUE)\",\n \"pipelineId\": \"PipelineOCID\",\n \"buildRunId\": \"BuildRunOCID\",\n \"status\" : \"SUCCEEDED/PENDING/FAIlED/IN-PROGRESS(ENUM values)\"}\n]}" items: $ref: '#/components/schemas/MergeCheck' type: array timeValidated: description: The time Stamp of the validation check. format: date-time type: string type: object RepositorySummary: description: Summary of the repository. properties: compartmentId: description: The OCID of the repository's compartment. type: string defaultBranch: default: main description: The default branch of the repository. maxLength: 400 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the repository. Avoid entering confidential information. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object httpUrl: description: HTTP URL that you use to git clone, pull and push. type: string id: description: The OCID of the repository. This value is unique and immutable. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the repository. type: string x-obmcs-enumref: '#/definitions/Repository/lifecycleState' mirrorRepositoryConfig: $ref: '#/components/schemas/MirrorRepositoryConfig' name: description: Name of the repository. Should be unique within the project. This value is mutable. type: string namespace: description: Tenancy unique namespace. type: string parentRepositoryId: description: The OCID of the parent repository. maxLength: 255 minLength: 1 type: string projectId: description: The OCID of the DevOps project containing the repository. type: string projectName: description: Unique project name in a namespace. type: string repositoryType: description: "Type of repository. Allowed values: \n`MIRRORED` \n`HOSTED`\n`FORKED`\n" type: string x-obmcs-enumref: '#/definitions/Repository/repositoryType' sshUrl: description: SSH URL that you use to git clone, pull and push. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the repository was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the repository was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - compartmentId - projectId type: object DiffCollection: description: Result of a compare difference. properties: items: description: List of objects describing differences for all changed files. items: $ref: '#/components/schemas/DiffSummary' type: array required: - items type: object DeleteProtectedBranchDetails: description: Information to delete a protected branch properties: branchName: description: The branchName can either be exact branch name or branch pattern. maxLength: 255 minLength: 1 type: string required: - branchName type: object DeployArtifactSource: description: Specifies source of an artifact. discriminator: propertyName: deployArtifactSourceType properties: deployArtifactSourceType: description: Specifies types of artifact sources. enum: - INLINE - OCIR - GENERIC_ARTIFACT - HELM_CHART - HELM_COMMAND_SPEC type: string required: - deployArtifactSourceType type: object DeliveredArtifactCollection: description: Specifies the list of artifacts delivered through the Deliver Artifacts stage. properties: items: description: List of artifacts delivered through the Deliver Artifacts stage. items: $ref: '#/components/schemas/DeliveredArtifact' type: array required: - items type: object UpdatePullRequestDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the pull request. Avoid entering confidential information. maxLength: 32000 type: string destinationBranch: description: 'The destination branch against which the changes are to be reviewed. Example: "main"' type: string displayName: description: Pull Request title maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object reviewers: description: Reviewers for this Review. items: $ref: '#/components/schemas/UpdateReviewerDetails' maxItems: 200 type: array type: object CreateBuildRunDetails: description: Information about the new build run. properties: buildPipelineId: description: The OCID of the build pipeline. maxLength: 255 minLength: 1 type: string buildRunArguments: $ref: '#/components/schemas/BuildRunArgumentCollection' commitInfo: $ref: '#/components/schemas/CommitInfo' definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object displayName: description: Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object required: - buildPipelineId type: object DeployPipelineArtifactCollection: description: List of all artifacts used in the pipeline. properties: items: description: List of all artifacts used in the pipeline. items: $ref: '#/components/schemas/DeployPipelineArtifact' type: array required: - items type: object Repository: description: Repositories containing the source code to build and deploy. properties: branchCount: description: The count of the branches present in the repository. type: integer commitCount: description: The count of the commits present in the repository. type: integer compartmentId: description: The OCID of the repository's compartment. type: string defaultBranch: default: main description: The default branch of the repository. maxLength: 400 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object description: description: Details of the repository. Avoid entering confidential information. maxLength: 400 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object httpUrl: description: HTTP URL that you use to git clone, pull and push. type: string id: description: The OCID of the repository. This value is unique and immutable. type: string lifecycleState: description: The current state of the repository. enum: - ACTIVE - CREATING - DELETED - FAILED - DELETING type: string lifecyleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string mirrorRepositoryConfig: $ref: '#/components/schemas/MirrorRepositoryConfig' name: description: Name of the repository. Should be unique within the project. This value is mutable. type: string namespace: description: Tenancy unique namespace. type: string parentRepositoryId: description: The OCID of the parent repository. maxLength: 255 minLength: 1 type: string projectId: description: The OCID of the DevOps project containing the repository. type: string projectName: description: Unique project name in a namespace. type: string repositoryType: default: HOSTED description: 'Type of repository: MIRRORED - Repository created by mirroring an existing repository. HOSTED - Repository created and hosted using OCI DevOps code repository. FORKED - Repository created by forking an existing repository. ' enum: - MIRRORED - HOSTED - FORKED type: string sizeInBytes: description: The size of the repository in bytes. format: int64 type: integer sshUrl: description: SSH URL that you use to git clone, pull and push. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the repository was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the repository was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string triggerBuildEvents: description: 'Trigger build events supported for this repository: PUSH - Build is triggered when a push event occurs. PULL_REQUEST_CREATED - Build is triggered when a pull request is created in the repository. PULL_REQUEST_UPDATED - Build is triggered when a push is made to a branch with an open pull request. COMMIT_UPDATES - Build is triggered when new commits are mirrored into a repository. ' items: enum: - PUSH - PULL_REQUEST_CREATED - PULL_REQUEST_UPDATED - COMMIT_UPDATES type: string type: array required: - id - compartmentId - projectId type: object BuildRun: description: "Each time you attempt to run a build pipeline you create one build run. \nA build can be running currently, or it can be a record of the run that happened in the past.\nThe set of build runs constitutes a build pipeline's history.\n" properties: buildOutputs: $ref: '#/components/schemas/BuildOutputs' buildPipelineId: description: The OCID of the build pipeline. type: string buildRunArguments: $ref: '#/components/schemas/BuildRunArgumentCollection' buildRunProgress: $ref: '#/components/schemas/BuildRunProgress' buildRunSource: $ref: '#/components/schemas/BuildRunSource' commitInfo: $ref: '#/components/schemas/CommitInfo' compartmentId: description: The OCID of the compartment where the build is running. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object displayName: description: Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the build run. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - DELETING type: string projectId: description: The OCID of the DevOps project. type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object timeCreated: description: The time the build run was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string timeUpdated: description: The time the build run was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). format: date-time type: string required: - id - buildRunSource type: object RepositoryAuthorSummary: description: Object containing summary of authors in a repository. properties: authorName: description: Author name. type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object required: - authorName type: object RepositoryMetricAggregation: description: The set of aggregated data returned for repository analytics. properties: items: description: The metric data. items: $ref: '#/components/schemas/RepositoryMetricSummary' type: array required: - items type: object BuildPipelineParameterCollection: description: 'Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely. ' properties: items: description: List of parameters defined for a build pipeline. items: $ref: '#/components/schemas/BuildPipelineParameter' maxItems: 100 type: array required: - items type: object WorkRequestLogEntryCollection: description: List of log messages from the execution of a work request. properties: items: description: Work request log entry items. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 BuildPipelineStageIdentifierPathParam: description: Unique stage identifier. in: path name: buildPipelineStageId required: true schema: type: string BranchSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for branch name is ascending. If no value is specified branch name is default. ' in: query name: sortBy schema: type: string enum: - branchName default: branchName DeployPipelineIdQueryParam: description: The ID of the parent pipeline. in: query name: deployPipelineId required: false x-default-description: ID of the parent Pipeline for filtering. schema: type: string BuildPipelineIdentifierPathParam: description: Unique build pipeline identifier. in: path name: buildPipelineId required: true schema: type: string DeployPipelineIdentifierPathParam: description: Unique pipeline identifier. in: path name: deployPipelineId required: true schema: type: string PullRequestSourceBranchQueryParam: description: PullRequest Source Branch. in: query name: sourceBranch x-default-description: 'null' schema: type: string TimeCreatedGreaterThanOrEqualToQueryParam: description: Search for DevOps resources that were created after a specific date. Specifying this parameter corresponding to `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all security assessments created after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). in: query name: timeCreatedGreaterThanOrEqualTo required: false x-example: 2016-12-19 16:39:57.600000+00:00 schema: type: string format: date-time IfMatchHeader: description: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. in: header name: if-match required: false schema: type: string BuildPipelineLifeCycleStateQueryParam: description: A filter to return only build pipelines that matches the given lifecycle state. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/BuildPipeline/lifecycleState' schema: type: string DeploymentIdentifierPathParam: description: Unique deployment identifier. in: path name: deploymentId required: true schema: type: string SortOrderQueryParam: description: The sort order to use. Use either ascending or descending. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC UnsubscribePullRequestTokenQueryParam: description: The unsubscription token. in: query name: token required: true schema: type: string maxLength: 512 minLength: 1 CommitTimestampLessThanOrEqualToQueryParam: description: A filter to return commits only created before the specified timestamp value. in: query name: timestampLessThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time RepositoryFieldsQueryParam: description: Fields parameter can contain multiple flags useful in deciding the API functionality. in: query name: fields required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - branchCount - commitCount - sizeInBytes type: string RepositoryIdentifierPathParam: description: Unique repository identifier. in: path name: repositoryId required: true schema: type: string RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. in: header name: opc-request-id required: false schema: type: string CompartmentIdOptionalQueryParam: description: The OCID of the compartment in which to list resources. in: query name: compartmentId required: false x-default-description: Empty only if the parent projectId or deployPipelineId query param is not specified. schema: type: string SortByQueryParam: description: The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered. in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated RepositoryIdentifierQueryParam: description: Unique repository identifier. in: query name: repositoryId x-default-description: 'null' schema: type: string PullRequestDestinationBranchQueryParam: description: PullRequest Target Branch in: query name: destinationBranch x-default-description: 'null' schema: type: string PullRequestFilePathQueryParam: description: PullRequest File Path in: query name: filePath x-default-description: 'null' schema: type: string DeployEnvironmentIdentifierPathParam: description: Unique environment identifier. in: path name: deployEnvironmentId required: true schema: type: string ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string TriggerIdentifierQueryParam: description: Unique trigger identifier. in: query name: id x-default-description: 'null' schema: type: string PullRequestIdentifierPathParam: description: unique PullRequest identifier in: path name: pullRequestId required: true schema: type: string SyncMergeStrategyQueryParam: description: 'If fetch and merge is passed in, the changes from the upstream will be fetched and merged into the destination branch. If discard is passed in, the changes in the fork will be overwritten with the changes brought in from the upstream. ' in: query name: syncMergeStrategy required: true schema: type: string enum: - FETCH_AND_MERGE - DISCARD CodeRepositoryPaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 100 minimum: 1 WorkRequestStatusQueryParam: description: A filter to return only resources where the lifecycle state matches the given operation status. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - WAITING - NEEDS_ATTENTION BuildPipelineIdentifierOptionalQueryParam: description: Unique build pipeline identifier. in: query name: pipelineId required: false x-default-description: 'null' schema: type: string PullRequestAttachmentIdentifierPathParam: description: unique PullRequest attachment identifier in: path name: attachmentId required: true schema: type: string ProjectIdentifierPathParam: description: Unique project identifier. in: path name: projectId required: true schema: type: string ConnectionTypeQueryParam: description: A filter to return only resources that match the given connection type. in: query name: connectionType x-default-description: 'null' x-obmcs-enumref: '#/definitions/Connection/connectionType' schema: type: string PullRequestReviewerIdQueryParam: description: PullRequest Reviewer Id in: query name: reviewerPrincipalId x-default-description: 'null' schema: type: string ArchiveFormatQueryParam: description: The archive format query parameter for downloading repository endpoint. in: query name: format required: false x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous work request. in: path name: workRequestId required: true schema: type: string BuildPipelineStageLifeCycleStateQueryParam: description: A filter to return the stages that matches the given lifecycle state. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/BuildPipelineStage/lifecycleState' schema: type: string RefNamePathParam: description: A filter to return only resources that match the given reference name. in: path name: refName required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PullRequestCommentIdentifierPathParam: description: unique PullRequest Comment identifier in: path name: commentId required: true schema: type: string BuildRunIdentifierPathParam: description: Unique build run identifier. in: path name: buildRunId required: true schema: type: string BuildPipelineIdQueryParam: description: The OCID of the parent build pipeline. in: query name: buildPipelineId required: false x-default-description: ID of the parent Build Pipeline for filtering. schema: type: string PullRequestCommitIdQueryParam: description: PullRequest Comment Commit SHA in: query name: commitId x-default-description: 'null' schema: type: string CommitTimestampGreaterThanOrEqualToQueryParam: description: A filter to return commits only created after the specified timestamp value. in: query name: timestampGreaterThanOrEqualTo x-default-description: 'null' schema: type: string format: date-time ProjectIdentifierQueryParam: description: unique project identifier in: query name: projectId required: false x-default-description: 'null' schema: type: string ContentDispositionHeader: description: The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file. in: header name: content-disposition required: true schema: type: string BranchNameQueryParam: description: A filter to return only resources that match the given branch name. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CommitIdPathParam: description: A filter to return only resources that match the given commit ID. in: path name: commitId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PullRequestLifeCycleDetailsQueryParam: description: A filter to return only pull requests that match the given lifecycle state. in: query name: lifecycleDetails x-default-description: 'null' x-obmcs-enumref: '#/definitions/PullRequest/lifecycleDetails' schema: type: string FilePathQueryParam: description: A filter to return only commits that affect any of the specified paths. in: query name: filePath x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AuthorNameQueryParam: description: A filter to return any commits that are pushed by the requested author. in: query name: authorName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AuthorSortByQueryParam: description: 'The field to sort by. Only one sort by value is supported for this parameter. Default order for author name is ascending. ' in: query name: sortBy schema: type: string enum: - authorName default: authorName PullRequestCommentSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - createdBy default: timeCreated PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 RefTypeOptionalQueryParam: description: Reference type to distinguish between branch and tag. If it is not specified, all references are returned. in: query name: refType required: false x-default-description: 'null' schema: type: string enum: - BRANCH - TAG ShaPathParam: description: The SHA of a blob or tree. in: path name: sha required: true schema: type: string BuildPipelineIdentifierQueryParam: description: Unique build pipeline identifier. in: query name: buildPipelineId required: false schema: type: string PullRequestSourceRepositoryIdQueryParam: description: PullRequest Source Repository Id in: query name: sourceRepositoryId x-default-description: 'null' schema: type: string MirrorRecordTypePathParam: description: 'The field of mirror record type. Only one mirror record type can be provided: current - The current mirror record. lastSuccessful - The last successful mirror record. ' in: path name: mirrorRecordType required: true schema: type: string enum: - current - lastSuccessful FilePathPathParam: description: Path to a file within a repository. in: path name: filePath required: true schema: type: string RefSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for reference name is ascending. Default order for reference type is ascending. If no value is specified reference name is default. ' in: query name: sortBy schema: type: string enum: - refType - refName default: refName BuildRunLifeCycleStateQueryParam: description: A filter to return only build runs that matches the given lifecycle state. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/BuildRun/lifecycleState' schema: type: string WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string DeployArtifactIdentifierPathParam: description: Unique artifact identifier. in: path name: deployArtifactId required: true schema: type: string LifecycleStateRepositoryQueryParam: description: A filter to return only resources whose lifecycle state matches the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Repository/lifecycleState' schema: type: string RepositoryIdQueryParam: description: The OCID of the repository in which to list resources. in: query name: repositoryId schema: type: string maxLength: 255 minLength: 91 TriggerIdentifierPathParam: description: Unique trigger identifier. in: path name: triggerId required: true schema: type: string FileNameQueryParam: description: A filter to return only resources that match the entire file name given. in: query name: fileName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated earlier due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 FolderPathQueryParam: description: The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository. in: query name: folderPath required: false x-default-description: 'null' schema: type: string PullRequestLifeCycleStateQueryParam: description: A filter to return only pull requests that match the given lifecycle state. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/PullRequest/lifecycleState' schema: type: string CommitIdQueryParam: description: Commit ID in a repository. in: query name: commitId required: false x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: The field to sort by. Only one sort order can be provided. Default sort order is descending and is based on the timeAccepted field. in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted PullRequestCreatedByQueryParam: description: PullRequest Created By in: query name: createdBy x-default-description: 'null' schema: type: string PullRequestAttachmentSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - fileName - timeCreated - createdBy default: timeCreated RepositorySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for name is ascending. If no value is specified time created is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated CompartmentIdQueryParam: description: The OCID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 32 PullRequestCommentIdentifierQueryParam: description: unique PullRequest Comment identifier in: query name: commentId x-default-description: 'null' schema: type: string ConnectionIdentifierPathParam: description: Unique connection identifier. in: path name: connectionId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 TimeCreatedLessThanQueryParam: description: Search for DevOps resources that were created before a specific date. Specifying this parameter corresponding to `timeCreatedLessThan` parameter will retrieve all assessments created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). in: query name: timeCreatedLessThan required: false x-example: 2016-12-19 16:39:57.600000+00:00 schema: type: string format: date-time ExcludeRefNameQueryParam: description: A filter to exclude commits that match the given reference name. in: query name: excludeRefName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 BuildRunIdentifierOptionalQueryParam: description: Unique build run identifier. in: query name: buildRunId required: false x-default-description: 'null' schema: type: string ResourceIdQueryParam: description: Unique identifier or OCID for listing a single resource by ID. in: query name: id required: false x-default-description: 'null' schema: type: string PrincipalIdentifierPathParam: description: Unique principal identifier. in: path name: principalId required: true schema: type: string maxLength: 255 minLength: 32 RefNameQueryParam: description: A filter to return only resources that match the given reference name. in: query name: refName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DeployStageIdentifierPathParam: description: Unique stage identifier. in: path name: deployStageId required: true schema: type: string PullRequestActivityTypeQueryParam: description: 'An optional filter to list activities based on activity type. If no value is specified, all activity types will returned. ' in: query name: activityType x-default-description: 'null' schema: type: string enum: - LIFECYCLE - APPROVAL - COMMIT - REVIEWER - COMMENT ConnectionLifeCycleStateQueryParam: description: A filter to return only connections that matches the given lifecycle state. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/Connection/lifecycleState' schema: type: string CommitMessageQueryParam: description: A filter to return any commits that contains the given message. in: query name: commitMessage x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RepositoryObjectSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order is ascending. If no value is specified name is default. ' in: query name: sortBy schema: type: string enum: - type - sizeInBytes - name default: name WorkRequestOperationTypeMultiValueQueryParam: description: A filter to return only resources where their Operation Types matches the parameter operation types in: query name: operationTypeMultiValueQuery x-default-description: 'null' style: form explode: true schema: type: array items: type: string responses: default: description: Unknown Error headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-disposition: description: The Content-Disposition response-header field has been proposed as a means for the origin server to suggest a default filename if the user requests that the content is saved to a file. type: string content-type: description: Content type refers to content of a file which is transferred via HTTP type: string etag: description: For optimistic concurrency control. See `if-match`. type: string location: description: Relative URL of the newly created resource. type: string opc-next-page: description: For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. type: string opc-request-id: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. type: string opc-work-request-id: description: Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}`' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object principalName: description: the name of the principal type: string principalState: description: The state of the principal, it can be active or inactive or suppressed for emails enum: - ACTIVE - INACTIVE - SUPPRESSED type: string principalType: description: the type of principal enum: - SERVICE - USER - INSTANCE - RESOURCE type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only string, integer, and boolean types are supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}`' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`' type: object x-oracle-package: com.oracle.pic.dlc