Microsoft.PowerShell.Crescendo.Schema.json

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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
{
  "definitions": {
    "parameter": {
      "definition": "The description of a parameter.",
      "required": ["ParameterType","Name","OriginalName" ],
      "properties": {
        "ParameterType": {
          "type": "string",
          "description": "This the type of the parameter. It should represent an actual type."
        },
        "Position": {
          "type": "integer",
          "description": "The position of the parameter."
        },
        "Name": {
          "type": "string",
          "description": "The name of the parameter that PowerShell will use. If NoGap is used, include the separator in the name. 'parameter=' for parameter=value"
        },
        "OriginalName": {
          "type": "string",
          "description": "The original parameter name used by the negative command."
        },
        "OriginalText": {
          "type": "string",
          "description": "The original help text for the native command parameter."
        },
        "Description": {
          "type": "string",
          "description": "The description of the parameter, this will be used by help."
        },
        "DefaultValue": {
          "type": "string",
          "description": "The default value for the parameter."
        },
        "DefaultMissingValue": {
          "type": "string",
          "description": "The default value provided if the parameter is not used"
        },
        "AdditionalParameterAttributes": {
          "type": "array",
          "description": "Additional parameter attributes used by PowerShell. This will take the form of a standard script parameter attribute.",
          "items": {
            "type": "string"
          }
        },
        "Mandatory": {
          "type": "boolean",
          "description": "A boolean indicating whether this parameter is mandatory."
        },
        "ParameterSetName": {
          "type": "array",
          "description": "The names of the parameter set for this parameter.",
          "items": {
            "type": "string"
          }
        },
        "Aliases": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of aliases for the cmdlet."
        },
        "OriginalPosition": {
          "type": "integer",
          "description": "The original parameter position for the native executable. This is used to properly order parameters when calling the native command."
        },
        "ValueFromPipeline": {
          "type": "boolean",
          "description": "The value for this parameter is taken from the pipeline."
        },
        "NoGap": {
          "type": "boolean",
          "description": "When constructing the native parameter and value do not separate with a space. Used for native parameters that look like parameter=value"
        },
        "ValueFromPipelineByPropertyName": {
          "type": "boolean",
          "description": "When are assigning a value to the parameter from a piped object, use the same property as the parameter name."
        },
        "ValueFromRemainingArguments": {
          "type": "boolean",
          "description": "Assign the remaining values to the parameter."
        }
      }
    },
    "command": {
      "description": "A collection of Crescendo configurations",
      "required": [ "Verb", "Noun", "OriginalName" ],
      "properties": {
        "Verb": {
          "type": "string",
          "enum": [
            "Add","Approve","Assert",
            "Backup","Block","Build",
            "Checkpoint","Clear","Close","Compare","Complete","Compress","Confirm","Connect","Convert","ConvertFrom","ConvertTo","Copy",
            "Debug","Deny","Deploy","Disable","Disconnect","Dismount",
            "Edit","Enable","Enter","Exit","Expand","Export",
            "Find","Format",
            "Get","Grant","Group",
            "Hide",
            "Import","Initialize","Install","Invoke",
            "Join",
            "Limit","Lock",
            "Measure","Merge","Mount","Move",
            "New",
            "Open","Optimize","Out",
            "Ping","Pop","Protect","Publish","Push",
            "Read","Receive","Redo","Register","Remove","Rename","Repair","Request","Reset","Resize","Resolve","Restart","Restore","Resume","Revoke",
            "Save","Search","Select","Send","Set","Show","Skip","Split","Start","Step","Stop","Submit","Suspend","Switch","Sync",
            "Test","Trace",
            "Unblock","Undo","Uninstall","Unlock","Unprotect","Unpublish","Unregister","Update","Use",
            "Wait","Watch","Write"
          ],
          "description" : "The verb of the cmdlet."
        },
        "Elevation": {
          "type": "object",
          "description": "When privilege elevation is required to run the command. Provide ElevationCommand and optional arguments.",
          "required": ["Command"],
          "properties": {
            "Command": {
              "type": "string",
              "description": "The command which performs the elevation. Windows elevation may be done with the built-in function Invoke-WindowsNativeAppWithElevation."
            },
            "Arguments": {
              "type": "array",
              "items": { "$ref": "#/definitions/parameter" },
              "description": "Additional arguments required by the elevation command."
            }
          }
        },
        "Noun": {
          "type": "string",
          "description" : "The noun of the cmdlet"
        },
        "Platform": {
          "type": "array",
          "minItems": 1,
          "maxItems": 3,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "enum": [ "Windows", "Linux", "MacOS" ]
          },
          "description" : "The platform where the function will run, this may be 'Windows','Linux', or 'MacOS' in any combination. The default is all three values."
        },
        "OriginalName": {
          "type": "string",
          "description" : "The native command to be called by the function."
        },
 
        "OutputHandlers": {
          "type": "array",
          "description": "Converts the text output of the native command into an object. Each output handler is associated with a parameter set name.",
          "items": {
            "type": "object",
            "required": ["ParameterSetName", "Handler" ],
            "properties": {
              "ParameterSetName": {
                "type": "string",
                "description": "The name of the parameter set which will use the handler."
              },
              "Handler": {
                "type": "string",
                "description": "This is the code which converts the output to objects"
              },
              "HandlerType": {
                "type": "string",
                "enum": ["Inline", "Function","Script"],
                "description": "The type of handler, by default this is 'Inline'"
 
              },
              "StreamOutput": {
                "type": "boolean",
                "description": "When used, output will be piped as a stream to the output handler."
              }
            }
          }
        },
 
        "OriginalCommandElements": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Additional elements to be added to the invocation. This is for arguments provided to a Native application which are not part of the parameters."
        },
        "Aliases": {
          "type": "array",
          "description" : "Aliases to the function that will be created",
          "items": {
            "type": "string"
          }
        },
        "DefaultParameterSetName": {
          "type": "string",
          "description": "The default parameter set name for the function"
 
        },
        "ConfirmImpact": {
          "type": "string",
          "enum": ["None", "Low","Medium","High"],
          "description": "A string indicating the value of Confirm Impact. If not present, this attribute will not be added to the cmdlet declaration."
        },
        "SupportsShouldProcess": {
          "type": "boolean",
          "description": "A boolean indicating whether this command supports ShouldProcess."
        },
        "SupportsTransactions": {
          "type": "boolean",
          "description": "A boolean indicating whether this command supports transactions."
        },
        "Description": {
          "description": "The description of the cmdlet.",
          "type": "string"
        },
        "Usage": {
          "description": "Information which explains how to use this command.",
          "type": "object",
          "required": [ "Synopsis" ],
          "properties": {
            "Synopsis": {
              "description": "The synopsis on how to use this command.",
              "type": "string"
            },
            "SupportsFlags": {
              "description": "Unused",
              "type": "boolean"
            },
            "HasOptions": {
              "description": "Unused",
              "type": "boolean"
            },
            "OriginalText": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The original text for the command help. Usually generated by command -?"
            }
          }
        },
        "Parameters": {
          "type": "array",
          "description": "The parameters for the function.",
          "items": {
            "type": "object",
            "required": ["ParameterType", "Name", "OriginalName" ],
            "properties": {
              "ParameterType": {
                "type": "string",
                "description": "This the type of the parameter. It should represent an actual type."
              },
              "Position": {
                "type": "integer",
                "description": "The position of the parameter."
              },
              "Name": {
                "description": "The name of the parameter.",
                "type": "string"
              },
              "OriginalName": {
                "description": "The name of the parameter used by the native executable. This can be null.",
                "type": "string"
              },
              "OriginalText": {
                "description": "The original text for the native parameter",
                "type": "string"
              },
              "Description": {
                "description": "The description of the parameter to be used in help.",
                "type": "string"
              },
              "DefaultValue": {
                "type": "string",
                "description": "The default value for this parameter."
              },
              "DefaultMissingValue": {
                "type": "string",
                "description": "The default value for this parameter if the parameter is not present (or is a switch parameter)."
              },
              "AdditionalParameterAttributes": {
                "description": "Additional parameter attributes. These should take the form of [ValidateNotNullOrEmpty()], etc.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "Mandatory": {
                "description": "A boolean indicating whether this parameter is mandatory.",
                "type": "boolean"
              },
              "ParameterSetName": {
                "description": "The parameter set name for this parameter.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "Aliases": {
                "description": "The parameter alias.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "OriginalPosition": {
                "description": "The position of the parameter for the native executable.",
                "type": "integer"
              },
              "ValueFromPipeline": {
                "description": "A boolean indicating whether this parameter accepts piped input.",
                "type": "boolean"
              },
              "NoGap": {
                "description": "A boolean indicating whether the constructed parameter should have a gap. This is for parameters which have the shape of parameter=value",
                "type": "boolean"
              },
              "ValueFromPipelineByPropertyName": {
                "description": "A boolean indicating whether this parameter accepts piped input which binds to a property name.",
                "type": "boolean"
              },
              "ValueFromRemainingArguments": {
                "description": "A boolean indicating whether this parameter gets its value from the remaining arguments.",
                "type": "boolean"
              }
            }
          }
        },
        "Examples": {
          "description": "Examples for the command.",
          "type": "array",
          "items": {
            "type": "object",
            "required": [ "Command", "Description" ],
            "properties": {
              "Command": {
                "description": "The command for the example.",
                "type": "string"
              },
              "OriginalCommand": {
                "description": "The original command for the example.",
                "type": "string"
              },
              "Description": {
                "description": "The description of the example.",
                "type": "string"
              }
            }
          }
        },
        "OriginalText": {
          "description": "The original help text of the native command",
          "type": "string"
        },
        "HelpLinks": {
          "description": "Help links for the command",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "NoInvocation": {
          "type":"boolean",
          "description": "This option returns the arguments which would be sent to the native executable. If used, the native application will not be invoked."
        }
      },
      "additionalProperties": false
    }
  },
  "type": "object",
  "$id": "https://microsoft.com/powershell/crescendo",
  "title": "JSON schema for PowerShell Crescendo files",
  "properties": {
    "$schema": {
      "type": "string"
    },
    "Commands":{
      "description": "The Crescendo command definitions.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/command"
      }
    }
  }
}