Amazon CodeGuru Reviewer · JSON Structure

Amazon Codeguru Reviewer Code Review Type Structure

The type of a code review. There are two code review types:

Type: object Properties: 2 Required: 1
AmazonCode ReviewSecurityDevOpsMachine LearningDeveloper Tools

CodeReviewType is a JSON Structure definition published by Amazon CodeGuru Reviewer, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

RepositoryAnalysis AnalysisTypes

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-code-review-type-structure.json",
  "name": "CodeReviewType",
  "description": "<p>The type of a code review. There are two code review types:</p> <ul> <li> <p> <code>PullRequest</code> - A code review that is automatically triggered by a pull request on an associated repository.</p> </li> <li> <p> <code>RepositoryAnalysis</code> - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview\">CreateCodeReview</a>.</p> </li> </ul>",
  "type": "object",
  "properties": {
    "RepositoryAnalysis": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RepositoryAnalysis"
        },
        {
          "description": "A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CreateCodeReview\">CreateCodeReview</a>."
        }
      ]
    },
    "AnalysisTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnalysisTypes"
        },
        {
          "description": "They types of analysis performed during a repository analysis or a pull request review. You can specify either <code>Security</code>, <code>CodeQuality</code>, or both."
        }
      ]
    }
  },
  "required": [
    "RepositoryAnalysis"
  ]
}