external help file | online version | schema |
---|---|---|
PSSwagger-help.xml |
2.0.0 |
Creates PowerShell Metadata json file with PowerShell Extensions for the specified Swagger document.
New-PSSwaggerMetadataFile [-SpecificationPath] <String> [-Force] [-WhatIf] [-Confirm]
Creates PowerShell Metadata json file with PowerShell Extensions for the specified Swagger document. This file can be used to customize the PowerShell specific metadata like cmdlet name, parameter name, output format views, code generation settings, PowerShell Module metadata and other related metadata. PowerShell Metadata file name for <SwaggerSpecFileName>.json is <SwaggerSpecFileName>.psmeta.json. This <SwaggerSpecFileName>.psmeta.json file gets created under the same location as the specified swagger document path.
New-PSSwaggerMetadataFile -SpecificationPath 'C:\SwaggerSpecs\BatchManagement.json'
Generates 'C:\SwaggerSpecs\BatchManagement.psmeta.json' file with PowerShell extensions for customizing the PowerShell related metadata.
New-PSSwaggerMetadataFile -SpecificationPath 'C:\SwaggerSpecs\BatchManagement.json' -Force
Regenerates 'C:\SwaggerSpecs\BatchManagement.psmeta.json' file with PowerShell extensions for customizing the PowerShell related metadata.
Full Path to a Swagger based JSON spec.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
To replace the existing PowerShell Metadata file.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False