DriverGuidanceEnvelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fleetkeep-co-uk/json-schema/fleetkeep-co-uk-driver-guidance-envelope-schema.json",
  "title": "DriverGuidanceEnvelope",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fleetkeep-co-uk-account-api-openapi.yml#/components/schemas/DriverGuidanceEnvelope",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "guidance"
  ],
  "properties": {
    "guidance": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "enabled",
        "breakdownInfo",
        "accidentProcedure",
        "vehicleGuidance",
        "document",
        "updatedAt"
      ],
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "breakdownInfo": {
          "type": "string",
          "maxLength": 5000
        },
        "accidentProcedure": {
          "type": "string",
          "maxLength": 5000
        },
        "vehicleGuidance": {
          "type": "string",
          "maxLength": 5000
        },
        "document": {
          "oneOf": [
            {
              "$ref": "#/$defs/DriverGuidanceDocument"
            },
            {
              "type": "null"
            }
          ]
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    }
  },
  "$defs": {
    "DriverGuidanceDocument": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "fileName",
        "sizeBytes",
        "contentType",
        "uploadedAt",
        "downloadPath"
      ],
      "properties": {
        "fileName": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 255
        },
        "sizeBytes": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 10485760
        },
        "contentType": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 120
        },
        "uploadedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "downloadPath": {
          "type": "string",
          "const": "/api/v1/driver-guidance/document"
        }
      }
    }
  }
}