[REQ][typescript-angular]: support for object as query parameters #4407

aanno2 · 2019-11-07T10:33:34Z

fixes #4404

@macjohnny: Thank you for review

I've updated the PR and hope it will be more in-line with what is expected.

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

issue by @aanno2

auto-labeler · 2019-11-07T10:33:38Z

👍 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 · 2019-11-07T19:06:05Z

Thanks for your PR
Please follow the steps described in https://github.com/OpenAPITools/openapi-generator/blob/master/.github/PULL_REQUEST_TEMPLATE.md

modules/openapi-generator/src/main/resources/typescript-angular/encoder.mustache

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

aanno2 · 2019-11-07T20:38:37Z

BTW, travis dies with 'A tuple type element list cannot be empty' but my local build with maven has not reported a problem. I'm not sure how to reproduce the error locally.

aanno2 · 2019-11-13T15:22:28Z

I have updated and merge-squashed my PR with an appropriate author email. No 'real' changes.

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

aanno2 · 2019-11-14T08:57:16Z

@macjohnny: Thank you for accepting my contribution.

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

macjohnny

LGTM

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

macjohnny · 2019-11-14T15:50:18Z

please merge the current master into your branch and update the samples again

aanno2 · 2019-11-15T09:15:56Z

Introduced a typo before I run out of time yesterday. All fixed now.

macjohnny · 2019-11-15T09:24:12Z

samples/client/petstore/typescript-angular-v8-provided-in-root/builds/with-npm/package.json

  "version": "1.0.0",
-  "description": "OpenAPI client for @openapitools/typescript-angular-petstore",


I think this should be reverted

Oops. Not done on purpose. Sorry!

macjohnny · 2019-12-04T09:24:33Z

@aanno2 can you please merge the current master and update the samples?

dougal83 · 2019-12-28T16:26:09Z

@aanno2 Thanks for this pull request. Just run into the issue myself. All set for next release?

greghopkins · 2020-01-14T15:10:04Z

Would love for this to get merged soon... 🙏 😉

wing328 · 2020-01-14T15:38:00Z

@aanno2 please resolve the merge conflicts and merge the latest master into this branch. Let me know if you need help on this.

… to refer the right PR the first time)

…/builds/with-npm/package.json

…ot/builds/with-npm/tsconfig.json

…ToHttpParams

aanno2 · 2020-01-22T14:37:16Z

@wing328: As requested, I have rebased the PR onto the current master branch.

macjohnny · 2020-01-22T14:57:13Z

@aanno2 can you please fix the build error:

ERROR in builds/default/api/pet.service.ts(78,27): error TS1122: A tuple type element list cannot be empty.
builds/default/api/store.service.ts(64,27): error TS1122: A tuple type element list cannot be empty.
builds/default/api/user.service.ts(64,27): error TS1122: A tuple type element list cannot be empty.

see https://travis-ci.org/OpenAPITools/openapi-generator/builds/640473532?utm_source=github_status&utm_medium=notification

macjohnny · 2020-01-22T14:59:17Z

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

+    private addToHttpParamsRecursive(httpParams: HttpParams, value: any, key?: string): HttpParams {
+        if (typeof value === "object") {
+            if (Array.isArray(value)) {
+                (value as []).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));


Suggested change

(value as []).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));

(value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));

Thank you for helping out. I just applied your suggestion.

macjohnny · 2020-01-22T15:10:40Z

please re-generate the samples

kenisteward · 2020-03-06T23:48:38Z

@macjohnny. Has this been released in a version yet? I was legit looking into fixing this but found this or and am super happy haha

dougal83 · 2020-03-07T00:04:58Z

@macjohnny. Has this been released in a version yet? I was legit looking into fixing this but found this or and am super happy haha

Yes, it is in the latest version.

spencerfontein · 2020-03-19T18:35:44Z

