[Typescript-angular] Bug generating APIs with Date-Time parameters

[mcpummec]

Description

When generating APIs with Date-Time parameters, the generated service returns the error "key may not be null if value is Date".

openapi-generator version

This was introduced by 4.2.3. I'm having no issues running 4.0.1.

OpenAPI declaration file content or url

"parameters": [{
"name": "date",
"in": "query",
"type": "string",
"format": "date-time"
}
]

Command line used for generation

openapi-generator generate -g typescript-angular -i [swaggerUri] -o [outputPath] -c scripts/open-api-generator.conf.json

Steps to reproduce

• Generate API
• call service with signature
  "public getData(date?: Date, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json'}): Observable"
• exception is thrown: "Error: key may not be null if value is Date"

Related issues/PRs

Possibly related to #4404

Suggest a fix/enhancement

The problem is addToHttpParams and addToHttpParamsRecursive.
For values with 'typeof values ==="object"', addToHttpParamsRecursive is called without the 'key' property. But if 'value instanceof Date', a key is required; otherwise the error is raised.

sample.txt

[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]

this should be fixed with #5174

[mcpummec]

@macjohnny I think this is unrelated, as PR 5197 just adds a null check. In my case, value is not null, but a valid date.

[macjohnny]

@mcpummec would you like to file a PR to fix this?

[mcpummec]

@mcpummec would you like to file a PR to fix this?

Sure, but unfortunately I can't push a feature branch (403).

[macjohnny]

just fork the repository, push a branch there, and then file a PR

[mcpummec]

thanks @macjohnny for your support & quick respone

[amakhrov]

@mcpummec a late question: what do you do with Dates coming as a part of response models? Currently, openapi-generator doesn't de-serialize date-formatted strings into Date objects.

A common workaround to the problem is to add --typeMapping DateTime=string param to the generator. Which effectively also eliminates the issue you described.

Are you doing this de-serialization yourself in the code that consumes the generated apis?

[macjohnny]

@amakhrov here it is only about the query parameters, not model parameters. Query parameters are handled in a different way

[mcpummec]

@amakhrov tbh for me date-times within response models are deserialized just fine.

swagger definition of

"ResponseObject": {
	"type": "object",
	"properties": {
		"date": {
			"format": "date-time",
			"type": "string"
		}
	}
}

results in something like

export interface ResponseObject{
	date ?  : Date;
}

using the generator command posted above.