Allianz Technology Standards · JSON Structure

Tech Standards Compliance Violation Structure

A compliance violation found during a check

Type: object Properties: 4

Best PracticesEnterprise ArchitectureGuidelinesSoftware DevelopmentTechnology StandardsAPI DesignOpenAPI

ComplianceViolation is a JSON Structure definition published by Allianz Technology Standards, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

rule_id description severity path

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/allianz-technology-standards/refs/heads/main/json-structure/tech-standards-compliance-violation-structure.json",
  "description": "A compliance violation found during a check",
  "properties": {
    "rule_id": {
      "type": "string",
      "description": "Rule that was violated",
      "example": "pag-001"
    },
    "description": {
      "type": "string",
      "description": "Description of the violation",
      "example": "pageSize parameter missing default value of 20"
    },
    "severity": {
      "type": "string",
      "description": "Severity of the violation",
      "enum": [
        "required",
        "recommended",
        "optional"
      ],
      "example": "required"
    },
    "path": {
      "type": "string",
      "description": "API path where the violation was found",
      "example": "/policies"
    }
  },
  "name": "ComplianceViolation"
}