Amazon CodeGuru Reviewer · JSON Structure

Amazon Codeguru Reviewer Commit Diff Source Code Type Structure

A type of SourceCodeType that specifies the commit diff for a pull request on an associated repository. The SourceCommit and DestinationCommit fields are required to do a pull request code review.

Type: object Properties: 3
AmazonCode ReviewSecurityDevOpsMachine LearningDeveloper Tools

CommitDiffSourceCodeType is a JSON Structure definition published by Amazon CodeGuru Reviewer, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

SourceCommit DestinationCommit MergeBaseCommit

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-reviewer/refs/heads/main/json-structure/amazon-codeguru-reviewer-commit-diff-source-code-type-structure.json",
  "name": "CommitDiffSourceCodeType",
  "description": "A type of <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType\">SourceCodeType</a> that specifies the commit diff for a pull request on an associated repository. The <code>SourceCommit</code> and <code>DestinationCommit</code> fields are required to do a pull request code review.",
  "type": "object",
  "properties": {
    "SourceCommit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CommitId"
        },
        {
          "description": "The SHA of the source commit used to generate a commit diff. This field is required for a pull request code review."
        }
      ]
    },
    "DestinationCommit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CommitId"
        },
        {
          "description": "The SHA of the destination commit used to generate a commit diff. This field is required for a pull request code review."
        }
      ]
    },
    "MergeBaseCommit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CommitId"
        },
        {
          "description": "The SHA of the merge base of a commit."
        }
      ]
    }
  }
}