Skip to content
This repository was archived by the owner on Sep 27, 2019. It is now read-only.

Add support for parameter type references to enum definitions. #341

Merged
merged 1 commit into from
Sep 22, 2017
Merged

Add support for parameter type references to enum definitions. #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
108 changes: 84 additions & 24 deletions PSSwagger/Definitions.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ function Get-SwaggerSpecDefinitionInfo
$FunctionDetails['ExpandedParameters'] = $ExpandedParameters

$DefinitionType = ""
$ValidateSet = $null
if ((Get-HashtableKeyCount -Hashtable $ParametersTable) -lt 1)
{
$GetDefinitionParameterType_params = @{
Expand All @@ -145,9 +146,12 @@ function Get-SwaggerSpecDefinitionInfo
ModelsNamespace = "$NameSpace.$Models"
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
}
$DefinitionType = Get-DefinitionParameterType @GetDefinitionParameterType_params
$TypeResult = Get-DefinitionParameterType @GetDefinitionParameterType_params
$DefinitionType = $TypeResult['ParameterType']
$ValidateSet = $TypeResult['ValidateSet']
}
$FunctionDetails['Type'] = $DefinitionType
$FunctionDetails['ValidateSet'] = $ValidateSet

if(-not $FunctionDetails.ContainsKey('IsUsedAs_x_ms_client_flatten'))
{
Expand Down Expand Up @@ -238,13 +242,20 @@ function Get-DefinitionParameters
$ValidateSetString = $null
$ParameterDescription = ''

$ParameterType = Get-DefinitionParameterType -ParameterJsonObject $ParameterJsonObject `
-DefinitionName $DefinitionName `
-ParameterName $ParameterName `
-DefinitionFunctionsDetails $DefinitionFunctionsDetails `
-ModelsNamespace "$NameSpace.Models" `
-ParametersTable $ParametersTable
$GetDefinitionParameterType_params = @{
ParameterJsonObject = $ParameterJsonObject
DefinitionName = $DefinitionName
ParameterName = $ParameterName
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ModelsNamespace = "$NameSpace.Models"
ParametersTable = $ParametersTable
}
$TypeResult = Get-DefinitionParameterType @GetDefinitionParameterType_params

$ParameterType = $TypeResult['ParameterType']
if($TypeResult['ValidateSet']) {
$ValidateSetString = "'$($TypeResult['ValidateSet'] -join "', '")'"
}
if ((Get-Member -InputObject $JsonDefinitionItemObject.Value -Name 'Required') -and
$JsonDefinitionItemObject.Value.Required -and
($JsonDefinitionItemObject.Value.Required -contains $ParameterName) )
Expand Down Expand Up @@ -320,20 +331,26 @@ function Get-DefinitionParameterType
$DefinitionTypeNamePrefix = "$ModelsNamespace."

$ParameterType = $null
$ValidateSet = $null

if ((Get-Member -InputObject $ParameterJsonObject -Name 'Type') -and $ParameterJsonObject.Type)
{
$ParameterType = $ParameterJsonObject.Type

# When a definition property has single enum value, AutoRest doesn't generate an enum type.
if ((Get-Member -InputObject $ParameterJsonObject -Name 'Enum') -and
($ParameterJsonObject.Enum.Count -gt 1) -and
(Get-Member -InputObject $ParameterJsonObject -Name 'x-ms-enum') -and
$ParameterJsonObject.'x-ms-enum' -and
(-not (Get-Member -InputObject $ParameterJsonObject.'x-ms-enum' -Name 'modelAsString') -or
($ParameterJsonObject.'x-ms-enum'.modelAsString -eq $false)))
$ParameterJsonObject.Enum -and ($ParameterJsonObject.Enum.Count -gt 1))
{
$ParameterType = $DefinitionTypeNamePrefix + (Get-CSharpModelName -Name $ParameterJsonObject.'x-ms-enum'.Name)
if ((Get-Member -InputObject $ParameterJsonObject -Name 'x-ms-enum') -and
$ParameterJsonObject.'x-ms-enum' -and
(-not (Get-Member -InputObject $ParameterJsonObject.'x-ms-enum' -Name 'modelAsString') -or
($ParameterJsonObject.'x-ms-enum'.modelAsString -eq $false)))
{
$ParameterType = $DefinitionTypeNamePrefix + (Get-CSharpModelName -Name $ParameterJsonObject.'x-ms-enum'.Name)
}
else {
$ValidateSet = $ParameterJsonObject.Enum | ForEach-Object {$_ -replace "'", "''"}
}
}
# Use the format as parameter type if that is available as a type in PowerShell
elseif ((Get-Member -InputObject $ParameterJsonObject -Name 'Format') -and
Expand All @@ -350,8 +367,17 @@ function Get-DefinitionParameterType
$ParameterJsonObject.Items.'$ref')
{
$ReferenceTypeValue = $ParameterJsonObject.Items.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$ParameterType = $DefinitionTypeNamePrefix + "$ReferenceTypeName[]"
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$ParameterType = $ResolvedResult.ParameterType + '[]'
if($ResolvedResult.ValidateSet) {
$ValidateSet = $ResolvedResult.ValidateSet
}
}
elseif((Get-Member -InputObject $ParameterJsonObject.Items -Name 'Type') -and $ParameterJsonObject.Items.Type)
{
Expand All @@ -374,9 +400,14 @@ function Get-DefinitionParameterType
{
$ReferenceTypeValue = $ParameterJsonObject.AdditionalProperties.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$AdditionalPropertiesType = $DefinitionTypeNamePrefix + "$ReferenceTypeName"
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
# Dictionary
$ParameterType = "System.Collections.Generic.Dictionary[[string],[$AdditionalPropertiesType]]"
$ParameterType = "System.Collections.Generic.Dictionary[[string],[$($ResolvedResult.ParameterType)]]"
}
else {
$Message = $LocalizedData.UnsupportedSwaggerProperties -f ('ParameterJsonObject', $($ParameterJsonObject | Out-String))
Expand All @@ -400,8 +431,13 @@ function Get-DefinitionParameterType
{
$ReferenceTypeValue = $ParameterJsonObject.AdditionalProperties.Items.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$ItemsType = $DefinitionTypeNamePrefix + "$ReferenceTypeName"
$ParameterType = "System.Collections.Generic.Dictionary[[string],[System.Collections.Generic.List[$ItemsType]]]"
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$ParameterType = "System.Collections.Generic.Dictionary[[string],[System.Collections.Generic.List[$($ResolvedResult.ParameterType)]]]"
}
else
{
Expand Down Expand Up @@ -461,7 +497,16 @@ function Get-DefinitionParameterType
{
$ReferenceParameterValue = $ParameterJsonObject.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceParameterValue.Substring( $( $ReferenceParameterValue.LastIndexOf('/') ) + 1 )
$ParameterType = $DefinitionTypeNamePrefix + $ReferenceTypeName
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$ParameterType = $ResolvedResult.ParameterType
if($ResolvedResult.ValidateSet) {
$ValidateSet = $ResolvedResult.ValidateSet
}
}
else
{
Expand All @@ -477,7 +522,10 @@ function Get-DefinitionParameterType
Write-Warning -Message ($LocalizedData.InvalidDefinitionParameterType -f $ParameterType, $ParameterName, $DefinitionName)
}

return $ParameterType
return @{
ParameterType = $ParameterType
ValidateSet = $ValidateSet
}
}

function Expand-SwaggerDefinition
Expand Down Expand Up @@ -778,13 +826,25 @@ function Expand-NonModelDefinition
{
$FunctionDetails.ParametersTable.GetEnumerator() | ForEach-Object {
$ParameterDetails = $_.Value
if ($ParameterDetails.Type -eq "$Namespace.$Models.$($DefFunctionDetails.Name)") {
if (($ParameterDetails.Type -eq "$Namespace.$Models.$($DefFunctionDetails.Name)") -or
($ParameterDetails.Type -eq "$Namespace.$Models.$($DefFunctionDetails.Name)[]")) {

if($SourceDetails.ContainsKey('Type')) {
$ParameterDetails['Type'] = $SourceDetails.Type
if($ParameterDetails.Type -eq "$Namespace.$Models.$($DefFunctionDetails.Name)[]") {
$ParameterDetails['Type'] = $SourceDetails.Type + '[]'
}
else {
$ParameterDetails['Type'] = $SourceDetails.Type
}
}

if($SourceDetails.ContainsKey('ValidateSet')) {
$ParameterDetails['ValidateSet'] = $SourceDetails.ValidateSet
if($SourceDetails.ValidateSet.PSTypeNames -contains 'System.Array') {
$ParameterDetails['ValidateSet'] = "'$($SourceDetails.ValidateSet -join "', '")'"
}
else {
$ParameterDetails['ValidateSet'] = $SourceDetails.ValidateSet
}
}

if((-not $ParameterDetails.Description) -and
Expand Down
98 changes: 89 additions & 9 deletions PSSwagger/SwaggerUtils.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,16 @@ function Get-ParamType
{
$ReferenceTypeValue = $ParameterJsonObject.Items.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$paramType = $DefinitionTypeNamePrefix + "$ReferenceTypeName[]"
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$paramType = $ResolvedResult.ParameterType + '[]'
if($ResolvedResult.ValidateSetString) {
$ValidateSetString = $ResolvedResult.ValidateSetString
}
}
elseif((Get-Member -InputObject $ParameterJsonObject.Items -Name 'Type') -and $ParameterJsonObject.Items.Type)
{
Expand All @@ -979,8 +988,13 @@ function Get-ParamType
{
$ReferenceTypeValue = $ParameterJsonObject.AdditionalProperties.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$AdditionalPropertiesType = $DefinitionTypeNamePrefix + "$ReferenceTypeName"
$paramType = "System.Collections.Generic.Dictionary[[string],[$AdditionalPropertiesType]]"
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$paramType = "System.Collections.Generic.Dictionary[[string],[$($ResolvedResult.ParameterType)]]"
}
else {
$Message = $LocalizedData.UnsupportedSwaggerProperties -f ('ParameterJsonObject', $($ParameterJsonObject | Out-String))
Expand All @@ -1004,8 +1018,13 @@ function Get-ParamType
{
$ReferenceTypeValue = $ParameterJsonObject.AdditionalProperties.Items.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeValue.Substring( $( $ReferenceTypeValue.LastIndexOf('/') ) + 1 )
$ItemsType = $DefinitionTypeNamePrefix + "$ReferenceTypeName"
$paramType = "System.Collections.Generic.Dictionary[[string],[System.Collections.Generic.List[$ItemsType]]]"
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$paramType = "System.Collections.Generic.Dictionary[[string],[System.Collections.Generic.List[$($ResolvedResult.ParameterType)]]]"
}
else
{
Expand Down Expand Up @@ -1079,7 +1098,16 @@ function Get-ParamType
{
# #<...>/definitions/<DEFINITIONNAME>
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceParts[-1]
$paramType = $DefinitionTypeNamePrefix + $ReferenceTypeName
$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$paramType = $ResolvedResult.ParameterType
if($ResolvedResult.ValidateSetString) {
$ValidateSetString = $ResolvedResult.ValidateSetString
}
}
}
}
Expand All @@ -1088,7 +1116,17 @@ function Get-ParamType
{
$ReferenceParameterValue = $ParameterJsonObject.Schema.'$ref'
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceParameterValue.Substring( $( $ReferenceParameterValue.LastIndexOf('/') ) + 1 )
$paramType = $DefinitionTypeNamePrefix + $ReferenceTypeName

$ResolveReferenceParameterType_params = @{
DefinitionFunctionsDetails = $DefinitionFunctionsDetails
ReferenceTypeName = $ReferenceTypeName
DefinitionTypeNamePrefix = $DefinitionTypeNamePrefix
}
$ResolvedResult = Resolve-ReferenceParameterType @ResolveReferenceParameterType_params
$paramType = $ResolvedResult.ParameterType
if($ResolvedResult.ValidateSetString) {
$ValidateSetString = $ResolvedResult.ValidateSetString
}

if((Get-Member -InputObject $ParameterJsonObject -Name 'x-ms-client-flatten') -and
($ParameterJsonObject.'x-ms-client-flatten'))
Expand Down Expand Up @@ -1632,8 +1670,9 @@ function Get-OutputType
$DefRefParts = $defRef -split '/' | ForEach-Object { if($_.Trim()){ $_.Trim() } }
if(($DefRefParts.Count -ge 3) -and ($DefRefParts[-2] -eq 'definitions'))
{
$defKey = Get-CSharpModelName -Name $DefRefParts[-1]
$fullPathDataType = "$ModelsNamespace.$defKey"
$ReferenceTypeName = $DefRefParts[-1]
$ReferenceTypeName = Get-CSharpModelName -Name $ReferenceTypeName
$fullPathDataType = "$ModelsNamespace.$ReferenceTypeName"
}
if(Get-member -InputObject $defValue -Name 'type')
{
Expand Down Expand Up @@ -1838,3 +1877,44 @@ function Get-PowerShellCodeGenSettings {
}
}
}

function Resolve-ReferenceParameterType {
[CmdletBinding()]
param(
[Parameter(Mandatory = $true)]
[string]
$ReferenceTypeName,

[Parameter(Mandatory = $true)]
[string]
$DefinitionTypeNamePrefix,

[Parameter(Mandatory = $true)]
[PSCustomObject]
$DefinitionFunctionsDetails
)

$ParameterType = $DefinitionTypeNamePrefix + $ReferenceTypeName
$ValidateSet = $null
$ValidateSetString = $null

# Some referenced definitions can be non-models like enums with validateset.
if ($DefinitionFunctionsDetails.ContainsKey($ReferenceTypeName) -and
$DefinitionFunctionsDetails[$ReferenceTypeName].ContainsKey('Type') -and
$DefinitionFunctionsDetails[$ReferenceTypeName].Type -and
-not $DefinitionFunctionsDetails[$ReferenceTypeName].IsModel)
{
$ParameterType = $DefinitionFunctionsDetails[$ReferenceTypeName].Type

if($DefinitionFunctionsDetails[$ReferenceTypeName].ValidateSet) {
$ValidateSet = $DefinitionFunctionsDetails[$ReferenceTypeName].ValidateSet
$ValidateSetString = "'$($ValidateSet -join "', '")'"
}
}

return @{
ParameterType = $ParameterType
ValidateSet = $ValidateSet
ValidateSetString = $ValidateSetString
}
}
Loading