Inheritance and Polymorphism in Swagger UI

[Edwin Fuquen]

I've implemented the changes to my swagger spec to include the extends and discriminator keywords as described in this document https://gist.github.com/leedm777/5730877

However, when the latest swagger-ui reads it (using develop-2.0 branch) it never pulls in children model onto the display for different rest actions.  For example, if i have a call that returns a model that references Animal, and I have a Cat and Dog class that inherit from it, swagger-ui will only show the Animal model and never the Cat and Dog model.  Is this a known limitation with the current ui, or a bug?  I just want to know if I'm doing something wrong or if this is a feature that has yet to be added?

[tony tam]

Should be in today or tomorrow, track here:

https://github.com/wordnik/swagger-core/issues/280

[Edwin Fuquen]

Very cool, thanks for pointing me to the issue.  One thing, the issue is referencing swagger-core, will an update to swagger-ui to render the models properly come at the same time?  I already am building my json to the swagger spec by hand, so the extends and discriminator keywords are there in the json schema, they just won't show up on the UI.

[tony tam]

Just pushed support for subType hints in the swagger-core:

https://github.com/wordnik/swagger-core/issues/280#issuecomment-22526779

The UI will trail the release of the spec and swagger-core for certain.  But it will get the subtype support.

[Edwin Fuquen]

Cool.  To be clear that spec now lincudes a subType field in a model?  For example, the Animal model should include a properly like this:

{ 

    ...

    "subTypes": ["Dog", "Cat"],

     ...

}

I ask since I'm generating this json for the spec myself.

[tony tam]

That's correct.

[hayder Marzouk]

Hi,

Is this feature is already implemented in swagger-ui ?

Thx

[levg]

Same question - does swagger-ui support this feature already?

[tony tam]

It is not right now.  Finishing oauth2 support then we'll get this worked in.

[Chris Smith]

Hi Tony et al.

Can someone point me in the direction of the extends and subtype documentation. I can follow the subtype use, as discussed above, but can't find anything for extends.

Is it as simple as adding:

{

   ....

   "extends" : "model name"

   ....

}

to the model definition?

Cheers!

[tony tam]

Hi Chris, we've recently moved the spec documentation to here:

https://github.com/wordnik/swagger-spec

Which has descriptions for the inheritence.

[ste...@ziftr.com]

Hi Tony,

What is the status of the "subType" and/or "extends" support for the swagger-ui project?

Thank you,
Stephen M

[Ron]

https://github.com/wordnik/swagger-ui/issues/300

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.