Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.
RuleMetadata is a JSON Structure definition published by Amazon CodeGuru Reviewer, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$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-rule-metadata-structure.json",
"name": "RuleMetadata",
"description": "Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.",
"type": "object",
"properties": {
"RuleId": {
"allOf": [
{
"$ref": "#/components/schemas/RuleId"
},
{
"description": "The ID of the rule."
}
]
},
"RuleName": {
"allOf": [
{
"$ref": "#/components/schemas/RuleName"
},
{
"description": "The name of the rule."
}
]
},
"ShortDescription": {
"allOf": [
{
"$ref": "#/components/schemas/ShortDescription"
},
{
"description": "A short description of the rule."
}
]
},
"LongDescription": {
"allOf": [
{
"$ref": "#/components/schemas/LongDescription"
},
{
"description": "A long description of the rule."
}
]
},
"RuleTags": {
"allOf": [
{
"$ref": "#/components/schemas/RuleTags"
},
{
"description": "Tags that are associated with the rule."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.