subTypes not displayed in model

[rpofuk]

Hi!

I have service and model definition:
SERVICE:

"path" : "/process/start",
    "operations" : [ {
      "method" : "POST",
      "nickname" : "startProcess",
      "type" : "void",
      "parameters" : [ {
        "type" : "array",
        "items" : {
          "$ref" : "ProcessTaskDTO"
        },
        "paramType" : "body",
        "name" : "tasks",
        "required" : true
      }, {
        "type" : "string",
        "paramType" : "query",
        "name" : "token"
      } ],
      "consumes" : [ "application/json" ],
      "produces" : [ "application/json" ]
    } ]

MODEL:

"ProcessTaskDTO" : {
      "id" : "ProcessTaskDTO",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        }
      }, 
      "subTypes" : ["ProcessTaskDTO1", "ProcessTaskDTO2"],
      "discriminator": "type"
    },
    "ProcessTaskDTO1" : {
      "id" : "ProcessTaskDTO1",
      "properties" : {
        "name1" : {
          "type" : "string"
        }
      }
    },
    "ProcessTaskDTO2" : {
      "id" : "ProcessTaskDTO2",
      "properties" : {
        "name2" : {
          "type" : "string"
        }
      }
    },

But model is not displayed in UI:

Found issue #300 that's closed and it's related to response class. Is request model still an issue?

[webron]

You're using an old version of the Swagger specification and some the conversion to 2.0 may not work properly. You can try the v2.0.24 tag which may have better results, but IIRC, there was never really support for sub types in older versions.

[rpofuk]

I'm compiled latest version from master.
Is the problem in specification file (json file i supply to swagger) or the swaggerui version?

[rpofuk]

I tried with v2.0.24 and 1.2 specification but still didn't work so i tried converting.

I converted my code to new spec version (2.0) and 2.1.1 version but still getting model withouth inherited entitys:

"ProcessTaskDTO": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "discriminator": "type",
      "required": [
        "type"
      ]
    },
    "ProcessFreeElementTask": {
      "allOf": [
        {
          "$ref": "#/definitions/ProcessTaskDTO"
        },
        {
          "properties": {
            "elementName": {
              "type": "string"
            }
          }
        }
      ]
    },
    "ProcessReferecedElementTaskDTO": {
      "allOf": [
        {
          "$ref": "#/definitions/ProcessTaskDTO"
        },
        {
          "properties": {
            "referecedElementId": {
              "type": "string"
            }
          }
        }
      ]
    },

[webron]

The support for allOf is currently incomplete. If you search the repository, you'll find the relevant issues.

[devigned]

Duplicate of #723

[fehguy]

@pofuk what you're seeing actually is what I would expect. Since you're missing a bit of information I'm making one assumption.

In your input, you're using the ProcessTaskDTO as the input. In your 2.0 spec version, there are only 3 fields, all of which you're seeing in the UI. Likewise for the output, I'm guessing that's the output model that you have.

If you changed the input model to, say ProcessReferecedElementTaskDTO you would have the additional field referecedElementId.

That said, what are you expecting? Or did I get it wrong regarding the input type?

[mgttlinger]

As I understand the spec if you specify a discriminator your types get treated as a polymorphic hierarchy and therefore the subtypes ProcessFreeElementTask and ProcessReferecedElementTaskDTO should be possible values and therefore shown.

This is already implemented in the develop_2.0 branch of swagger-js but not included in the current build of swagger-ui as it uses the master branch of swagger-js.

[AlbertoLeon]

I need it subTypes and allowOf in my swagger-editor
Any plans to release it?

[mgttlinger]

@AlbertoLeon It seems as though the feature was lost (or intentionally left out) when switching the branching model because it was implemented in the dev-branch but does not seem to have been merged to the master branch. I asked about this on the google group but unfortunately got no answer.

[ikitommi]

Hi. Any news on this? Haven't seen any working examples of use of discriminator with the swagger-ui.

[DerManoMann]

👍
I'd also be interested to see an update on this - I've spend a fair number of hours trying to figure out how to get the UI to do this and there are lots of contradictionary information out there.

[greggvarona]

Was anyone able to test develop_2.0 as @mgttlinger has stated?

[mgttlinger]

@geggvarona I use a custom built version of that branch when it was still around. The implementation displayed the type of the superclass as the merged properties of the subclasses (all optional)

[dklotz]

@webron @fehguy any plans for this? It would be nice if for polymorphic input parameters, the ui could give some indication of "If you set the discriminator property to 'TYPE_A', you can use the additional fields 'X' and 'Y' and if you set it to 'TYPE_B' you can use the additional field 'Z'".