Giter VIP home page Giter VIP logo

Comments (3)

mzronek avatar mzronek commented on May 30, 2024

I had a good look at the code now and read the discriminator unit tests. This case of oneOf seems to be not supported. There is a oneOf case that is tested, but it doesn't seem to even use a discriminator, the OpenAPI input is invalid and the output is simply a oneOf union:

The default usecase for oneOf discriminators seems to be not handled right now, so I changed the title of this feature request accordingly.

I also have a proposal now and might be able to implement this. The hard part is searching for all discriminator properties referenced by a discriminator. This should be done via the mapping itself, where we already get the path of the schema object. If the object consists of an allOf (for example a base object for the discriminator, where the discriminator property really is), the allOf needs to be resolved. Finally we need to overwrite the discriminator property with the single mapped value to mimick the Typescript union discimination.

We probably need to enhance the discriminator scan and add the discriminator property paths to the ctx information. That way we should be able to quickly find the discriminator properties inside transformSchemaObjectCore and transform { type: 'string', enum: [value] } instead of the full enum.

That doesn't take the resolved allOfs into account. Maybe we can append the discriminator property to the mapped schema objects to overwrite any inherited discriminator properties?

@drwpow Shall I try to implement the easy case from the OpenAPI above? It is the default case for oneOf from the OpenAPI documentation for discriminators.

from openapi-typescript.

mzronek avatar mzronek commented on May 30, 2024

I PR'd a proposal so we can discuss the new support: #1574

from openapi-typescript.

mzronek avatar mzronek commented on May 30, 2024

#1574 was merged into main now. Working on backporting to 6.x now.

from openapi-typescript.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.