aerleon-policy-yaml.schema.json

{
  "$id": "urn:aerleon:schemas:aerleon-policy-yaml:1.0.0",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AerleonPolicyFile",
  "description": "An Aerleon policy file represents a platform-agnostic network policy. It must define one or more filter objects.",
  "oneOf": [
    { "$ref": "#/$defs/policyIncludeFile" },
    { "$ref": "#/$defs/policyFile" }
  ],
  "$defs": {
    "policyFile": {
      "type": "object",
      "title": "PolicyFile",
      "description": "A policy file contains one or more filters, where each filter has a unique list of target platforms and a unique list of terms.",
      "required": ["filters"],
      "properties": {
        "filters": {
          "type": "array",
          "items": { "$ref": "#/$defs/filter" }
        }
      }
    },
    "policyIncludeFile": {
      "type": "object",
      "title": "PolicyIncludeFile",
      "description": "A policy include file only defines a list of terms. This file can be inserted into any list of terms.",
      "required": ["terms"],
      "properties": {
        "terms": {
          "type": "array",
          "items": { "$ref": "#/$defs/term" }
        }
      }
    },
    "filter": {
      "type": "object",
      "required": ["header", "terms"],
      "header": {
        "type": { "$ref": "#/$defs/filterHeader" }
      },
      "terms": {
        "type": "list",
        "items": { "$ref": "#/$defs/term" }
      },
      "additionalProperties": true
    },
    "filterHeader": {
      "type": "object",
      "title": "FilterHeader",
      "required": ["targets"],
      "targets": {
        "type": "object"
      }
    },
    "term": {
      "title": "Term",
      "oneOf": [
        {
          "type": "object",
          "required": "name",
          "properties": {
            "name": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "required": "include",
          "properties": {
            "name": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    }
  }
}