platyPS
platyPS copied to clipboard
Update the YAML schema
PR Summary
Updated the schema as per the discussion
PR Context
parameterItems' properties:
- summary: It has not been used anywhere and can be deleted.
- parameterValueGroup: accepted values (it is also in PlatyPS-MamlParameter.cs)
- valueFrom: I cannot find an example with this, but this page may be related, see the last parameter. It is a defined Property/YamlMember but has not been used in the code, while it is in the powershell template. But AzureCLI has it, which contains a command, the output of running this command will be accepted values (in other words, the output of this 'valueFrom command' should be the acceptable value of the parameter); if PowerShell does not need it, we can consider to remove it.
- I removed the
summaryproperty. - Are you sure
parameterValueGroupis used for accepted values? From the link you provided I could not infer that. -
valueFromseems like it is accepted values. Example:Authenticationparameter here: https://docs.microsoft.com/en-us/powershell/module/cimcmdlets/new-cimsession?view=powershell-7.2#parameters
@adityapatwardhan
- parameterValueGroup
I tested this and it is the accepted values. I can't find anything that uses valueFrom.
I am pushing a change to remove summary and valueFrom. We added parameterSetName to capture the string which has the list of parameter sets the parameter belongs to.