Git Product home page Git Product logo

Comments (3)

LePips avatar LePips commented on May 26, 2024 1

not sure if the Pet even needs to be generated
generate Pet as a protocol

I've just started reading OpenAPI to learn but it seems more safe to inline or protocol as an inheritance hierarchy cannot necessarily be assumed with allOf.

I can think of cases where people want either of these generation options. We would have to make sure that entity generation doesn't follow isMakingClassesFinal.

# Apply to all objects
# default: inline
parentObjectGeneration: entity || protocol || inline

# Specify per type
# default: inline
parentObjectGeneration:
  - Pet: protocol
  - Human: entity

Edit: don't do that. We should think about how discriminators would create inheritances but I think only with protocols. https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

from createapi.

kean avatar kean commented on May 26, 2024

I think it's a good idea to make this behavior the default. Looking at the example, if this I'm not sure if the Pet even needs to be generated in this case (assuming it's only ever used in allOf and never referenced as a separate entity).

from createapi.

kean avatar kean commented on May 26, 2024

I would suggest keeping this option because there are generally three types of ways to address it: composition, inheritance, and inlining all properties. CreateAPI covers everything but inheritance right now.

One more thing CreateAPI could do when inlining is used, is generate Pet as a protocol and add conformance to it to the types like Dog.

from createapi.

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.