{ "$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-structure.json", "name": "CodeReview", "description": "Information about a code review. A code review belongs to the associated repository that contains the reviewed code.", "type": "object", "properties": { "Name": { "allOf": [ { "$ref": "#/components/schemas/Name" }, { "description": "The name of the code review." } ] }, "CodeReviewArn": { "allOf": [ { "$ref": "#/components/schemas/Arn" }, { "description": "The Amazon Resource Name (ARN) of the CodeReview object. " } ] }, "RepositoryName": { "allOf": [ { "$ref": "#/components/schemas/Name" }, { "description": "The name of the repository." } ] }, "Owner": { "allOf": [ { "$ref": "#/components/schemas/Owner" }, { "description": "The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID." } ] }, "ProviderType": { "allOf": [ { "$ref": "#/components/schemas/ProviderType" }, { "description": "The type of repository that contains the reviewed code (for example, GitHub or Bitbucket)." } ] }, "State": { "allOf": [ { "$ref": "#/components/schemas/JobState" }, { "description": "
The valid code review states are:
Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.
Security, CodeQuality, or both."
}
]
},
"ConfigFileState": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigFileState"
},
{
"description": "The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository."
}
]
}
}
}