master
json 71 lines 1.75 KB
Raw
1 {
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "Netdata authentication mechanism metadata.",
4 "oneOf": [
5 {
6 "$ref": "#/$defs/entry"
7 },
8 {
9 "type": "array",
10 "minLength": 1,
11 "items": {
12 "$ref": "#/$defs/entry"
13 }
14 }
15 ],
16 "$defs": {
17 "entry": {
18 "type": "object",
19 "description": "Data for a single authentication method.",
20 "properties": {
21 "id": {
22 "$ref": "./shared.json#/$defs/id"
23 },
24 "meta": {
25 "$ref": "./shared.json#/$defs/instance"
26 },
27 "keywords": {
28 "$ref": "./shared.json#/$defs/keywords"
29 },
30 "overview": {
31 "type": "object",
32 "description": "General information about the authentication method.",
33 "properties": {
34 "authentication_description": {
35 "type": "string",
36 "description": "General description of what the authentication method does."
37 },
38 "authentication_limitations": {
39 "type": "string",
40 "description": "Explanation of any limitations of the authentication method."
41 }
42 },
43 "required": [
44 "authentication_description",
45 "authentication_limitations"
46 ]
47 },
48 "setup": {
49 "oneOf": [
50 {
51 "$ref": "./shared.json#/$defs/short_setup"
52 },
53 {
54 "$ref": "./shared.json#/$defs/full_setup"
55 }
56 ]
57 },
58 "troubleshooting": {
59 "$ref": "./shared.json#/$defs/troubleshooting"
60 }
61 },
62 "required": [
63 "id",
64 "meta",
65 "keywords",
66 "overview",
67 "setup"
68 ]
69 }
70 }
71 }