winget-cli

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

packages.schema.1.0.json (3010B)


      1 {
      2   "$id": "https://aka.ms/winget-packages.schema.1.0.json",
      3   "$schema": "https://json-schema.org/draft/2019-09/schema#",
      4 
      5   "title": "winget Packages List Schema",
      6   "description": "Describes a list of packages for batch installs",
      7 
      8   "type": "object",
      9   "required": [ "WinGetVersion", "Sources" ],
     10   "additionalProperties": true,
     11 
     12   "properties": {
     13     "WinGetVersion": {
     14       "description": "Version of winget that generated this file",
     15       "type": "string",
     16       "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
     17     },
     18 
     19     "CreationDate": {
     20       "description": "Date when this list was generated (ex. 2021-05-16T22:24:39.287-00:00)",
     21       "type": "string",
     22       "format": "date-time"
     23     },
     24 
     25     "Sources": {
     26       "description": "Sources from which each package comes from",
     27       "type": "array",
     28 
     29       "items": {
     30         "description": "A source and the list of packages to install from it",
     31         "type": "object",
     32         "required": [ "SourceDetails", "Packages" ],
     33         "additionalProperties": true,
     34 
     35         "properties": {
     36           "SourceDetails": {
     37             "description": "Details about this source",
     38             "type": "object",
     39             "required": [ "Name", "Identifier", "Argument", "Type" ],
     40             "additionalProperties": true,
     41 
     42             "properties": {
     43               "Name": {
     44                 "description": "Name of the source",
     45                 "type": "string"
     46               },
     47 
     48               "Identifier": {
     49                 "description": "Identifier for the source",
     50                 "type": "string"
     51               },
     52 
     53               "Argument": {
     54                 "description": "Argument used to install the source",
     55                 "type": "string"
     56               },
     57 
     58               "Type": {
     59                 "description": "Type of the source",
     60                 "type": "string"
     61               }
     62             }
     63           },
     64 
     65           "Packages": {
     66             "description": "Packages installed from this source",
     67             "type": "array",
     68             "minItems": 1,
     69 
     70             "items": {
     71               "description": "A package to be installed from this source",
     72               "type": "object",
     73               "additionalProperties": true,
     74               "required": [ "Id" ],
     75               "properties": {
     76                 "Id": {
     77                   "description": "Package ID",
     78                   "type": "string"
     79                 },
     80 
     81                 "Version": {
     82                   "description": "Package version",
     83                   "type": "string"
     84                 },
     85 
     86                 "Channel": {
     87                   "description": "Package channel",
     88                   "type": "string"
     89                 },
     90 
     91                 "Scope": {
     92                   "description": "Required package scope",
     93                   "type": "string",
     94                   "enum": [
     95                     "user",
     96                     "machine"
     97                   ],
     98                   "default": "user"
     99                 }
    100               }
    101             }
    102           }
    103         }
    104       }
    105     }
    106   }
    107 }