typescript-axios string date format

[tsiq-jeremy]

PR checklist

• Read the contribution guidelines.
• Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
• Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
• Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny

Fair warning that I tested this out more thoroughly using swagger-codegen for this PR - swagger-api/swagger-codegen#9594 - but it looks like the same exact issue.

Related to this issue. When using TypeScript Fetch and passing parameters to a "Date" field, they expect a type of "string", but then toISOString() is called on it, which causes the function to fail.

Example json swagger:

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

in In `AbstractTypeScriptClientCodegen.java the Typings map:

typeMapping.put("date", "string");
typeMapping.put("DateTime", "Date");

template issue:

{{#isDate}}
queryParameters['{{baseName}}'] = (requestParameters.{{paramName}} as any).toISOString();
{{/isDate}}

requestParameters.{{paramName}} can never be a Date, since it has to be a string.

fixes #2745

[macjohnny]

LGTM

[macjohnny]

@tsiq-jeremy thanks for your PR! can you please re-generate the samples?

Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.

[macjohnny]

cc @nicokoenig

[tsiq-jeremy]

Hey I just ran ./bin/typescript-axios-petstore-all.sh and did not see any changes when running git status. I looked through the yaml file it runs against and it has date-time, but no date types.

[macjohnny]

@tsiq-jeremy ok, that's probably because there is no Date-query parameter in the petstore example, so everything is fine.
The CI-failure is unrelated.

[macjohnny]

@tsiq-jeremy would you like to fix the same problem in the typescript-fetch generator, i.e. here:

openapi-generator/modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache

Lines 67 to 73 in 5775813

	{{#isDateTime}}
	queryParameters['{{baseName}}'] = (requestParameters.{{paramName}} as any).toISOString();
	{{/isDateTime}}
	{{^isDateTime}}
	{{#isDate}}
	queryParameters['{{baseName}}'] = (requestParameters.{{paramName}} as any).toISOString().substr(0,10);
	{{/isDate}}

[tsiq-jeremy]

Hey, let me look into that one. I'm not sure if there is a problem with typescript-fetch b/c in modelGeneric.mustache it has FromJSON and ToJSON that are manipulating the date type.

[macjohnny]

yes, but I think the From/ToJson functions are used for the body, not for the query parameters, so it should be the same situation

[tsiq-jeremy]

Hey I have not tested this out fully, but I think this should not be a problem with typescript-fetch. Used to test:

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

Produced:

export interface GetOrderByIdRequest {
    date: Date;
}

   ....
    async getOrderByIdRaw(requestParameters: GetOrderByIdRequest): Promise<runtime.ApiResponse<Order>> {
       ....
        const queryParameters: runtime.HTTPQuery = {};

        if (requestParameters.date !== undefined) {
            queryParameters['date'] =  (requestParameters.date as any).toISOString().substr(0,10);
        }
       ...
    }

So it looks like that a Date object is getting passed in so that it should not produce an error when calling toISOString.

[macjohnny]

Ok, alright, thanks for checking!

[wing328]

@tsiq-jeremy thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553