-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathschema.json
More file actions
199 lines (199 loc) · 8.7 KB
/
schema.json
File metadata and controls
199 lines (199 loc) · 8.7 KB
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the organization."
},
"description": {
"type": "string",
"description": "A short sentence describing the organization."
},
"avatar": {
"type": "string",
"description": "An url of an avatar displayed next to an Add-on."
},
"contact": {
"type": "object",
"properties": {
"devzoneUsername": {
"type": "string",
"description": "Nordic Semiconductor devzone`s account registered as responsible for providing the support for the Add-ons."
},
"email": {
"type": "string",
"description": "The email that the Nordic Semiconductor DevZone account is registered with."
}
},
"required": [
"devzoneUsername"
]
},
"apps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the application repo. Should be the repo-name in the GitHub URL: https://github.com/org/repo-name."
},
"repo": {
"type": "string",
"description": "The Url of an Add-on repository"
},
"title": {
"type": "string",
"description": "Human readable name of the repo to be shown in the UI. Defaults to the name property."
},
"description": {
"type": "string",
"description": "Text describing the application. Inferred from the repo if missing."
},
"manifest": {
"type": "string",
"default": "west.yml",
"description": "Alternative filename for the west manifest. Defaults to west.yml."
},
"avatar": {
"type": "string",
"description": "An url of an avatar displayed next to an Add-on."
},
"kind": {
"description": "The type of the app repo.",
"oneOf": [
{
"const": "template",
"description": "A starting point for new apps"
},
{
"const": "sample",
"description": "A demonstration of a concept."
},
{
"const": "project",
"description": "A fully-fledged project users can run on their devices."
}
]
},
"tags": {
"type": "array",
"items": {
"enum": [
"bluetooth",
"zigbee",
"lte",
"dfu",
"thread",
"matter",
"bt-mesh",
"sidewalk",
"lora-basics-modem",
"CSS",
"FSK",
"ble",
"blecon",
"connectivity",
"edge-ai",
"door-lock",
"access-control",
"aliro"
]
},
"description": "An array of tags describing the application."
},
"license": {
"type": "string",
"description": "The name of the application license, e.g. \"Apache 2.0\". Inferred from the repo if missing."
},
"apps": {
"type": "string",
"description": "Glob pattern to find directories containing applications.\n\nApplications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.\n\nBy default, the VS Code extension will assume that there's just a single application sitting at the root of the repo."
},
"releases": {
"type": "array",
"description": "The collection of project`s releases.",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"description": "Git tag of the released version."
},
"name": {
"type": "string",
"description": "The title of the release."
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date of publishing the release."
},
"sdk": {
"type": "string",
"description": "The nRF Connect SDK version the release is compatible with."
}
},
"required": [
"tag",
"name",
"date",
"sdk"
],
"additionalProperties": false
},
"minItems": 1
},
"defaultBranch": {
"type": "string",
"description": "The default git branch that the repository is checked out. Inferred from the repo if missing."
},
"docsUrl": {
"type": "string",
"description": "The URL of the add-on's documentation"
},
"restricted": {
"type": "object",
"properties": {
"detailsUrl": {
"type": "string",
"description": "The URL of the documentation that explains how to grant access."
}
},
"description": "Mark the restricted access to any of the dependencies.",
"required": [
"detailsUrl"
]
},
"testStatus": {
"type": "object",
"properties": {
"badge": {
"type": "string",
"description": "An url pointing to a workflow status badge. How to get the badge for a repo hosted on Github: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge#using-the-workflow-file-name"
}
}
}
},
"additionalProperties": false,
"required": [
"name",
"repo",
"kind",
"tags",
"releases",
"description",
"docsUrl"
]
},
"description": "A list of applications contributed by the organization."
}
},
"required": [
"name",
"description",
"apps"
],
"additionalProperties": false
}