Properties
| Name | Type | Description |
|---|---|---|
| title | string | Rule title |
| code | string | Rule id |
| type | object | |
| url | string | Link to the rule's description |
| is_active | boolean | Shows whether the rule is activated |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Rule",
"description": "Rule",
"$id": "https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-schema/zally-api-rule-schema.json",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Rule title",
"example": "Do Not Use URI Versioning"
},
"code": {
"type": "string",
"description": "Rule id",
"example": "115"
},
"type": {
"$ref": "#/components/schemas/RuleType"
},
"url": {
"type": "string",
"description": "Link to the rule's description",
"example": "https://zalando.github.io/restful-api-guidelines/compatibility/Compatibility.html#must-do-not-use-uri-versioning"
},
"is_active": {
"type": "boolean",
"description": "Shows whether the rule is activated",
"example": true
}
},
"required": [
"title",
"code",
"type",
"url",
"is_active"
]
}