JSON Schema for Badge Class v1.0

badge-class.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Badge Class",
    "description": "The definition of an available achievement.",
    "type": "object",
    "required": [
        "name",
        "description",
        "image",
        "criteria",
        "issuer"
    ],
    "additionalProperties": true,
    "properties": {
        "name": {
            "description": "The name of the achievement.",
            "type": "string"
        },
        "description": {
            "description": "A short description of the achievement.",
            "type": "string"
        },
        "image": {
            "description": "URL of an image representing the achievement.",
            "type": "string",
            "format": "uri"
        },
        "criteria": {
            "description": "URL of the criteria for earning the achievement. If the badge represents an educational achievement, consider marking up this up with LRMI.",
            "type": "string",
            "format": "uri"
        },
        "issuer": {
            "description": "URL of the organization that issued the badge.",
            "type": "string",
            "format": "uri"
        },
        "alignment": {
            "description": "List of objects describing which educational standards this badge aligns to, if any.",
            "type": "array",
            "items": {"$ref": "#/definitions/alignment"},
            "minItems": 0
        },
        "tags": {
            "description": "List of tags that describe the type of achievement.",
            "type": "array",
            "items": {"type": "string"},
            "minItems": 0
        }
    },
    "definitions": {
        "alignment": {
            "required": ["name", "url"],
            "additionalProperties": false,
            "properties": {
                "name": {
                    "description": "Name of the alignment.",
                    "type": "string"
                },
                "url": {
                    "description": "URL linking to the official description of the standard.",
                    "type": "string",
                    "format": "uri"
                },
                "description": {
                    "description": "Short description of the standard.",
                    "type": "string"
                }
            }
        }
    }
}