Merge pull request #34 from okta/lr-fix-204-responses-parsing-error

Update templates and regenerate to avoid errors when parsing 204 responses

Author: laura-rodriguez

Build.ps1

@@ -61,11 +61,11 @@ $Manifest = @{
     ReleaseNotes = 'https://github.com/okta/okta-powershell-cli/releases'
 
 
-    ModuleVersion = '1.0.0'
+    ModuleVersion = '1.0.1'
 
 
     RootModule = 'Okta.PowerShell.psm1'
-    Guid = '{AD0CD253-16DF-4496-9BCF-EA49AFB7FB27}' # Has to be static, otherwise each new build will be considered different module
+    Guid = '{7DA80DEB-6F4C-43CB-97CF-05CCE8B73473}' # Has to be static, otherwise each new build will be considered different module
 
     PowerShellVersion = '6.2'
 

openapi3/codegen-templates/api_client.mustache

@@ -200,7 +200,12 @@ function Invoke-{{{apiNamePrefix}}}ApiClient {
                                         -UserAgent $OktaUserAgent
             }
 
-            $Response = DeserializeResponse -Response $RawResponse.Content -ReturnType $ReturnType -ContentTypes $RawResponse.Headers["Content-Type"]
+            $Response = $null
+
+            if ($RawResponse.StatusCode -ne '204') {
+                $Response = DeserializeResponse -Response $RawResponse.Content -ReturnType $ReturnType -ContentTypes $RawResponse.Headers["Content-Type"]        
+            }
+            
             $StatusCode = $RawResponse.StatusCode
             $Headers = $RawResponse.Headers
             $ElapsedTimeInMilliseconds  = CalculateElapsedTime -StartTime $StartTime

openapi3/codegen-templates/json_helper.mustache

@@ -19,7 +19,8 @@ function Remove-NullProperties {
         $NewObject = Remove-NullPropertiesFromHashMap($InputObject)
     }
     elseif ($InputObject -is [array]){
-        $NewObject = Remove-NullPropertiesFromArray($InputObject)
+        [array]$NewArray = Remove-NullPropertiesFromArray($InputObject)
+        return $NewArray
     }
     else{
         $PropertyList = $InputObject.PSObject.Properties | Where-Object { $null -ne $_.Value }
@@ -46,7 +47,13 @@ function Remove-NullPropertiesFromHashMap{
     $OutputHashtable = @{}
     foreach ($Key in $InputObject.Keys) {
         $Value = $InputObject[$Key]
-        $CleanedValue = Remove-NullProperties $Value
+        # explicit cast to avoid arrays to be converted to object (i.e @('foo'))
+        if($Value -is [array]){
+            [array]$CleanedValue = Remove-NullProperties $Value
+        }else{
+            $CleanedValue = Remove-NullProperties $Value
+        }
+
         if ($null -ne $CleanedValue) {
             $OutputHashtable[$Key] = $CleanedValue
         }

openapi3/config.json

@@ -14,7 +14,7 @@
     "templateDir": "./codegen-templates",
     "outputDir" : "../",
     "inputSpec" : "./management.yaml", 
-    "packageVersion" : "1.0.0",
+    "packageVersion" : "1.0.1",
     "packageDescription" : "Official PowerShell CLI for the Okta API",
     "packageTitle" : "Official PowerShell for the Okta API",
     "packageCompany" : "Okta, Inc.",

src/Okta.PowerShell/Client/JsonHelper.ps1

@@ -26,7 +26,8 @@ function Remove-NullProperties {
         $NewObject = Remove-NullPropertiesFromHashMap($InputObject)
     }
     elseif ($InputObject -is [array]){
-        $NewObject = Remove-NullPropertiesFromArray($InputObject)
+        [array]$NewArray = Remove-NullPropertiesFromArray($InputObject)
+        return $NewArray
     }
     else{
         $PropertyList = $InputObject.PSObject.Properties | Where-Object { $null -ne $_.Value }
@@ -53,7 +54,13 @@ function Remove-NullPropertiesFromHashMap{
     $OutputHashtable = @{}
     foreach ($Key in $InputObject.Keys) {
         $Value = $InputObject[$Key]
-        $CleanedValue = Remove-NullProperties $Value
+        # explicit cast to avoid arrays to be converted to object (i.e @('foo'))
+        if($Value -is [array]){
+            [array]$CleanedValue = Remove-NullProperties $Value
+        }else{
+            $CleanedValue = Remove-NullProperties $Value
+        }
+
         if ($null -ne $CleanedValue) {
             $OutputHashtable[$Key] = $CleanedValue
         }

src/Okta.PowerShell/Okta.PowerShell.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Okta, Inc.
 #
-# Generated on: 2024-02-27
+# Generated on: 2024-03-25
 #
 
 @{
@@ -18,7 +18,7 @@ ModuleVersion = '1.0.0'
 CompatiblePSEditions = 'Core'
 
 # ID used to uniquely identify this module
-GUID = 'ad0cd253-16df-4496-9bcf-ea49afb7fb27'
+GUID = 'bc068b08-7d7f-4819-aa50-a40989920d49'
 
 # Author of this module
 Author = 'Okta, Inc.'

src/Okta.PowerShell/Private/OktaApiClient.ps1

@@ -131,7 +131,7 @@ function Invoke-OktaApiClient {
         }
     }
 
-    $OktaUserAgent = [Microsoft.PowerShell.Commands.PSUserAgent]::Chrome + " okta-powershell-module/1.0.0"
+    $OktaUserAgent = [Microsoft.PowerShell.Commands.PSUserAgent]::Chrome + " okta-powershell-module/1.0.1"
 
 
     # Setting up vars for retry
@@ -188,7 +188,12 @@ function Invoke-OktaApiClient {
                                         -UserAgent $OktaUserAgent
             }
 
-            $Response = DeserializeResponse -Response $RawResponse.Content -ReturnType $ReturnType -ContentTypes $RawResponse.Headers["Content-Type"]
+            $Response = $null
+
+            if ($RawResponse.StatusCode -ne '204') {
+                $Response = DeserializeResponse -Response $RawResponse.Content -ReturnType $ReturnType -ContentTypes $RawResponse.Headers["Content-Type"]        
+            }
+            
             $StatusCode = $RawResponse.StatusCode
             $Headers = $RawResponse.Headers
             $ElapsedTimeInMilliseconds  = CalculateElapsedTime -StartTime $StartTime

src/Okta.PowerShell/en-US/about_Okta.PowerShell.help.txt

@@ -10,7 +10,7 @@ LONG DESCRIPTION
     This PowerShell module is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
     - API version: 3.0.0
-    - SDK version: 1.0.0
+    - SDK version: 1.0.1
     - Build package: org.openapitools.codegen.languages.PowerShellClientCodegen
     For more information, please visit [https://developer.okta.com/](https://developer.okta.com/)
 

tests/Client/JsonHelper.Tests.ps1

@@ -44,4 +44,23 @@ Context 'Remove-NullProperties' {
         Get-Member -inputobject $CleanedJsonObject.details.children[0] -name "age" -MemberType Properties | Should -Be $null
         Get-Member -inputobject $CleanedJsonObject.details.children[0] -name "name" -MemberType Properties | Should -Be -Not $null
     }
+
+    It 'Should maintain the same object when there''s no null values'{
+        $NewGroupRule = [PSObject]@{
+            name = "Assign users to the Sales Team"
+            type = "group_rule"
+            actions = [PSObject]@{ 
+                assignUserToGroups = [PSObject]@{
+                    groupIds = [array]@('foo')
+                }
+            } 
+        }
+
+        $CleanedRule = Remove-NullProperties $NewGroupRule
+
+        $CleanedRule.name  | Should -Be "Assign users to the Sales Team"
+        $CleanedRule.type | Should -Be "group_rule"
+        $CleanedRule.actions.assignUserToGroups.groupIds.Count | Should -Be 1
+        $CleanedRule.actions.assignUserToGroups.groupIds[0] | Should -Be "foo"
+    }
 }