DataCat/plugin-schema.json at main · JWeinelt/DataCat · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.data-cat.de/schema/plugin-configuration.json",
  "title": "PluginConfiguration",
  "description": "Configuration schema for DataCat plugins (plugin.json)",
  "type": "object",
  "additionalProperties": false,

  "required": [
    "pluginName",
    "authors",
    "version",
    "mainClass",
    "description",
    "minAPIVersion",
    "usesEncryption",
    "usesDatabase",
    "storesSensitiveData"
  ],

  "properties": {
    "pluginName": {
      "type": "string",
      "description": "Human-readable name of the plugin",
      "minLength": 1
    },

    "authors": {
      "type": "array",
      "description": "List of plugin authors",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },

    "version": {
      "type": "string",
      "description": "Plugin version",
      "pattern": "^[0-9]+(\\.[0-9]+)*(-[a-zA-Z0-9]+)?$"
    },

    "mainClass": {
      "type": "string",
      "description": "Fully qualified main class name",
      "pattern": "^[a-zA-Z_$][a-zA-Z\\d_$]*(\\.[a-zA-Z_$][a-zA-Z\\d_$]*)*$"
    },

    "description": {
      "type": "string",
      "description": "Short plugin description"
    },

    "minAPIVersion": {
      "type": "string",
      "description": "Minimum required DataCat API version"
    },

    "usesEncryption": {
      "type": "boolean",
      "description": "Whether the plugin uses encryption"
    },

    "usesDatabase": {
      "type": "boolean",
      "description": "Whether the plugin accesses a database"
    },

    "storesSensitiveData": {
      "type": "boolean",
      "description": "Whether the plugin stores sensitive data"
    },

    "requires": {
      "type": "array",
      "description": "List of required plugin IDs or capabilities",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "uniqueItems": true
    }
  }
}