schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://version.goauthentik.io/schema.json",
    "type": "object",
    "title": "The root schema",
    "default": {},
    "examples": [
        {
            "stable": {
                "version": "2021.8.5",
                "changelog": "See https://goauthentik.io/docs/releases/2021.8#fixed-in-202185",
                "reason": "bugfix"
            }
        }
    ],
    "required": [
        "stable"
    ],
    "properties": {
        "stable": {
            "$id": "#/properties/stable",
            "type": "object",
            "title": "The stable schema",
            "description": "An explanation about the purpose of this instance.",
            "default": {},
            "examples": [
                {
                    "version": "2021.8.5",
                    "changelog": "See https://goauthentik.io/docs/releases/2021.8#fixed-in-202185",
                    "reason": "bugfix"
                }
            ],
            "required": [
                "version",
                "changelog",
                "changelog_url",
                "reason"
            ],
            "properties": {
                "version": {
                    "$id": "#/properties/stable/properties/version",
                    "type": "string",
                    "title": "The version schema",
                    "description": "An explanation about the purpose of this instance.",
                    "default": "",
                    "examples": [
                        "2021.8.5"
                    ]
                },
                "changelog": {
                    "$id": "#/properties/stable/properties/changelog",
                    "type": "string",
                    "title": "The changelog schema",
                    "description": "An explanation about the purpose of this instance.",
                    "default": "",
                    "examples": [
                        "See https://goauthentik.io/docs/releases/2021.8#fixed-in-202185"
                    ]
                },
                "changelog_url": {
                    "$id": "#/properties/stable/properties/changelog",
                    "type": "string",
                    "title": "A URL to the changelog website",
                    "description": "An explanation about the purpose of this instance.",
                    "default": "",
                    "examples": [
                        "https://goauthentik.io/docs/releases/2021.8#fixed-in-202185"
                    ]
                },
                "reason": {
                    "$id": "#/properties/stable/properties/reason",
                    "default": "",
                    "description": "An explanation about the purpose of this instance.",
                    "examples": [
                        "bugfix"
                    ],
                    "title": "The reason schema",
                    "enum": [
                        "bugfix",
                        "feature",
                        "security",
                        "other"
                    ],
                    "type": "string"
                }
            },
            "additionalProperties": true
        }
    },
    "additionalProperties": true
}