[PowerShell] Incorrect declaration of parameter type, when the parameter is of type Dictionary/Hashtable.

[larssb]

Description

When using codegen to output PowerShell code based on [X] OpenAPI specification parameters of datatype are not declared in the proper PowerShell syntax. See this attached picture as an example -->

Swagger-codegen

• v2.2.3 downloaded from https://oss.sonatype.org/content/repositories/releases/io/swagger/swagger-codegen-cli/2.2.3/
• I execute it on a Win7 SP1 computer with critical patches up until last month.

Swagger declaration file content or url

Gist containing the OctopusDeploy OpenAPI implementation json file:

Command line used for generation

java -jar swagger-codegen-cli-2.2.3.jar generate -i ./octopusDeploy.json -o outputfolderName -c config.json

config.json content
{ "packageName": "Danske.Spil.Octopus.Deploy.API" }

Steps to reproduce

1. Execute the cmdline written under "Swagger declaration file content or url" above.
2. Open the folder containing the generated code in any IDE
3. Open for example the file named: "New-AccountResource.ps1". It is located underneath DRIVE:\PATH_TO_OUTPUT_FOLDER\src\IO.Swagger\Model\

Related issues/PRs

Haven't found one. Did a search both in the closed and the open issues.

Suggest a fix/enhancement

As the Dictionary and Hashtable types are almost similar it could be an option to declare a dictionary type as [Hashtable]. So for an PowerShell function parameter it would look like this:
function New-AccountResource { [CmdletBinding()] Param ( [System.Nullable[HashTable]] ${Links} ) ..............

Additional note

• Why is the API and Model parts of an OpenAPI implementing API being generated into a folder named "IO.Swagger"?
  When the "Private" folder and .psm1 file are generated under a folder respecting the > packageName specified inside the config.json file? See this attached picture as an example:

• Also, why is the parameter type being declared as [System.Nullable]?

Thank you and I'm looking forward to hear from you. Let me know if there is anything I can elaborate further upon. Have a great day/evening (where ever you are).

[wing328]

@larssb thanks for the feedback.

cc @beatcracker

[wing328]

@larssb would you have time to contribute the enhancement? I can show you some good starting points to start with.

[larssb]

Dang. Came back to trying to use the Octopus Deploy Swagger API implementation and I have the exact same issue again.

• I'm on v2.3.1 of the swagger-codegen cli tool.
• Octopus Deploy is on the latest version, namely > 2018.3.7

It is the exact same thing. [System.Nullable[{String, String}]] declared on several parameters as the type and this is not supported by PowerShell.

Sorry I haven't had the time to look at this @wing328 ... besides that "issue" I'm also very green on making such a change. Where would I start and so forth.

@beatcracker - do you, by any chance, have the time and willingness to jump on this?

Thank you very much to the both of you.

[beatcracker]

@larssb Loks like the culprit is here: PowerShellClientCodegen.java#L368-L369

// TODO not sure if the following map/hash declaration is correct
return "{String, " + getTypeDeclaration(inner) + "}";

For generic dictionary this should be something like this:

// TODO not sure if the following map/hash declaration is correct
return "System.Collections.Generic.Dictionary[String, " + getTypeDeclaration(inner) + "]";

Or if we could just use hashtables for everything:

// TODO not sure if the following map/hash declaration is correct
return "hashtable";

You could try this yourself. I've a repo with scripts to easily build swagger-codegen on windows: POSH-swagger-codegen. Haven't used it lately, but you can give it a spin.

---

P.S. Since I'm not a Java guy, the code above may or may not compile.