swagger-api/swagger-codegen

Typescript: Dates Are Not Deserialized

Open

#2,776 opened on May 4, 2016

View on GitHub
 (18 comments) (17 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: TypeScriptIssue: Bughelp wanted

Description

If you have a property in a definition that is a string with date-time format, the typescript generated model makes that property a Date type. However, the response in the client is given verbatim. It never looks for date strings and actually transforms them in to Date objects. So the project will build, but fails at runtime if you try to access Date specific methods since it's actually a string.

I imagine this relates to: https://github.com/swagger-api/swagger-codegen/issues/1951

Since this PR focuses on deserializing dates in the response. I would suggest making those properties strings until deserialization is supported, otherwise the type checking isn't actually accurate.

Contributor guide

Tech stack
typescript
Domain
api
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsOpenAPI/Swagger specsCode generation templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the TypeScript template files in swagger codegen, focusing on how date time properties are handled. Review linked issue #1951 for context on deserialization. Identify whether the fix involves changing the generated type from Date to string or adding deserialization logic in the client. Consider the existing generation of model classes and the client's response handling.