Allianz Technology Standards · JSON Structure

Tech Standards Standard Structure

An Allianz technology standard definition

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

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

Properties

standard_id name category version status description rules

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

JSON Structure

tech-standards-standard-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-standard-structure.json",
  "description": "An Allianz technology standard definition",
  "properties": {
    "standard_id": {
      "type": "string",
      "description": "Unique identifier for the standard",
      "example": "std-500001"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the standard",
      "example": "REST API Pagination Standard"
    },
    "category": {
      "type": "string",
      "description": "Category of the technology standard",
      "enum": [
        "api-design",
        "backend",
        "architecture",
        "security",
        "testing"
      ],
      "example": "api-design"
    },
    "version": {
      "type": "string",
      "description": "Current version of the standard",
      "example": "2.1.0"
    },
    "status": {
      "type": "string",
      "description": "Lifecycle status of the standard",
      "enum": [
        "draft",
        "current",
        "deprecated",
        "retired"
      ],
      "example": "current"
    },
    "description": {
      "type": "string",
      "description": "Description of what the standard covers",
      "example": "Standard for paginating collection responses in Allianz REST APIs"
    },
    "rules": {
      "type": "array",
      "description": "List of rules defined by this standard",
      "items": {
        "$ref": "#/components/schemas/StandardRule"
      }
    }
  },
  "name": "Standard"
}