[typescript-angular] support for object query parameters as nested key/json string

[dougal83]

fixes: #5781

Extend support to include an option to configure how objects are encoded in query parameters. To include options for nested keys and JSON string.

PR checklist

• Read the contribution guidelines.
• If contributing template-only or documentation-only changes which will change sample output, build the project before.
• Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
• File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
• Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @nicokoenig @topce @akehir @petejohansonxo @amakhrov

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[macjohnny]

LGTM

[macjohnny]

according to the CI (https://circleci.com/gh/OpenAPITools/openapi-generator/14068#tests/containers/2) the docs file needs to be changed

[dougal83]

according to the CI (https://circleci.com/gh/OpenAPITools/openapi-generator/14068#tests/containers/2) the docs file needs to be changed

@macjohnny Thank you for the review.

I added the following line:

|queryParamObjectFormat|Query parameter object value format: 'dot', 'json', 'key'.| |dot|

to docs/generators/typescript-angular.md. Is this the correct way to update the docs/web page for the parameters?

EDIT: ran bin/utils/ensure-up-to-date

[amakhrov]

@dougal83
After reviewing the spec, I also realized that OAS3 has a standard way to define the format of nested objects:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#style-values (see deepObject style)

However, it's not really supported by any of the existing generators. Only php generators do smth like that, but they do not respect the style=deepObject setting anyway.

I'm really curious if there is any "standard-ish" approach implemented by the majority of other generators for object params serialization that we can consider a de-facto standard?
@TiFu @macjohnny any insights on that?

[dougal83]

@dougal83
After reviewing the spec, I also realized that OAS3 has a standard way to define the format of nested objects:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#style-values (see deepObject style)

I'm interested in using openapi-generator with loopback, there is an issue over there regarding supporting deep objects. Am interested in helping if I can.

If anything, I would personally make the key option the default but the dot notation was already in place. key is the closest match to the official standard but I've not looked into it beyond my personal project.

[amakhrov]

Looks like json serialization is supported by the spec, as mentioned in this comment: OAI/OpenAPI-Specification#1706 (comment)

should we support this in the typescript generator instead of a custom generator cli option?

[dougal83]

Looks like json serialization is supported by the spec, as mentioned in this comment: OAI/OpenAPI-Specification#1706 (comment)

should we support this in the typescript generator instead of a custom generator cli option?

I'll leave this up to the tech. committee to decide. Feel free to do as you see fit with this PR depending on the outcome of the discussion. 👍

[TiFu]

Maybe to add my two cents:

As long as this adheres to the spec - and it seems like it does because the spec leaves this detail undefined - I'm fine with this change. It just makes more options available to whoever is using the generator.

[dougal83]

Looks like json serialization is supported by the spec, as mentioned in this comment: OAI/OpenAPI-Specification#1706 (comment)

should we support this in the typescript generator instead of a custom generator cli option?

Perhaps we should close this PR in the light of missing the latest release and focus on the Typescript avenue for improvement.

[macjohnny]

I will merge this once #6360 is merged, since there will be conflicts

[mrbatista]

@macjohnny any update?

[macjohnny]

@dougal83 could you please merge the latest master into your branch, resolve the conflicts and re-generated the samples?

[dougal83]

Performed simple rebase and resolved conflict. Untested and samples not regenerated(don't think they are affected). I need to install JDK & Maven... try to do shortly.

[dougal83]

@macjohnny Tests pass. Sample regeneration run. 👍

[dougal83]

Removed the last commit with sample regen as nothing material was added. I hope this is ready to go after checks...