Zally · Schema
LintingResponse
Linting Response
API DesignAPI LintingAPI QualityOpen SourceOpenAPIZalando
Properties
| Name | Type | Description |
|---|---|---|
| violations | array | List of violations |
| message | string | Custom server message |
| violations_count | object | |
| api_definition | string | Specification object in OpenAPI format |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "LintingResponse",
"description": "Linting Response",
"$id": "https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-schema/zally-api-linting-response-schema.json",
"type": "object",
"properties": {
"violations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Violation"
},
"description": "List of violations",
"example": [
{}
]
},
"message": {
"type": "string",
"description": "Custom server message",
"example": "Example description for this resource."
},
"violations_count": {
"$ref": "#/components/schemas/ViolationsCount"
},
"api_definition": {
"type": "string",
"description": "Specification object in OpenAPI format",
"example": "example-value"
}
},
"required": [
"violations",
"violations_count"
]
}