apis.schema.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://moodle.org/apis.schema.json",
    "title": "APIs",
    "description": "Moodle valid APIs",
    "type": "object",
    "patternProperties": {
        "^[a-z][a-z0-9]+$": {
            "type": "object",
            "properties": {
                "component": {
                    "description": "Component the API belongs to, usually a subsystem or core. Null for the 'core' API itself",
                    "type": [ "string", "null" ],
                    "pattern": "^(core|[a-z][a-z0-9_]+)$"
                },
                "allowedlevel2": {
                    "description": "Can the API be used as level 2 namespace",
                    "type": "boolean"
                },
                "allowedspread": {
                    "description": "Can the API be used out from its own component",
                    "type": "boolean"
                }
            },
            "minProperties": 3,
            "maxProperties": 3,
            "additionalProperties": false
        }
    }
}