{
    "$schema": "https://alexanderparker.github.io/instruction-template-specification/schema/v1.0/its-base-schema-v1.json",
    "version": "1.0.0",
    "extends": [
        "https://alexanderparker.github.io/instruction-template-specification/schema/v1.0/its-markdown-types-v1.json"
    ],
    "metadata": {
        "name": "Release Notes Template",
        "description": "A release-notes document whose Markdown structure is authored literally in the template, with Markdown type placeholders filling the generated content",
        "author": "Alexander Parker",
        "tags": [
            "example",
            "markdown",
            "release-notes",
            "structured-output"
        ],
        "created": "2026-08-01T00:00:00Z"
    },
    "variables": {
        "product": "Example Storefront",
        "releaseVersion": "2.4.0",
        "includeUpgradeNotes": true
    },
    "content": [
        {
            "type": "text",
            "text": "# ${product} ${releaseVersion} release notes\n\n"
        },
        {
            "type": "placeholder",
            "id": "release_tagline",
            "instructionType": "markdown_text",
            "config": {
                "description": "a one-line summary of what this ${product} release delivers",
                "displayName": "Release Tagline",
                "allowFormatting": true
            }
        },
        {
            "type": "text",
            "text": "\n\n## Highlights\n\n"
        },
        {
            "type": "placeholder",
            "id": "highlights",
            "instructionType": "markdown_list_items",
            "config": {
                "description": "the headline features shipped in ${product} ${releaseVersion}",
                "displayName": "Highlights",
                "listType": "bullet",
                "itemCount": 4
            }
        },
        {
            "type": "text",
            "text": "\n\n## Fixed issues\n\n| Issue | Summary |\n| --- | --- |\n"
        },
        {
            "type": "placeholder",
            "id": "fixed_issues",
            "instructionType": "markdown_table_rows",
            "config": {
                "description": "plausible issue references and one-line summaries of bugs fixed in ${product} ${releaseVersion}",
                "displayName": "Fixed Issues",
                "rows": 3,
                "columns": 2
            }
        },
        {
            "type": "text",
            "text": "\n\n## Upgrade\n\nUpgrade an existing installation with:\n\n```bash\n"
        },
        {
            "type": "placeholder",
            "id": "upgrade_commands",
            "instructionType": "markdown_code",
            "config": {
                "description": "shell commands that upgrade ${product} to ${releaseVersion}",
                "displayName": "Upgrade Commands",
                "language": "bash"
            }
        },
        {
            "type": "text",
            "text": "\n```\n"
        },
        {
            "type": "conditional",
            "condition": "includeUpgradeNotes == true",
            "content": [
                {
                    "type": "text",
                    "text": "\n### Upgrade notes\n\n"
                },
                {
                    "type": "placeholder",
                    "id": "upgrade_notes",
                    "instructionType": "markdown_block",
                    "config": {
                        "description": "breaking changes in ${product} ${releaseVersion} and the steps operators must take before upgrading",
                        "displayName": "Upgrade Notes"
                    }
                }
            ]
        }
    ]
}