/codereviews

POST

/codereviews

Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request.

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InternalServerException

🟠482ValidationException

🟠483ConflictException

🟠484AccessDeniedException

🟠485ThrottlingException

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/codereviews' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "string",
    "RepositoryAssociationArn": "string",
    "Type": {
        "RepositoryAnalysis": {
            "RepositoryHead": {
                "BranchName": "string"
            },
            "SourceCodeType": {
                "CommitDiff": {
                    "SourceCommit": "string",
                    "DestinationCommit": "string",
                    "MergeBaseCommit": "string"
                },
                "RepositoryHead": {
                    "BranchName": "string"
                },
                "BranchDiff": {
                    "SourceBranchName": "string",
                    "DestinationBranchName": "string"
                },
                "S3BucketRepository": {
                    "Name": "string",
                    "Details": {
                        "BucketName": "string",
                        "CodeArtifacts": {
                            "SourceCodeArtifactsObjectKey": "string",
                            "BuildArtifactsObjectKey": "string"
                        }
                    }
                },
                "RequestMetadata": {
                    "RequestId": "string",
                    "Requester": "string",
                    "EventInfo": {
                        "Name": "string",
                        "State": "string"
                    },
                    "VendorName": "GitHub"
                }
            }
        },
        "AnalysisTypes": []
    },
    "ClientRequestToken": "string"
}'

Response Example

200 - Example 1

{
    "CodeReview": {
        "Name": "string",
        "CodeReviewArn": "string",
        "RepositoryName": "string",
        "Owner": "string",
        "ProviderType": "CodeCommit",
        "State": "Completed",
        "StateReason": "string",
        "CreatedTimeStamp": "string",
        "LastUpdatedTimeStamp": "string",
        "Type": "PullRequest",
        "PullRequestId": "string",
        "SourceCodeType": {
            "CommitDiff": {
                "SourceCommit": "string",
                "DestinationCommit": "string",
                "MergeBaseCommit": "string"
            },
            "RepositoryHead": {
                "BranchName": "string"
            },
            "BranchDiff": {
                "SourceBranchName": "string",
                "DestinationBranchName": "string"
            },
            "S3BucketRepository": {
                "Name": "string",
                "Details": {
                    "BucketName": "string",
                    "CodeArtifacts": {
                        "SourceCodeArtifactsObjectKey": "string",
                        "BuildArtifactsObjectKey": "string"
                    }
                }
            },
            "RequestMetadata": {
                "RequestId": "string",
                "Requester": "string",
                "EventInfo": {
                    "Name": "string",
                    "State": "string"
                },
                "VendorName": "GitHub"
            }
        },
        "AssociationArn": "string",
        "Metrics": {
            "MeteredLinesOfCodeCount": 0,
            "FindingsCount": 0
        },
        "AnalysisTypes": []
    }
}

Modified at 2022-09-02 07:32:21

/associations

/codereviews/{CodeReviewArn}