Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support for 1.2 Schema Additions #2028

Merged
merged 19 commits into from
Apr 1, 2022
Merged

Support for 1.2 Schema Additions #2028

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0f64c0c
add proposed schema changes for 1.2
Mar 3, 2022
ec39660
make adjustments to changes
ryfu-msft Mar 4, 2022
c6eee67
update DefaultLocale
ryfu-msft Mar 4, 2022
71354e2
add initial schema support for 1.2
Mar 8, 2022
9ddec45
fix build errors
Mar 15, 2022
5470c1c
add tests for 1.2 schema
Mar 17, 2022
e5e0664
finalize schema changes
Mar 17, 2022
d2d50bd
update spelling
Mar 17, 2022
9dd5764
increase documentation limit to 256 and fix grammar
Mar 18, 2022
e8919c1
edit bit flags and move dir creation of portable app dir
Mar 28, 2022
520c4b8
add experimental feature description for portableinstall
Mar 28, 2022
f7013f3
address initial feedback
Mar 29, 2022
efcec3e
resolve PR feedback
Mar 30, 2022
b7e2e13
revert settings md
Mar 30, 2022
734a6ce
remove protocol regex
Mar 30, 2022
d140507
resolve PR comments
Mar 31, 2022
74c89dd
change portableAppRoot to path type
Apr 1, 2022
223a169
spacing
Apr 1, 2022
93a409c
convert to utf16 path
Apr 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/spelling/expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ powertoys
pri
processthreads
productcode
PROGRAMFILES
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
pscustomobject
pseudocode
psm
Expand Down
32 changes: 32 additions & 0 deletions schemas/JSON/manifests/v1.2.0/manifest.defaultLocale.1.2.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,21 @@
"description": "The agreement URL."
}
}
},
"Documentation": {
"type": "object",
"properties": {
"DocumentDescription": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 100,
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
"description": "The description of the documentation for providing software guides such as manuals and troubleshooting URLs."
},
"DocumentUrl": {
"$ref": "#/definitions/Url",
"description": "The documentation URL."
}
}
}
},
"type": "object",
Expand Down Expand Up @@ -154,6 +169,23 @@
"$ref": "#/definitions/Url",
"description": "The package release notes url"
},
"PurchaseUrl": {
"$ref": "#/definitions/Url",
"description": "The purchase url for acquiring entitlement for the package."
},
"InstallationNotes": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 240,
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
"description": "The notes displayed to the user upon completion of a package installation."
},
"Documentations": {
"type": [ "array", "null" ],
"items": {
"$ref": "#/definitions/Documentation"
},
"maxItems": 256
},
"ManifestType": {
"type": "string",
"default": "defaultLocale",
Expand Down
65 changes: 50 additions & 15 deletions schemas/JSON/manifests/v1.2.0/manifest.installer.1.2.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@
"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])){0,3}$",
"description": "The installer minimum operating system version"
},
"Url": {
"type": [ "string", "null" ],
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
"maxLength": 2048,
"description": "Url type"
},
"InstallerType": {
"type": [ "string", "null" ],
"enum": [
Expand All @@ -63,6 +69,17 @@
],
"description": "Enumeration of supported installer types. InstallerType is required in either root level or individual Installer level"
},
"Architecture": {
"type": "string",
"enum": [
"x86",
"x64",
"arm",
"arm64",
"neutral"
],
"description": "The installer target architecture"
},
"Scope": {
"type": [ "string", "null" ],
"enum": [
Expand Down Expand Up @@ -178,8 +195,13 @@
"cancelledByUser",
"alreadyInstalled",
"downgrade",
"blockedByPolicy"
"blockedByPolicy",
"custom"
]
},
"ReturnResponseUrl": {
"$ref": "#/definitions/Url",
"description": "The return response url to provide additional guidance for expected return codes"
}
}
},
Expand Down Expand Up @@ -209,7 +231,7 @@
"type": [ "array", "null" ],
"items": {
"type": "string",
"pattern": "^[a-z][-a-z0-9\\.\\+]*$",
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
"pattern": "^[a-z0-9][-a-z0-9\\.\\+]*$",
"maxLength": 2048
},
"maxItems": 16,
Expand All @@ -223,7 +245,7 @@
"pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
"maxLength": 64
},
"maxItems": 256,
"maxItems": 512,
"uniqueItems": true,
"description": "List of file extensions the package could support"
},
Expand Down Expand Up @@ -370,6 +392,10 @@
"type": [ "boolean", "null" ],
"description": "Indicates whether the installer should be pinned by default from upgrade"
},
"DisplayInstallWarnings": {
"type": [ "boolean", "null" ],
"description": "Indicates whether winget should display a warning message if the install or upgrade is known to interfere with running applications."
},
"UnsupportedOSArchitectures": {
"type": [ "array", "null" ],
"uniqueItems": true,
Expand All @@ -385,6 +411,19 @@
},
"description": "List of OS architectures the installer does not support"
},
"UnsupportedArguments": {
"type": [ "array", "null" ],
"uniqueItems": true,
"items": {
"type": "string",
"title": "UnsupportedArgument",
"enum": [
"log",
"location"
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
]
},
"description": "List of winget arguments the installer does not support"
},
"AppsAndFeaturesEntry": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -449,15 +488,7 @@
"$ref": "#/definitions/MinimumOSVersion"
},
"Architecture": {
"type": "string",
"enum": [
"x86",
"x64",
"arm",
"arm64",
"neutral"
],
"description": "The installer target architecture"
"$ref": "#/definitions/Architecture"
},
"InstallerType": {
"$ref": "#/definitions/InstallerType"
Expand All @@ -466,9 +497,7 @@
"$ref": "#/definitions/Scope"
},
"InstallerUrl": {
"type": "string",
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
"maxLength": 2048,
"$ref": "#/definitions/Url",
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
"description": "The installer Url"
},
"InstallerSha256": {
Expand Down Expand Up @@ -535,6 +564,9 @@
"RequireExplicitUpgrade": {
"$ref": "#/definitions/RequireExplicitUpgrade"
},
"DisplayInstallWarnings": {
"$ref": "#/definitions/DisplayInstallWarnings"
},
"UnsupportedOSArchitectures": {
"$ref": "#/definitions/UnsupportedOSArchitectures"
},
Expand Down Expand Up @@ -641,6 +673,9 @@
"ElevationRequirement": {
"$ref": "#/definitions/ElevationRequirement"
},
"DisplayInstallWarnings": {
"$ref": "#/definitions/DisplayInstallWarnings"
},
"Installers": {
"type": "array",
"items": {
Expand Down
32 changes: 32 additions & 0 deletions schemas/JSON/manifests/v1.2.0/manifest.locale.1.2.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,21 @@
"description": "The agreement URL."
}
}
},
"Documentation": {
"type": "object",
"properties": {
"DocumentDescription": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 100,
"description": "The description of the documentation for providing software guides such as manuals and troubleshooting URLs."
},
"DocumentUrl": {
"$ref": "#/definitions/Url",
"description": "The documentation URL."
}
}
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
}
},
"type": "object",
Expand Down Expand Up @@ -149,6 +164,23 @@
"$ref": "#/definitions/Url",
"description": "The package release notes url"
},
"PurchaseUrl": {
"$ref": "#/definitions/Url",
"description": "The purchase url for acquiring entitlement for the package."
},
"InstallationNotes": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 240,
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
"description": "The notes displayed to the user upon completion of a package installation."
},
"Documentations": {
"type": [ "array", "null" ],
"items": {
"$ref": "#/definitions/Documentation"
},
"maxItems": 256
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
},
"ManifestType": {
"type": "string",
"default": "locale",
Expand Down
85 changes: 70 additions & 15 deletions schemas/JSON/manifests/v1.2.0/manifest.singleton.1.2.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,21 @@
}
}
},
"Documentation": {
"type": "object",
"properties": {
"DocumentDescription": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 100,
"description": "The description of the documentation for providing software guides such as manuals and troubleshooting URLs."
},
"DocumentUrl": {
"$ref": "#/definitions/Url",
"description": "The documentation URL."
}
}
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
},
"Channel": {
"type": [ "string", "null" ],
"minLength": 1,
Expand Down Expand Up @@ -96,6 +111,17 @@
],
"description": "Enumeration of supported installer types. InstallerType is required in either root level or individual Installer level"
},
"Architecture": {
"type": "string",
"enum": [
"x86",
"x64",
"arm",
"arm64",
"neutral"
],
"description": "The installer target architecture"
},
"Scope": {
"type": [ "string", "null" ],
"enum": [
Expand Down Expand Up @@ -211,8 +237,13 @@
"cancelledByUser",
"alreadyInstalled",
"downgrade",
"blockedByPolicy"
"blockedByPolicy",
"custom"
]
},
"ReturnResponseUrl": {
"$ref": "#/definitions/Url",
"description": "The return response url to provide additional guidance for expected return codes"
}
}
},
Expand Down Expand Up @@ -242,7 +273,7 @@
"type": [ "array", "null" ],
"items": {
"type": "string",
"pattern": "^[a-z][-a-z0-9\\.\\+]*$",
"pattern": "^[a-z0-9][-a-z0-9\\.\\+]*$",
"maxLength": 2048
},
"maxItems": 16,
Expand All @@ -256,7 +287,7 @@
"pattern": "^[^\\\\/:\\*\\?\"<>\\|\\x01-\\x1f]+$",
"maxLength": 64
},
"maxItems": 256,
"maxItems": 512,
"uniqueItems": true,
"description": "List of file extensions the package could support"
},
Expand Down Expand Up @@ -402,6 +433,10 @@
"type": [ "boolean", "null" ],
"description": "Indicates whether the installer should be pinned by default from upgrade"
},
"DisplayInstallWarnings": {
"type": [ "boolean", "null" ],
"description": "Indicates whether winget should display a warning message if the install or upgrade is known to interfere with running applications."
},
"UnsupportedOSArchitectures": {
"type": [ "array", "null" ],
"uniqueItems": true,
Expand All @@ -417,6 +452,19 @@
},
"description": "List of OS architectures the installer does not support"
},
"UnsupportedArguments": {
"type": [ "array", "null" ],
"uniqueItems": true,
"items": {
"type": "string",
"title": "UnsupportedArgument",
"enum": [
"log",
"location"
]
},
"description": "List of winget arguments the installer does not support"
},
"AppsAndFeaturesEntry": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -481,15 +529,7 @@
"$ref": "#/definitions/MinimumOSVersion"
},
"Architecture": {
"type": "string",
"enum": [
"x86",
"x64",
"arm",
"arm64",
"neutral"
],
"description": "The installer target architecture"
"$ref": "#/definitions/Architecture"
},
"InstallerType": {
"$ref": "#/definitions/InstallerType"
Expand All @@ -498,9 +538,7 @@
"$ref": "#/definitions/Scope"
},
"InstallerUrl": {
"type": "string",
"pattern": "^([Hh][Tt][Tt][Pp][Ss]?)://.+$",
"maxLength": 2048,
"$ref": "#/definitions/Url",
"description": "The installer Url"
},
"InstallerSha256": {
Expand Down Expand Up @@ -691,6 +729,23 @@
"$ref": "#/definitions/Url",
"description": "The package release notes url"
},
"PurchaseUrl": {
"$ref": "#/definitions/Url",
"description": "The purchase url for acquiring entitlement for the package."
},
"InstallationNotes": {
"type": [ "string", "null" ],
"minLength": 1,
"maxLength": 240,
"description": "The notes displayed to the user upon completion of a package installation."
},
"Documentations": {
"type": [ "array", "null" ],
"items": {
"$ref": "#/definitions/Documentation"
},
"maxItems": 256
ryfu-msft marked this conversation as resolved.
Show resolved Hide resolved
},
"Channel": {
"$ref": "#/definitions/Channel"
},
Expand Down
Loading