Allianz Technology Standards · JSON Structure

Tech Standards Compliance Result Structure

Result of a compliance check

Type: object Properties: 6
Best PracticesEnterprise ArchitectureGuidelinesSoftware DevelopmentTechnology StandardsAPI DesignOpenAPI

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

Properties

check_id status passed failed warnings violations

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

JSON Structure

tech-standards-compliance-result-structure.json Raw ↑
{
  "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-result-structure.json",
  "description": "Result of a compliance check",
  "properties": {
    "check_id": {
      "type": "string",
      "description": "Unique identifier for the compliance check",
      "example": "chk-500123"
    },
    "status": {
      "type": "string",
      "description": "Status of the compliance check",
      "enum": [
        "pending",
        "completed",
        "failed"
      ],
      "example": "completed"
    },
    "passed": {
      "type": "integer",
      "description": "Number of rules that passed",
      "example": 18
    },
    "failed": {
      "type": "integer",
      "description": "Number of rules that failed",
      "example": 3
    },
    "warnings": {
      "type": "integer",
      "description": "Number of warnings found",
      "example": 5
    },
    "violations": {
      "type": "array",
      "description": "List of compliance violations found",
      "items": {
        "$ref": "#/components/schemas/ComplianceViolation"
      }
    }
  },
  "name": "ComplianceResult"
}