Skip to content
GitLab
    • Explore Projects Groups Snippets
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !14139
An error occurred while fetching the assigned milestone of the selected merge_request.

[typescript-nest] fixes query parameter append bug

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/joelongstreet/master into master 2 years ago
  • Overview 2
  • Commits 1
  • Pipelines 0
  • Changes 5

Created by: joelongstreet

This pull request updates the typescript-nest client generator to use URLSearchParams instead of an empty object when storing and referencing query parameters. This fixes a bug where the generator would build invalid typescript.

Using the examples described in this issue, the following typescript would be generated:

let queryParameters = {};
if (brandOrganizationId) {
    brandOrganizationId.forEach((element) => {
        queryParameters.append('brandOrganizationId', <any>element);
    })
}

The queryParameters object is a plain object and doesn't have the append method available. This change updates queryParameters to always be an instance of URLSearchParams where append is an available method.

Axios (the http client in this case), accepts an instance of URLSearchParams or a string as the params property. This pull request updates all query params to be passed as URLSearchParams.

Closes https://github.com/OpenAPITools/openapi-generator/pull/13638 Closes https://github.com/OpenAPITools/openapi-generator/issues/14134

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Compare
  • master (base)

and
  • latest version
    67732db2
    1 commit, 2 years ago

5 files
+ 18
- 18

    Preferences

    File browser
    Compare changes
modules/…/…/…/…/‎typescript-nestjs‎
api.servic‎e.mustache‎ +5 -5
samples/cli‎ent/petstore‎
…/…‎/…/…‎
pet.ser‎vice.ts‎ +4 -4
user.se‎rvice.ts‎ +3 -3
…/…‎/…/…‎
pet.ser‎vice.ts‎ +3 -3
user.se‎rvice.ts‎ +3 -3
modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache
+ 5
- 5
  • View file @ 67732db2

  • Edit in single-file editor

  • Open in Web IDE


@@ -76,7 +76,7 @@ export class {{classname}} {
{{/allParams}}
{{#hasQueryParams}}
let queryParameters = {};
let queryParameters = new URLSearchParams();
{{#queryParams}}
{{#isArray}}
if ({{paramName}}) {
@@ -93,10 +93,10 @@ export class {{classname}} {
{{^isArray}}
if ({{paramName}} !== undefined && {{paramName}} !== null) {
{{#isDateTime}}
queryParameters['{{baseName}}'] = <any>{{paramName}}.toISOString();
queryParameters.append('{{baseName}}', <any>{{paramName}}.toISOString());
{{/isDateTime}}
{{^isDateTime}}
queryParameters['{{baseName}}'] = <any>{{paramName}};
queryParameters.append('{{baseName}}', <any>{{paramName}});
{{/isDateTime}}
}
{{/isArray}}
@@ -128,10 +128,10 @@ export class {{classname}} {
{{/isKeyInHeader}}
{{#isKeyInQuery}}
{{^hasQueryParams}}
let queryParameters = {};
let queryParameters = new URLSearchParams();
{{/hasQueryParams}}
if (this.configuration.apiKeys["{{keyParamName}}"]) {
queryParameters['{{keyParamName}}'] = this.configuration.apiKeys["{{keyParamName}}"];
queryParameters.append('{{keyParamName}}', this.configuration.apiKeys["{{keyParamName}}"]);
}
{{/isKeyInQuery}}
samples/client/petstore/typescript-nestjs-v6-provided-in-root/builds/default/api/pet.service.ts
+ 4
- 4
  • View file @ 67732db2

  • Edit in single-file editor

  • Open in Web IDE


@@ -152,9 +152,9 @@ export class PetService {
throw new Error('Required parameter status was null or undefined when calling findPetsByStatus.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (status) {
queryParameters['status'] = status.join(COLLECTION_FORMATS['csv']);
queryParameters.append('status', status.join(COLLECTION_FORMATS['csv']));
}
let headers = this.defaultHeaders;
@@ -202,9 +202,9 @@ export class PetService {
throw new Error('Required parameter tags was null or undefined when calling findPetsByTags.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (tags) {
queryParameters['tags'] = tags.join(COLLECTION_FORMATS['csv']);
queryParameters.append('tags', tags.join(COLLECTION_FORMATS['csv']));
}
let headers = this.defaultHeaders;
samples/client/petstore/typescript-nestjs-v6-provided-in-root/builds/default/api/user.service.ts
+ 3
- 3
  • View file @ 67732db2

  • Edit in single-file editor

  • Open in Web IDE


@@ -268,12 +268,12 @@ export class UserService {
throw new Error('Required parameter password was null or undefined when calling loginUser.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (username !== undefined && username !== null) {
queryParameters['username'] = <any>username;
queryParameters.append('username', <any>username);
}
if (password !== undefined && password !== null) {
queryParameters['password'] = <any>password;
queryParameters.append('password', <any>password);
}
let headers = this.defaultHeaders;
samples/client/petstore/typescript-nestjs-v8-provided-in-root/builds/default/api/pet.service.ts
+ 3
- 3
  • View file @ 67732db2

  • Edit in single-file editor

  • Open in Web IDE


@@ -153,7 +153,7 @@ export class PetService {
throw new Error('Required parameter status was null or undefined when calling findPetsByStatus.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (status) {
queryParameters['status'] = status.join(COLLECTION_FORMATS['csv']);
}
@@ -203,9 +203,9 @@ export class PetService {
throw new Error('Required parameter tags was null or undefined when calling findPetsByTags.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (tags) {
queryParameters['tags'] = tags.join(COLLECTION_FORMATS['csv']);
queryParameters.append('tags', tags.join(COLLECTION_FORMATS['csv']));
}
let headers = this.defaultHeaders;
samples/client/petstore/typescript-nestjs-v8-provided-in-root/builds/default/api/user.service.ts
+ 3
- 3
  • View file @ 67732db2

  • Edit in single-file editor

  • Open in Web IDE


@@ -269,12 +269,12 @@ export class UserService {
throw new Error('Required parameter password was null or undefined when calling loginUser.');
}
let queryParameters = {};
let queryParameters = new URLSearchParams();
if (username !== undefined && username !== null) {
queryParameters['username'] = <any>username;
queryParameters.append('username', <any>username);
}
if (password !== undefined && password !== null) {
queryParameters['password'] = <any>password;
queryParameters.append('password', <any>password);
}
let headers = this.defaultHeaders;
0 Assignees
None
Assign to
0 Reviewers
None
Request review from
Labels
0
None
0
None
    Assign labels
  • Manage project labels

Milestone
No milestone
None
None
Time tracking
No estimate or time spent
Lock merge request
Unlocked
0
0 participants
Reference:
Source branch: github/fork/joelongstreet/master

Menu

Explore Projects Groups Snippets