scripts/schemas/snippet-schema.yaml

# SPDX-License-Identifier: Apache-2.0
#
# Copyright (c) 2022-2025, Nordic Semiconductor ASA

# JSON Schema for snippet YAML files
# When possible, constraints and validation rules should be modeled directly in this file.

# Example usage of applying a snippet to all boards:
# name: foo
# append:
#   EXTRA_DTC_OVERLAY_FILE: m3.overlay

# Example usage of applying a snippet to one specific board:
# name: foo
# boards:
#   qemu_cortex_m3:
#     append:
#       EXTRA_DTC_OVERLAY_FILE: m3.overlay

$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "https://zephyrproject.org/schemas/zephyr/snippet"
title: Zephyr snippet Schema
description: Schema for validating Zephyr snippet files
type: object
$defs:
  append-schema:
    # Sub-schema for appending onto CMake list variables.
    # See uses under '$ref: "#/$defs/append-schema"' keys below.
    type: object
    properties:
      EXTRA_DTC_OVERLAY_FILE:
        type: string
      EXTRA_CONF_FILE:
        type: string
      SB_EXTRA_CONF_FILE:
        type: string
      DTS_EXTRA_CPPFLAGS:
        type: string
    additionalProperties: false

properties:
  name:
    type: string
  append:
    $ref: "#/$defs/append-schema"
  boards:
    type: object
    patternProperties:
      "(.*)":
        type: object
        properties:
          append:
            $ref: "#/$defs/append-schema"
        additionalProperties: false
required:
  - name
additionalProperties: false