Skip to content

Commit 30376fb

Browse files
authored
Create schema 1.12.0 folder (microsoft#5944)
<!-- To check a checkbox place an "x" between the brackets. e.g: [x] --> - [x] I have signed the [Contributor License Agreement](https://cla.opensource.microsoft.com/microsoft/winget-pkgs). - [ ] I have updated the [Release Notes](../doc/ReleaseNotes.md). - No functional changes - [ ] This pull request is related to an issue. Since the 1.12 release is close to official support and the manifests have been locked in, the final versions are being copied to the v1.12.0 folder so that the aka.ms links can be generated and tools like YamlCreate and others can reference them successfully ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/microsoft/winget-cli/pull/5944)
1 parent c089113 commit 30376fb

File tree

5 files changed

+2668
-0
lines changed

5 files changed

+2668
-0
lines changed
Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
{
2+
"$id": "https://aka.ms/winget-manifest.defaultlocale.1.12.0.schema.json",
3+
"$schema": "http://json-schema.org/draft-07/schema#",
4+
"description": "A representation of a multiple-file manifest representing a default app metadata in the OWC. v1.12.0",
5+
"definitions": {
6+
"Url": {
7+
"type": [ "string", "null" ],
8+
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
9+
"maxLength": 2048,
10+
"description": "Optional Url type"
11+
},
12+
"Tag": {
13+
"type": [ "string", "null" ],
14+
"minLength": 1,
15+
"maxLength": 40,
16+
"description": "Package moniker or tag"
17+
},
18+
"Agreement": {
19+
"type": "object",
20+
"properties": {
21+
"AgreementLabel": {
22+
"type": [ "string", "null" ],
23+
"minLength": 1,
24+
"maxLength": 100,
25+
"description": "The label of the Agreement. i.e. EULA, AgeRating, etc. This field should be localized. Either Agreement or AgreementUrl is required. When we show the agreements, we would Bold the AgreementLabel"
26+
},
27+
"Agreement": {
28+
"type": [ "string", "null" ],
29+
"minLength": 1,
30+
"maxLength": 10000,
31+
"description": "The agreement text content."
32+
},
33+
"AgreementUrl": {
34+
"$ref": "#/definitions/Url",
35+
"description": "The agreement URL."
36+
}
37+
}
38+
},
39+
"Documentation": {
40+
"type": "object",
41+
"properties": {
42+
"DocumentLabel": {
43+
"type": [ "string", "null" ],
44+
"minLength": 1,
45+
"maxLength": 100,
46+
"description": "The label of the documentation for providing software guides such as manuals and troubleshooting URLs."
47+
},
48+
"DocumentUrl": {
49+
"$ref": "#/definitions/Url",
50+
"description": "The documentation URL."
51+
}
52+
}
53+
},
54+
"Icon": {
55+
"type": "object",
56+
"properties": {
57+
"IconUrl": {
58+
"type": "string",
59+
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
60+
"maxLength": 2048,
61+
"description": "The url of the hosted icon file"
62+
},
63+
"IconFileType": {
64+
"type": "string",
65+
"enum": [
66+
"png",
67+
"jpeg",
68+
"ico"
69+
],
70+
"description": "The icon file type"
71+
},
72+
"IconResolution": {
73+
"type": [ "string", "null" ],
74+
"enum": [
75+
"custom",
76+
"16x16",
77+
"20x20",
78+
"24x24",
79+
"30x30",
80+
"32x32",
81+
"36x36",
82+
"40x40",
83+
"48x48",
84+
"60x60",
85+
"64x64",
86+
"72x72",
87+
"80x80",
88+
"96x96",
89+
"256x256"
90+
],
91+
"description": "Optional icon resolution"
92+
},
93+
"IconTheme": {
94+
"type": [ "string", "null" ],
95+
"enum": [
96+
"default",
97+
"light",
98+
"dark",
99+
"highContrast"
100+
],
101+
"description": "Optional icon theme"
102+
},
103+
"IconSha256": {
104+
"type": [ "string", "null" ],
105+
"pattern": "^[A-Fa-f0-9]{64}$",
106+
"description": "Optional Sha256 of the icon file"
107+
}
108+
},
109+
"required": [
110+
"IconUrl",
111+
"IconFileType"
112+
]
113+
}
114+
},
115+
"type": "object",
116+
"properties": {
117+
"PackageIdentifier": {
118+
"type": "string",
119+
"pattern": "^[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}(\\.[^\\.\\s\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]{1,32}){1,7}$",
120+
"maxLength": 128,
121+
"description": "The package unique identifier"
122+
},
123+
"PackageVersion": {
124+
"type": "string",
125+
"pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
126+
"maxLength": 128,
127+
"description": "The package version"
128+
},
129+
"PackageLocale": {
130+
"type": "string",
131+
"default": "en-US",
132+
"pattern": "^([a-zA-Z]{2,3}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$",
133+
"maxLength": 20,
134+
"description": "The package meta-data locale"
135+
},
136+
"Publisher": {
137+
"type": "string",
138+
"minLength": 2,
139+
"maxLength": 256,
140+
"description": "The publisher name"
141+
},
142+
"PublisherUrl": {
143+
"$ref": "#/definitions/Url",
144+
"description": "The publisher home page"
145+
},
146+
"PublisherSupportUrl": {
147+
"$ref": "#/definitions/Url",
148+
"description": "The publisher support page"
149+
},
150+
"PrivacyUrl": {
151+
"$ref": "#/definitions/Url",
152+
"description": "The publisher privacy page or the package privacy page"
153+
},
154+
"Author": {
155+
"type": [ "string", "null" ],
156+
"minLength": 2,
157+
"maxLength": 256,
158+
"description": "The package author"
159+
},
160+
"PackageName": {
161+
"type": "string",
162+
"minLength": 2,
163+
"maxLength": 256,
164+
"description": "The package name"
165+
},
166+
"PackageUrl": {
167+
"$ref": "#/definitions/Url",
168+
"description": "The package home page"
169+
},
170+
"License": {
171+
"type": "string",
172+
"minLength": 3,
173+
"maxLength": 512,
174+
"description": "The package license"
175+
},
176+
"LicenseUrl": {
177+
"$ref": "#/definitions/Url",
178+
"description": "The license page"
179+
},
180+
"Copyright": {
181+
"type": [ "string", "null" ],
182+
"minLength": 3,
183+
"maxLength": 512,
184+
"description": "The package copyright"
185+
},
186+
"CopyrightUrl": {
187+
"$ref": "#/definitions/Url",
188+
"description": "The package copyright page"
189+
},
190+
"ShortDescription": {
191+
"type": "string",
192+
"minLength": 3,
193+
"maxLength": 256,
194+
"description": "The short package description"
195+
},
196+
"Description": {
197+
"type": [ "string", "null" ],
198+
"minLength": 3,
199+
"maxLength": 10000,
200+
"description": "The full package description"
201+
},
202+
"Moniker": {
203+
"$ref": "#/definitions/Tag",
204+
"description": "The most common package term"
205+
},
206+
"Tags": {
207+
"type": [ "array", "null" ],
208+
"items": {
209+
"$ref": "#/definitions/Tag"
210+
},
211+
"maxItems": 16,
212+
"uniqueItems": true,
213+
"description": "List of additional package search terms"
214+
},
215+
"Agreements": {
216+
"type": [ "array", "null" ],
217+
"items": {
218+
"$ref": "#/definitions/Agreement"
219+
},
220+
"maxItems": 128
221+
},
222+
"ReleaseNotes": {
223+
"type": [ "string", "null" ],
224+
"minLength": 1,
225+
"maxLength": 10000,
226+
"description": "The package release notes"
227+
},
228+
"ReleaseNotesUrl": {
229+
"$ref": "#/definitions/Url",
230+
"description": "The package release notes url"
231+
},
232+
"PurchaseUrl": {
233+
"$ref": "#/definitions/Url",
234+
"description": "The purchase url for acquiring entitlement for the package."
235+
},
236+
"InstallationNotes": {
237+
"type": [ "string", "null" ],
238+
"minLength": 1,
239+
"maxLength": 10000,
240+
"description": "The notes displayed to the user upon completion of a package installation."
241+
},
242+
"Documentations": {
243+
"type": [ "array", "null" ],
244+
"items": {
245+
"$ref": "#/definitions/Documentation"
246+
},
247+
"maxItems": 256
248+
},
249+
"Icons": {
250+
"type": [ "array", "null" ],
251+
"items": {
252+
"$ref": "#/definitions/Icon"
253+
},
254+
"maxItems": 1024
255+
},
256+
"ManifestType": {
257+
"type": "string",
258+
"default": "defaultLocale",
259+
"const": "defaultLocale",
260+
"description": "The manifest type"
261+
},
262+
"ManifestVersion": {
263+
"type": "string",
264+
"default": "1.12.0",
265+
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
266+
"description": "The manifest syntax version"
267+
}
268+
},
269+
"required": [
270+
"PackageIdentifier",
271+
"PackageVersion",
272+
"PackageLocale",
273+
"Publisher",
274+
"PackageName",
275+
"License",
276+
"ShortDescription",
277+
"ManifestType",
278+
"ManifestVersion"
279+
]
280+
}

0 commit comments

Comments
 (0)