Skip to content

Commit 10b7bcc

Browse files
authored
Add name/description to devbox json schema. (#2092)
## Summary The current JSON schema does not include the **name** and **description** fields. This update adds these fields as optional properties to the Devbox JSON schema. ## How was it tested? * Used an online JSON schema validator to ensure that the updated schema is valid. * Ensured that the schema allows optional name and description fields.
1 parent ef1e4c9 commit 10b7bcc

File tree

1 file changed

+52
-30
lines changed

1 file changed

+52
-30
lines changed

.schema/devbox.schema.json

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
"description": "The schema version of this devbox.json file.",
1010
"type": "string"
1111
},
12+
"name": {
13+
"description": "The name of the Devbox development environment.",
14+
"type": "string"
15+
},
16+
"description": {
17+
"description": "A description of the Devbox development environment.",
18+
"type": "string"
19+
},
1220
"packages": {
1321
"description": "Collection of packages to install",
1422
"oneOf": [
@@ -25,39 +33,53 @@
2533
"patternProperties": {
2634
".*": {
2735
"oneOf": [
28-
{
29-
"type": "object",
30-
"description": "Version number of the specified package in {\"version\": \"1.2.3\"} format.",
31-
"properties": {
32-
"version": {
33-
"type": "string",
34-
"description": "Version of the package"
35-
},
36-
"platforms": {
37-
"type": "array",
38-
"description": "Names of platforms to install the package on. This package will be skipped for any platforms not on this list",
39-
"items": {
40-
"enum": ["i686-linux", "aarch64-linux", "aarch64-darwin", "x86_64-darwin", "x86_64-linux", "armv7l-linux"]
36+
{
37+
"type": "object",
38+
"description": "Version number of the specified package in {\"version\": \"1.2.3\"} format.",
39+
"properties": {
40+
"version": {
41+
"type": "string",
42+
"description": "Version of the package"
43+
},
44+
"platforms": {
45+
"type": "array",
46+
"description": "Names of platforms to install the package on. This package will be skipped for any platforms not on this list",
47+
"items": {
48+
"enum": [
49+
"i686-linux",
50+
"aarch64-linux",
51+
"aarch64-darwin",
52+
"x86_64-darwin",
53+
"x86_64-linux",
54+
"armv7l-linux"
55+
]
56+
}
57+
},
58+
"excluded_platforms": {
59+
"type": "array",
60+
"description": "Names of platforms to exclude the package on",
61+
"items": {
62+
"enum": [
63+
"i686-linux",
64+
"aarch64-linux",
65+
"aarch64-darwin",
66+
"x86_64-darwin",
67+
"x86_64-linux",
68+
"armv7l-linux"
69+
]
70+
}
71+
},
72+
"glibc_patch": {
73+
"type": "boolean",
74+
"description": "Whether to patch glibc to the latest available version for this package"
75+
}
4176
}
4277
},
43-
"excluded_platforms": {
44-
"type": "array",
45-
"description": "Names of platforms to exclude the package on",
46-
"items": {
47-
"enum": ["i686-linux", "aarch64-linux", "aarch64-darwin", "x86_64-darwin", "x86_64-linux", "armv7l-linux"]
48-
}
49-
},
50-
"glibc_patch": {
51-
"type":"boolean",
52-
"description": "Whether to patch glibc to the latest available version for this package"
78+
{
79+
"type": "string",
80+
"description": "Version of the package to install."
5381
}
54-
}
55-
},
56-
{
57-
"type": "string",
58-
"description": "Version of the package to install."
59-
}
60-
]
82+
]
6183
}
6284
}
6385
}

0 commit comments

Comments
 (0)