Skip to content
This repository was archived by the owner on Sep 27, 2019. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Changelog

## v0.3.0 - 2017-09-29
- Add support for generating proper output type for the Swagger operations with x-ms-pageable extension (#342)
- Add support for parameter type references to enum definitions (#341)
- Add support for AdditionalProperties Json schema with array type (#339)
- Generate SYNOPSIS help content in the generated cmdlets (#337)
- Rename IsOSX to IsMacOS after breaking change in PowerShell 6.0.0-beta.7 to fix #333 (#334)
- Resolve UnableToExtractDetailsFromSdkAssembly error when OperationType in OperationId conflicts with Definition name (#332)
- Change warninglevel to 1 for generating assembly for Azure Swagger specs (#331)
- Write exceptions in generated commands (#324)
- Add New-ServiceClient utility function in generated module to enable mock testing (#325)
- Add support for generating PowerShell cmdlets using pre-built SDK assembly and specification (#321)
- Add support for predefined header values (#320)
- Removing the langversion from CSC parameters as latest is the default language version (#318)
- Support latest version of AutoRest in PSSwagger (#313)
- Add support for generating the C# SDK assembly using CSC.exe on Windows PS (#312)
- Support default and customizable header comment for the PSSwagger generated files (#310)
- Ensure $oDataQuery expression is generated properly when a global parameter is referenced in more than one swagger operations with or without x-ms-odata extension (#307)
- Fix localization error in SwaggerUtil for PluralizationService (#303)
- Update Readme and fix an error related to importing the PSSwaggerUtility module (#300)
- Support custom x-ms-pageable\NextLinkName field name (#294)

## v0.2.0 - 2017-08-15

* First preview release

First preview release of PSSwagger and PSSwaggerUtility modules. While the goal is to support all web APIs, scenarios are focused on Microsoft Azure for this first release.

* Supported Scenarios
- From an Open API v2 specification, generate a PowerShell module using [Azure AutoRest](https://github.com/azure/autorest)
- Generating modules is only supported on PowerShell 5.1
- Customize the generation process with Open API v2 extensions in either the same specification as your web API or a separate file
- Rename automatically generated cmdlets
- Flatten complex parameters without flattening the underlying .NET API
- Generated modules support PowerShell on Windows (PowerShell 4 or greater) or PowerShell Core on Windows, Linux or Mac
- Compile the underlying .NET API before you publish your module or compile it on-the-fly on your end-user's machine
- Debugging symbols for underlying .NET API available
- Currently supported authentication schemes:
- Basic authentication, with or without challenge
- API key based authentication
- No authentication
- Authentication using AzureRM.Profile
8 changes: 6 additions & 2 deletions PSSwagger/PSSwagger.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ GUID = '6c925abf-49bc-49f4-8a47-12b95c9a8b37'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'PowerShell module with commands for generating the PowerShell Cmdlets using Swagger based specifications.'
Description = @'
The PowerShell cmdlet generator from OpenAPI (f.k.a Swagger) specification.
Please refer to https://github.com/PowerShell/PSSwagger/blob/developer/README.md for more details.
'@
FunctionsToExport = @(
'New-PSSwaggerModule',
'New-PSSwaggerMetadataFile'
Expand Down Expand Up @@ -38,11 +41,12 @@ PrivateData = @{
PSData = @{
Tags = @('Azure',
'Swagger',
'OpenApi',
'PSEdition_Desktop')
ProjectUri = 'https://github.com/PowerShell/PSSwagger'
LicenseUri = 'https://github.com/PowerShell/PSSwagger/blob/master/LICENSE'
ReleaseNotes = @'
- Initial development release
Please refer to https://github.com/PowerShell/PSSwagger/blob/developer/CHANGELOG.md
'@
}
}
Expand Down
10 changes: 7 additions & 3 deletions PSSwagger/PSSwaggerUtility/PSSwaggerUtility.psd1
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
@{
RootModule = 'PSSwaggerUtility.psm1'
ModuleVersion = '0.2.0'
ModuleVersion = '0.3.0'
GUID = '49b0a58f-c657-49a1-8c16-e48031f5e2e4'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'PowerShell module with PSSwagger common helper functions'
Description = @'
PowerShell module with PSSwagger common helper functions.
Please refer to https://github.com/PowerShell/PSSwagger/blob/developer/README.md for more details.
'@
FunctionsToExport = @('Start-PSSwaggerJobHelper',
'New-PSSwaggerClientTracing',
'Register-PSSwaggerClientTracing',
Expand All @@ -27,14 +30,15 @@ AliasesToExport = ''
PrivateData = @{
PSData = @{
Tags = @('Swagger',
'OpenApi',
'PSEdition_Desktop',
'PSEdition_Core',
'Linux',
'Mac')
ProjectUri = 'https://github.com/PowerShell/PSSwagger'
LicenseUri = 'https://github.com/PowerShell/PSSwagger/blob/master/LICENSE'
ReleaseNotes = @'
- Initial development release
Please refer to https://github.com/PowerShell/PSSwagger/blob/developer/CHANGELOG.md
'@
}
}
Expand Down