lib/apis.schema.json

   1 {
   2     "$schema": "https://json-schema.org/draft/2020-12/schema",
   3     "$id": "https://moodle.org/apis.schema.json",
   4     "title": "APIs",
   5     "description": "Moodle valid APIs",
   6     "type": "object",
   7     "patternProperties": {
   8         "^[a-z][a-z0-9]+$": {
   9             "type": "object",
  10             "properties": {
  11                 "component": {
  12                     "description": "Component the API belongs to, usually a subsystem or core. Null for the 'core' API itself",
  13                     "type": [ "string", "null" ],
  14                     "pattern": "^(core|[a-z][a-z0-9_]+)$"
  15                 },
  16                 "allowedlevel2": {
  17                     "description": "Can the API be used as level 2 namespace",
  18                     "type": "boolean"
  19                 },
  20                 "allowedspread": {
  21                     "description": "Can the API be used out from its own component",
  22                     "type": "boolean"
  23                 }
  24             },
  25             "minProperties": 3,
  26             "maxProperties": 3,
  27             "additionalProperties": false
  28         }
  29     }
  30 }