swagger-api / swagger-api/swagger-codegen

JS client does not support polymorphic return types

Open
#2,041 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: JavaScript/Node.js Feature: Composition / Inheritance
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

In the generated constructFromObject functions, the descriminator property is ignored, which means that an instance of the abstract superclass is created. For example, if I have this in my swagger.yaml:

Vehicle:
  type: "object"
  required:
  - "vehicleType"
  discriminator: "vehicleType"
  properties:
    vehicleType:
      type: "string"

Car:
  allOf:
  - $ref: "#/definitions/Vehicle"
  - type: "object"
    required:
    - "vehicleType"
    properties:
      vehicleType:
        type: "string"

Bicycle:
  allOf:
  - $ref: "#/definitions/Vehicle"
  - type: "object"
    required:
    - "vehicleType"
    properties:
      vehicleType:
        type: "string"

then, according to my understanding of how it should work, if the vehicleType is "Car", then a new Car instance should be generated, and if vehicleType is "Bicycle", a new Bicycle instance should be generated.

Currently, all I get is a new Vehicle instance.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the generated constructFromObject functions and the Vehicle/Car/Bicycle schema example in the issue. Trace how the discriminator field is handled when constructing a JavaScript client model. Done means vehicleType selects a Car or Bicycle instance instead of always creating Vehicle, with the behavior verified using the example schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.