looks like this was merged to 4.3.0, but the latest available on npm is 4.2.3 https://www.npmjs.com/package/@openapitools/openapi-generator-cli. Is there a way I can use the fix ?

dougal83 · 2020-03-19T18:54:23Z

looks like this was merged to 4.3.0, but the latest available on npm is 4.2.3 https://www.npmjs.com/package/@openapitools/openapi-generator-cli. Is there a way I can use the fix ?

Are you sure? I thought that the milestone on the right was an at-a-glance indicator and it says 4.2.3. Also, if I recall correctly then I've used this feature from the current npm version. Where are you seeing 4.3.0?

spencerfontein · 2020-03-19T19:07:29Z

I clicked on this link #5174 that daniel-frank posted a few comments back and it mentioned 4.3.

I am currently using 4.2.3

I have the Pagination object in my Java code as a query param and this is the TS I get

import { Sort } from'./sort';
exportinterfacePageable {
offset?: number;
sort?: Sort;

pageSize?: number;
pageNumber?: number;
paged?: boolean;
unpaged?: boolean;
}

export interface Sort {
    sorted?: boolean;
    unsorted?: boolean;
    empty?: boolean;
}

Maybe I'm missing something

This is the command I'm running

openapi-generator generate -g typescript-angular -i ../../backend/escalation-service/target/openapi.json -o swagger/escalation-api --additional-properties npmName=@mycustom/escalation-api,ngVersion=8.1.2,npmVersion=1.0.0

Thanks for the help

dougal83 · 2020-03-19T19:11:27Z

I think it would be best to open a new issue to query this and include your 'openapi.json'. Hopefully, someone can point out the issue.

auto-labeler bot added the Client: TypeScript label Nov 7, 2019

macjohnny reviewed Nov 7, 2019

View reviewed changes

aanno2 force-pushed the feature/aanno2-tsng-fix-query-params-master branch 2 times, most recently from 9df82cf to da8c203 Compare November 13, 2019 15:17

macjohnny reviewed Nov 13, 2019

View reviewed changes

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache Outdated Show resolved Hide resolved

aanno2 force-pushed the feature/aanno2-tsng-fix-query-params-master branch from da8c203 to 4a96e2d Compare November 13, 2019 15:46

macjohnny added this to the 4.2.1 milestone Nov 14, 2019

macjohnny reviewed Nov 14, 2019

View reviewed changes

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache Show resolved Hide resolved

macjohnny approved these changes Nov 14, 2019

View reviewed changes

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache Show resolved Hide resolved

wing328 modified the milestones: 4.2.1, 4.2.2 Nov 15, 2019

macjohnny reviewed Nov 15, 2019

View reviewed changes

wing328 modified the milestones: 4.2.2, 4.2.3 Dec 2, 2019

aanno2 and others added 4 commits January 22, 2020 15:12

OpenAPITools#4407 squashed from original, and better author (I failed…

1d634a8

… to refer the right PR the first time)

removed isArrayLike in favour of Array.isArray

66bf7b7

support collectionFormat the old way

1ffc33d

fixed type and rebuild samples

03bba34

aanno and others added 4 commits January 22, 2020 15:12

revert samples/client/petstore/typescript-angular-v8-provided-in-root…

0e8db2e

…/builds/with-npm/package.json

reverted samples/client/petstore/typescript-angular-v8-provided-in-ro…

59d2f4a

…ot/builds/with-npm/tsconfig.json

rebase-to-master-fix: isDateTime stuff is now handled within this.add…

7cbec6b

…ToHttpParams

run bin/typescript-angular-petstore-all.sh on the rebased PR

e461319

aanno2 force-pushed the feature/aanno2-tsng-fix-query-params-master branch from 7102035 to e461319 Compare January 22, 2020 14:35

macjohnny approved these changes Jan 22, 2020

View reviewed changes

macjohnny reviewed Jan 22, 2020

View reviewed changes

applying proposed fix of @macjohnny

1660681

run bin/typescript-angular-petstore-all.sh to regenerate samples

