Allianz Technology Standards · JSON Structure

Tech Standards Compliance Check Request Structure

Request body for checking API compliance

Type: object Properties: 2 Required: 1

Best PracticesEnterprise ArchitectureGuidelinesSoftware DevelopmentTechnology StandardsAPI DesignOpenAPI

ComplianceCheckRequest is a JSON Structure definition published by Allianz Technology Standards, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

openapi_url standard_ids

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-check-request-structure.json",
  "description": "Request body for checking API compliance",
  "properties": {
    "openapi_url": {
      "type": "uri",
      "description": "URL of the OpenAPI spec to check",
      "example": "https://example.com/openapi.yaml"
    },
    "standard_ids": {
      "type": "array",
      "description": "List of standard IDs to check against",
      "items": {
        "type": "string"
      },
      "example": [
        "std-500001",
        "std-500002"
      ]
    }
  },
  "required": [
    "openapi_url"
  ],
  "name": "ComplianceCheckRequest"
}