{ "opencollection": "1.0.0", "info": { "name": "Devops API", "version": "20210630" }, "items": [ { "info": { "name": "devops", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all Stages in a compartment or buildPipeline", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildPipelineStages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "buildPipelineId", "value": "", "type": "query", "description": "The OCID of the parent build pipeline." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return the stages that matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of all stages in a compartment or build pipeline.\n" }, { "info": { "name": "Creates a new Stage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/buildPipelineStages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new stage.\n" }, { "info": { "name": "Get Stage", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildPipelineStages/:buildPipelineStageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ] }, "docs": "Retrieves a stage based on the stage ID provided in the request." }, { "info": { "name": "Update the Stage identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/buildPipelineStages/:buildPipelineStageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the stage based on the stage ID provided in the request." }, { "info": { "name": "Delete a provisioned Stage", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/buildPipelineStages/:buildPipelineStageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ] }, "docs": "Deletes a stage based on the stage ID provided in the request." }, { "info": { "name": "Gets a list of all BuildPipelines in a Compartment or a Project.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildPipelines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only build pipelines that matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of build pipelines.\n" }, { "info": { "name": "Creates a new BuildPipeline", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/buildPipelines", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new build pipeline.\n" }, { "info": { "name": "Get BuildPipeline", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildPipelines/:buildPipelineId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineId", "value": "", "type": "path", "description": "Unique build pipeline identifier." } ] }, "docs": "Retrieves a build pipeline by identifier." }, { "info": { "name": "Update the BuildPipeline identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/buildPipelines/:buildPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineId", "value": "", "type": "path", "description": "Unique build pipeline identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the build pipeline." }, { "info": { "name": "Delete a provisioned BuildPipeline", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/buildPipelines/:buildPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildPipelineId", "value": "", "type": "path", "description": "Unique build pipeline identifier." } ] }, "docs": "Deletes a build pipeline resource by identifier." }, { "info": { "name": "Gets a list of all build runs summary", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildRuns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "buildPipelineId", "value": "", "type": "query", "description": "Unique build pipeline identifier." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only build runs that matches the given lifecycle state." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of build run summary.\n" }, { "info": { "name": "Start a code build run", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/buildRuns", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n" }, { "info": { "name": "Gets a build run detail", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/buildRuns/:buildRunId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildRunId", "value": "", "type": "path", "description": "Unique build run identifier." } ] }, "docs": "Returns the details of a build run for a given build run ID.\n" }, { "info": { "name": "Update the BuildRun identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/buildRuns/:buildRunId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "buildRunId", "value": "", "type": "path", "description": "Unique build run identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the build run." }, { "info": { "name": "Cancel the Build Run based on build run id provided in request", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/buildRuns/:buildRunId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "buildRunId", "value": "", "type": "path", "description": "Unique build run identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels the build run based on the build run ID provided in the request." }, { "info": { "name": "Gets a list of all Connections in a Compartment or a Project.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/connections", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only connections that matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "connectionType", "value": "", "type": "query", "description": "A filter to return only resources that match the given connection type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of connections.\n" }, { "info": { "name": "Creates a new Connection", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/connections", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new connection.\n" }, { "info": { "name": "Get Connection", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/connections/:connectionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Unique connection identifier." } ] }, "docs": "Retrieves a connection by identifier." }, { "info": { "name": "Update the Connection identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/connections/:connectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Unique connection identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the connection." }, { "info": { "name": "Delete a provisioned Connection", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/connections/:connectionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Unique connection identifier." } ] }, "docs": "Deletes a connection resource by identifier." }, { "info": { "name": "Validate the connection's credentials.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/connections/:connectionId/actions/validate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Unique connection identifier." } ] }, "docs": "Return whether the credentials of the connection are valid.\n" }, { "info": { "name": "Gets a list of all DeployArtifacts in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployArtifacts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DeployArtifacts that matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of deployment artifacts." }, { "info": { "name": "Creates a new DeployArtifact", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployArtifacts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new deployment artifact." }, { "info": { "name": "Get DeployArtifact", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployArtifacts/:deployArtifactId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployArtifactId", "value": "", "type": "path", "description": "Unique artifact identifier." } ] }, "docs": "Retrieves a deployment artifact by identifier." }, { "info": { "name": "Update the DeployArtifact identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/deployArtifacts/:deployArtifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployArtifactId", "value": "", "type": "path", "description": "Unique artifact identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the deployment artifact." }, { "info": { "name": "Delete a provisioned DeployArtifact", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/deployArtifacts/:deployArtifactId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployArtifactId", "value": "", "type": "path", "description": "Unique artifact identifier." } ] }, "docs": "Deletes a deployment artifact resource by identifier." }, { "info": { "name": "Gets a list of all DeployEnvironments in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployEnvironments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DeployEnvironments that matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of deployment environments." }, { "info": { "name": "Creates a new DeployEnvironment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployEnvironments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new deployment environment." }, { "info": { "name": "Get DeployEnvironment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployEnvironments/:deployEnvironmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployEnvironmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ] }, "docs": "Retrieves a deployment environment by identifier." }, { "info": { "name": "Update the DeployEnvironment identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/deployEnvironments/:deployEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployEnvironmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the deployment environment." }, { "info": { "name": "Delete a provisioned DeployEnvironment", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/deployEnvironments/:deployEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployEnvironmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ] }, "docs": "Deletes a deployment environment resource by identifier." }, { "info": { "name": "Gets a list of all DeployPipelines in a Compartment or a Project.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployPipelines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only DeployPipelines that matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of deployment pipelines." }, { "info": { "name": "Creates a new DeployPipeline", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployPipelines", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new deployment pipeline." }, { "info": { "name": "Get DeployPipeline", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployPipelines/:deployPipelineId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployPipelineId", "value": "", "type": "path", "description": "Unique pipeline identifier." } ] }, "docs": "Retrieves a deployment pipeline by identifier." }, { "info": { "name": "Update the DeployPipeline identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/deployPipelines/:deployPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployPipelineId", "value": "", "type": "path", "description": "Unique pipeline identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the deployment pipeline." }, { "info": { "name": "Delete a provisioned DeployPipeline", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/deployPipelines/:deployPipelineId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployPipelineId", "value": "", "type": "path", "description": "Unique pipeline identifier." } ] }, "docs": "Deletes a deployment pipeline resource by identifier." }, { "info": { "name": "Gets a list of all DeployStages in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployStages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "deployPipelineId", "value": "", "type": "query", "description": "The ID of the parent pipeline." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only deployment stages that matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Retrieves a list of deployment stages." }, { "info": { "name": "Creates a new DeployStage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployStages", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new deployment stage." }, { "info": { "name": "Get DeployStage", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployStages/:deployStageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ] }, "docs": "Retrieves a deployment stage by identifier." }, { "info": { "name": "Update the DeployStage identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/deployStages/:deployStageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the deployment stage." }, { "info": { "name": "Delete a provisioned DeployStage", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/deployStages/:deployStageId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployStageId", "value": "", "type": "path", "description": "Unique stage identifier." } ] }, "docs": "Deletes a deployment stage resource by identifier." }, { "info": { "name": "Gets a list of all Deployments in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deployPipelineId", "value": "", "type": "query", "description": "The ID of the parent pipeline." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Deployments that matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "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)." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "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)." } ] }, "docs": "Returns a list of deployments." }, { "info": { "name": "Creates a new Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new deployment." }, { "info": { "name": "Get Deployment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/deployments/:deploymentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "Unique deployment identifier." } ] }, "docs": "Retrieves a deployment by identifier." }, { "info": { "name": "Update the Deployment identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/deployments/:deploymentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "Unique deployment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the deployment." }, { "info": { "name": "Submit stage approval.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployments/:deploymentId/actions/approve", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "Unique deployment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit stage approval." }, { "info": { "name": "Cancel a provisioned Deployment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/deployments/:deploymentId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "deploymentId", "value": "", "type": "path", "description": "Unique deployment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels a deployment resource by identifier." }, { "info": { "name": "Gets a list of all projects in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/projects", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only Projects that matches the given lifecycleState." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of projects." }, { "info": { "name": "Creates a new Project", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/projects", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project." }, { "info": { "name": "Get Project", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/projects/:projectId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Retrieves a project by identifier." }, { "info": { "name": "Update the Project identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/projects/:projectId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the project." }, { "info": { "name": "Delete a provisioned Project", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/projects/:projectId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Deletes a project resource by identifier" }, { "info": { "name": "Restores parent and children resources from DELETING state", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/projects/:projectId/actions/cancelScheduledCascadingProjectDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Cascading operation that restores Project and child resources from a DELETING state to an active state" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/projects/:projectId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a project resource from one compartment OCID to another." }, { "info": { "name": "Marks parent and children resources in a DELETING state", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/projects/:projectId/actions/scheduleCascadingProjectDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period" }, { "info": { "name": "Get a list of all the Commit Analytics authors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/projects/:projectId/commitAnalyticsAuthors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort by value is supported for this parameter. Default order for author name is ascending.\n" } ] }, "docs": "Retrieve a list of all the Commit Analytics authors.\n" }, { "info": { "name": "Get the project notification preference for the user passed as path param", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/projects/:projectId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ] }, "docs": "Get the project notification preference for the user passed as path param" }, { "info": { "name": "Update the project notification preference for the user passed as path param", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/projects/:projectId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the project notification preference for the user passed as path param" }, { "info": { "name": "Retrieves repository analytics for a given project.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/projects/:projectId/repositoryAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves repository analytics for a given project." }, { "info": { "name": "Gets project repository settings.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/projects/:projectId/repositorySettings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Retrieves a project's repository settings details." }, { "info": { "name": "Updates the repository settings for a project.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/projects/:projectId/repositorySettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the repository settings for a project." }, { "info": { "name": "Removes custom repository settings configured for a project.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/projects/:projectId/repositorySettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "projectId", "value": "", "type": "path", "description": "Unique project identifier." } ] }, "docs": "Removes the custom repository settings configured for a project." }, { "info": { "name": "Gets a list of all Pull Requests in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only pull requests that match the given lifecycle state." }, { "name": "lifecycleDetails", "value": "", "type": "query", "description": "A filter to return only pull requests that match the given lifecycle state." }, { "name": "repositoryId", "value": "", "type": "query", "description": "The OCID of the repository in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single resource by ID." }, { "name": "createdBy", "value": "", "type": "query", "description": "PullRequest Created By" }, { "name": "destinationBranch", "value": "", "type": "query", "description": "PullRequest Target Branch" }, { "name": "sourceBranch", "value": "", "type": "query", "description": "PullRequest Source Branch." }, { "name": "reviewerPrincipalId", "value": "", "type": "query", "description": "PullRequest Reviewer Id" }, { "name": "sourceRepositoryId", "value": "", "type": "query", "description": "PullRequest Source Repository Id" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of PullRequests.\n" }, { "info": { "name": "Creates a new PullRequest", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new PullRequest.\n" }, { "info": { "name": "Get PullRequest", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ] }, "docs": "Gets a PullRequest by identifier" }, { "info": { "name": "Update the PullRequest identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the PullRequest" }, { "info": { "name": "Update a pull request's reviewer list", "type": "http" }, "http": { "method": "PATCH", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the reviewer list of a pull request\n" }, { "info": { "name": "Delete a provisioned PullRequest", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ] }, "docs": "Deletes a PullRequest resource by identifier" }, { "info": { "name": "Decline a PullRequest", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/actions/decline", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ] }, "docs": "Decline a PullRequest\n" }, { "info": { "name": "Merge the PullRequest identified by the id", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/actions/merge", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merge the PullRequest" }, { "info": { "name": "Reopen a PullRequest", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/actions/reopen", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ] }, "docs": "Reopen a PullRequest\n" }, { "info": { "name": "Review a PullRequest", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/actions/review", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Review a PullRequest\n" }, { "info": { "name": "Unsubscribe from the PullRequest identified by the id", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/actions/unsubscribe", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "token", "value": "", "type": "query", "description": "The unsubscription token." } ] }, "docs": "unsubscribe the PullRequest" }, { "info": { "name": "List PullRequest activities", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/activities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "activityType", "value": "", "type": "query", "description": "An optional filter to list activities based on activity type. If no value is specified, all activity types will returned.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List actions that have been taken on a pull request" }, { "info": { "name": "List PullRequest attachments", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/attachments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "fileName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire file name given." }, { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List PullRequest level attachments by identifier" }, { "info": { "name": "Creates PullRequest attachment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/attachments", "headers": [ { "name": "content-disposition", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates PullRequest attachment\n" }, { "info": { "name": "Get PullRequest attachment metadata", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/attachments/:attachmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "attachmentId", "value": "", "type": "path", "description": "unique PullRequest attachment identifier" } ] }, "docs": "Get PullRequest attachment metadata by identifier" }, { "info": { "name": "Delete a PullRequest attachment", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/attachments/:attachmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "attachmentId", "value": "", "type": "path", "description": "unique PullRequest attachment identifier" } ] }, "docs": "Deletes a PullRequest attachment metadata by identifier" }, { "info": { "name": "GetPullRequestAttachmentContent", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/attachments/:attachmentId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "attachmentId", "value": "", "type": "path", "description": "unique PullRequest attachment identifier" } ] }, "docs": "Gets the content of the attachment." }, { "info": { "name": "Gets a list of all build run snapshots for the provided filters.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/buildRunSnapshots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "pipelineId", "value": "", "type": "query", "description": "Unique build pipeline identifier." }, { "name": "buildRunId", "value": "", "type": "query", "description": "Unique build run identifier." }, { "name": "commitId", "value": "", "type": "query", "description": "Commit ID in a repository." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of build run snapshots for a given commit or the latest commit on a pull request if no commit is provided.\n" }, { "info": { "name": "Get PullRequest Diff summary metric", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/changeSummaryMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ] }, "docs": "Get pull request diff summary metric" }, { "info": { "name": "List PullRequest comments", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "query", "description": "unique PullRequest Comment identifier" }, { "name": "commitId", "value": "", "type": "query", "description": "PullRequest Comment Commit SHA" }, { "name": "filePath", "value": "", "type": "query", "description": "PullRequest File Path" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List PullRequest level comments by identifier" }, { "info": { "name": "Creates a new PullRequest comment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new PullRequest comment.\n" }, { "info": { "name": "Get PullRequest comment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Get PullRequest comment by identifier" }, { "info": { "name": "Update the PullRequest comment identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the PullRequest comment" }, { "info": { "name": "Delete a PullRequest comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Deletes a PullRequest comment by identifier" }, { "info": { "name": "Like a PullRequest comment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId/actions/like", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Like a PullRequest comment\n" }, { "info": { "name": "Reopen a PullRequest Comment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId/actions/reopen", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Reopen a PullRequest Comment\n" }, { "info": { "name": "Resolve a PullRequest Comment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId/actions/resolve", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Resolve a PullRequest Comment\n" }, { "info": { "name": "Unlike a PullRequest comment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/comments/:commentId/actions/unlike", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "commentId", "value": "", "type": "path", "description": "unique PullRequest Comment identifier" } ] }, "docs": "Unlike a PullRequest comment\n" }, { "info": { "name": "List PullRequest commits", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/commits", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List pull request commits" }, { "info": { "name": "List PullRequest file changes", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/fileChanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "filePath", "value": "", "type": "query", "description": "PullRequest File Path" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List pull request file changes" }, { "info": { "name": "Get the pull request notification preference for the user passed as path param", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ] }, "docs": "Get the pull request notification preference for the user passed as path param" }, { "info": { "name": "Update the pull request notification preference for the user passed as path param", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/pullRequests/:pullRequestId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "pullRequestId", "value": "", "type": "path", "description": "unique PullRequest identifier" }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the pull request notification preference for the user passed as path param" }, { "info": { "name": "Gets a list of all Repositories in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "repositoryId", "value": "", "type": "query", "description": "Unique repository identifier." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycle state matches the given lifecycle state." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of repositories given a compartment ID or a project ID.\n" }, { "info": { "name": "Creates a new Repository", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new repository.\n" }, { "info": { "name": "Get Repository", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "fields", "value": "", "type": "query", "description": "Fields parameter can contain multiple flags useful in deciding the API functionality." } ] }, "docs": "Retrieves a repository by identifier." }, { "info": { "name": "Update the Repository identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the repository." }, { "info": { "name": "Delete a provisioned Repository", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/repositories/:repositoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ] }, "docs": "Deletes a repository resource by identifier." }, { "info": { "name": "Creates a new Ref in the Repository or update an existing one", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/createOrUpdateGitRef", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new reference or updates an existing one.\n" }, { "info": { "name": "Defines a restriction on a branch.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/createOrUpdateProtectedBranch", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a restriction on a branch that prevents certain actions on it." }, { "info": { "name": "Delete a Ref", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/deleteGitRef", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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/\"." }, { "info": { "name": "Removes the protection from a branch", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/deleteProtectedBranch", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the protection from a branch" }, { "info": { "name": "Synchronize a mirrored repository", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/mirror", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ] }, "docs": "Synchronize a mirrored repository to the latest version from external providers.\n" }, { "info": { "name": "Synchronize a repository", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/actions/sync", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "syncMergeStrategy", "value": "", "type": "query", "description": "If fetch and merge is passed in, the changes from the upstream will be fetched and merged into the destination branch.\nIf discard is passed in, the changes in the fork will be overwritten with the changes brought in from the upstream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Synchronize a forked repository to the latest version\n" }, { "info": { "name": "Download a specific branch of a repository", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/archive/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "query", "description": "A filter to return only resources that match the given reference name." }, { "name": "format", "value": "", "type": "query", "description": "The archive format query parameter for downloading repository endpoint." } ] }, "docs": "Returns the archived repository information.\n" }, { "info": { "name": "Get a list of all the authors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/authors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "query", "description": "A filter to return only resources that match the given reference name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." } ] }, "docs": "Retrieve a list of all the authors.\n" }, { "info": { "name": "Get a list of all the Commit Analytics authors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/commitAnalyticsAuthors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort by value is supported for this parameter. Default order for author name is ascending.\n" } ] }, "docs": "Retrieve a list of all the Commit Analytics authors.\n" }, { "info": { "name": "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", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/commits", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "query", "description": "A filter to return only resources that match the given reference name." }, { "name": "excludeRefName", "value": "", "type": "query", "description": "A filter to exclude commits that match the given reference name." }, { "name": "filePath", "value": "", "type": "query", "description": "A filter to return only commits that affect any of the specified paths." }, { "name": "timestampGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return commits only created after the specified timestamp value." }, { "name": "timestampLessThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return commits only created before the specified timestamp value." }, { "name": "commitMessage", "value": "", "type": "query", "description": "A filter to return any commits that contains the given message." }, { "name": "authorName", "value": "", "type": "query", "description": "A filter to return any commits that are pushed by the requested author." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of commits.\n" }, { "info": { "name": "Get a Commit", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/commits/:commitId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "commitId", "value": "", "type": "path", "description": "A filter to return only resources that match the given commit ID." } ] }, "docs": "Retrieves a repository's commit by commit ID." }, { "info": { "name": "Gets the differences between two revisions", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/diff", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "baseVersion", "value": "", "type": "query", "description": "The commit or reference name to compare changes against. If base version is not provided, the difference goes against an empty tree." }, { "name": "targetVersion", "value": "", "type": "query", "description": "The commit or reference name that represents the newer changes against the base version." }, { "name": "targetRepositoryId", "value": "", "type": "query", "description": "The target repository identifier" }, { "name": "isComparisonFromMergeBase", "value": "", "type": "query", "description": "Boolean value to indicate whether to use merge base or most recent revision." } ] }, "docs": "Compares two revisions for their differences. Supports comparison between two references or commits.\n" }, { "info": { "name": "Lists the differences with details between two revisions", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/diffs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "baseVersion", "value": "", "type": "query", "description": "The commit or reference name to compare changes against." }, { "name": "targetVersion", "value": "", "type": "query", "description": "The commit or reference name where changes are coming from." }, { "name": "targetRepositoryId", "value": "", "type": "query", "description": "The target repository identifier" }, { "name": "isComparisonFromMergeBase", "value": "", "type": "query", "description": "Boolean value to indicate whether to use merge base or most recent revision." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Compares two revisions and lists the differences. Supports comparison between two references or commits.\n" }, { "info": { "name": "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\"", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/diffs/:filePath", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "filePath", "value": "", "type": "path", "description": "Path to a file within a repository." }, { "name": "baseVersion", "value": "", "type": "query", "description": "The branch to compare changes against." }, { "name": "targetVersion", "value": "", "type": "query", "description": "The branch where changes are coming from." }, { "name": "isComparisonFromMergeBase", "value": "", "type": "query", "description": "Boolean to indicate whether to use merge base or most recent revision." } ] }, "docs": "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\"\n" }, { "info": { "name": "Gets the line-by-line difference between file on different commits", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/file/diffs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "filePath", "value": "", "type": "query", "description": "A filter to return only commits that affect any of the specified paths." }, { "name": "baseVersion", "value": "", "type": "query", "description": "The branch to compare changes against." }, { "name": "targetVersion", "value": "", "type": "query", "description": "The branch where changes are coming from." }, { "name": "isComparisonFromMergeBase", "value": "", "type": "query", "description": "Boolean to indicate whether to use merge base or most recent revision." } ] }, "docs": "Gets the line-by-line difference between file on different commits.\n" }, { "info": { "name": "Get lines of a specified file", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/file/lines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "filePath", "value": "", "type": "query", "description": "A filter to return only commits that affect any of the specified paths." }, { "name": "revision", "value": "", "type": "query", "description": "Retrieve file lines from specific revision." }, { "name": "startLineNumber", "value": "", "type": "query", "description": "Line number from where to start returning file lines." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Retrieve lines of a specified file. Supports starting line number and limit.\n" }, { "info": { "name": "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\"", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/files/:filePath/lines", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "filePath", "value": "", "type": "path", "description": "Path to a file within a repository." }, { "name": "revision", "value": "", "type": "query", "description": "Retrieve file lines from specific revision." }, { "name": "startLineNumber", "value": "", "type": "query", "description": "Line number from where to start returning file lines." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "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\"\n" }, { "info": { "name": "LIST operation that returns a collection of fork sync status objects", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/forkSyncStatuses", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "branchNameQueryParam", "value": "", "type": "query", "description": "Specifies the branch for which the fork sync status will be checked." } ] }, "docs": "LIST operation that returns a collection of fork sync status objects." }, { "info": { "name": "Gets a list of mirror entry in history within 30 days", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/mirrorRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." } ] }, "docs": "Returns a list of mirror entry in history within 30 days.\n" }, { "info": { "name": "Gets either current mirror record or last successful mirror record for a specific mirror repository", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/mirrorRecords/:mirrorRecordType", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "mirrorRecordType", "value": "", "type": "path", "description": "The field of mirror record type. Only one mirror record type can be provided:\ncurrent - The current mirror record.\nlastSuccessful - The last successful mirror record.\n" } ] }, "docs": "Returns either current mirror record or last successful mirror record for a specific mirror repository.\n" }, { "info": { "name": "Get data about a blob/tree of specific branch name/commit id and file path", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/object", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "filePath", "value": "", "type": "query", "description": "A filter to return only commits that affect any of the specified paths." }, { "name": "refName", "value": "", "type": "query", "description": "A filter to return only resources that match the given reference name." } ] }, "docs": "Retrieves blob of specific branch name/commit ID and file path.\n" }, { "info": { "name": "Get contents of a specified Object", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/objects/:sha/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "sha", "value": "", "type": "path", "description": "The SHA of a blob or tree." }, { "name": "filePath", "value": "", "type": "query", "description": "A filter to return only commits that affect any of the specified paths." } ] }, "docs": "Retrieve contents of a specified object.\n" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/paths", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "ref", "value": "", "type": "query", "description": "The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag.\nYou can disambiguate with \"heads/foobar\" and \"tags/foobar\". If left blank repository's default branch will be used.\n" }, { "name": "pathsInSubtree", "value": "", "type": "query", "description": "Flag to determine if files must be retrived recursively. Flag is False by default." }, { "name": "folderPath", "value": "", "type": "query", "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." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Retrieves a list of files and directories in a repository.\n" }, { "info": { "name": "Get the repository notification preference for the user passed as path param", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ] }, "docs": "Get the repository notification preference for the user passed as path param" }, { "info": { "name": "Update the repository notification preference for the user passed as path param", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/principals/:principalId/pullRequestNotificationPreference", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "principalId", "value": "", "type": "path", "description": "Unique principal identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the repository notification preference for the user passed as path param" }, { "info": { "name": "Gets a list of all Protected Branches in a Repository", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/protectedBranches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the given branch name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of Protected Branches.\n" }, { "info": { "name": "Get a list of all the PR authors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/pullRequestAuthors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." } ] }, "docs": "Retrieve a list of all the PR authors.\n" }, { "info": { "name": "Gets a list of all Refs in a Repository", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/refs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refType", "value": "", "type": "query", "description": "Reference type to distinguish between branch and tag. If it is not specified, all references are returned." }, { "name": "commitId", "value": "", "type": "query", "description": "Commit ID in a repository." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "refName", "value": "", "type": "query", "description": "A filter to return only resources that match the given reference name." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" } ] }, "docs": "Returns a list of references.\n" }, { "info": { "name": "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\".", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/refs/:refName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "path", "description": "A filter to return only resources that match the given reference name." } ] }, "docs": "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/\"." }, { "info": { "name": "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\".", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/refs/:refName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "path", "description": "A filter to return only resources that match the given reference name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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\".\n" }, { "info": { "name": "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\".", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/refs/:refName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "refName", "value": "", "type": "path", "description": "A filter to return only resources that match the given reference name." } ] }, "docs": "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\"." }, { "info": { "name": "Gets repository settings.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/repositorySettings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ] }, "docs": "Retrieves a repository's settings details." }, { "info": { "name": "Updates the settings of a repository.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/repositorySettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings for a repository." }, { "info": { "name": "Removes custom settings configured for a repository", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/repositories/:repositoryId/repositorySettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." } ] }, "docs": "Removes the custom settings configured for a repository" }, { "info": { "name": "Retrieves repository analytics for a given repository.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/repository/:repositoryId/repositoryAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "repositoryId", "value": "", "type": "path", "description": "Unique repository identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves repository analytics for a given repository." }, { "info": { "name": "Gets a list of all Triggers in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/triggers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "projectId", "value": "", "type": "query", "description": "unique project identifier" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only triggers that matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "Unique trigger identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of triggers.\n" }, { "info": { "name": "Creates a new Trigger", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210630/triggers", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new trigger.\n" }, { "info": { "name": "Get Trigger", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/triggers/:triggerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "triggerId", "value": "", "type": "path", "description": "Unique trigger identifier." } ] }, "docs": "Retrieves a trigger by identifier." }, { "info": { "name": "Update the Trigger identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210630/triggers/:triggerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "triggerId", "value": "", "type": "path", "description": "Unique trigger identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the trigger." }, { "info": { "name": "Delete a provisioned Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210630/triggers/:triggerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "triggerId", "value": "", "type": "path", "description": "Unique trigger identifier." } ] }, "docs": "Deletes a trigger resource by identifier." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources where the lifecycle state matches the given operation status." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." }, { "name": "operationTypeMultiValueQuery", "value": "", "type": "query", "description": "A filter to return only resources where their Operation Types matches the parameter operation types" } ] }, "docs": "Lists the work requests in a compartment." }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous work request." } ] }, "docs": "Retrieves the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of errors for a given work request." }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210630/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use. Use either ascending or descending." }, { "name": "sortBy", "value": "", "type": "query", "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." } ] }, "docs": "Returns a list of logs for a given work request." } ] } ], "bundled": true }