22ced5e

macjohnny merged commit d111e3a into OpenAPITools:master Jan 27, 2020

daniel-frak mentioned this pull request Jan 31, 2020

[BUG] [typescript-angular]: objects as query parameters break when fields are null #5174

Closed

5 tasks

This was referenced Mar 30, 2020

[REQ] [typescript-angular] support for nested keys object as query parameters #5755

Closed

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

Closed

petitout mentioned this pull request May 22, 2020

[BUG] [JAVA] Using an object to pass query params ends up using the toString of that class #4808

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[REQ][typescript-angular]: support for object as query parameters #4407

[REQ][typescript-angular]: support for object as query parameters #4407

aanno2 commented Nov 7, 2019 •

edited by macjohnny

Loading

auto-labeler bot commented Nov 7, 2019

macjohnny commented Nov 7, 2019

aanno2 commented Nov 7, 2019 •

edited

Loading

aanno2 commented Nov 13, 2019

aanno2 commented Nov 14, 2019

macjohnny left a comment

macjohnny commented Nov 14, 2019 •

edited

Loading

aanno2 commented Nov 15, 2019 •

edited

Loading

macjohnny Nov 15, 2019

aanno2 Nov 15, 2019

macjohnny commented Dec 4, 2019

dougal83 commented Dec 28, 2019

greghopkins commented Jan 14, 2020

wing328 commented Jan 14, 2020

aanno2 commented Jan 22, 2020

macjohnny commented Jan 22, 2020

macjohnny Jan 22, 2020

aanno2 Jan 22, 2020

macjohnny commented Jan 22, 2020

kenisteward commented Mar 6, 2020

dougal83 commented Mar 7, 2020

spencerfontein commented Mar 19, 2020

dougal83 commented Mar 19, 2020

spencerfontein commented Mar 19, 2020

dougal83 commented Mar 19, 2020

		"version": "1.0.0",
		"description": "OpenAPI client for @openapitools/typescript-angular-petstore",

	(value as []).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));
	(value as any[]).forEach( elem => httpParams = this.addToHttpParamsRecursive(httpParams, elem, key));

[REQ][typescript-angular]: support for object as query parameters #4407

[REQ][typescript-angular]: support for object as query parameters #4407

Conversation

aanno2 commented Nov 7, 2019 • edited by macjohnny Loading

PR checklist

auto-labeler bot commented Nov 7, 2019

macjohnny commented Nov 7, 2019

aanno2 commented Nov 7, 2019 • edited Loading

aanno2 commented Nov 13, 2019

aanno2 commented Nov 14, 2019

macjohnny left a comment

Choose a reason for hiding this comment

macjohnny commented Nov 14, 2019 • edited Loading

aanno2 commented Nov 15, 2019 • edited Loading

macjohnny Nov 15, 2019

Choose a reason for hiding this comment

aanno2 Nov 15, 2019

Choose a reason for hiding this comment

macjohnny commented Dec 4, 2019

dougal83 commented Dec 28, 2019

greghopkins commented Jan 14, 2020

wing328 commented Jan 14, 2020

aanno2 commented Jan 22, 2020

macjohnny commented Jan 22, 2020

macjohnny Jan 22, 2020

Choose a reason for hiding this comment

aanno2 Jan 22, 2020

Choose a reason for hiding this comment

macjohnny commented Jan 22, 2020

kenisteward commented Mar 6, 2020

dougal83 commented Mar 7, 2020

spencerfontein commented Mar 19, 2020

dougal83 commented Mar 19, 2020

spencerfontein commented Mar 19, 2020

dougal83 commented Mar 19, 2020

aanno2 commented Nov 7, 2019 •

edited by macjohnny

Loading

aanno2 commented Nov 7, 2019 •

edited

Loading

macjohnny commented Nov 14, 2019 •

edited

Loading

aanno2 commented Nov 15, 2019 •

edited

Loading