Zally · JSON Structure

Zally Api Linting Response Structure

Linting Response

Type: object Properties: 4 Required: 2
API DesignAPI LintingAPI QualityOpen SourceOpenAPIZalando

LintingResponse is a JSON Structure definition published by Zally, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

violations message violations_count api_definition

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/zally/refs/heads/main/json-structure/zally-api-linting-response-structure.json",
  "name": "LintingResponse",
  "description": "Linting Response",
  "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"
  ]
}