referencing objects does not work with the model

[x12a1f]

When I add a reference to another object it does not show up in the model. But the weird thing is that when I wrap the reference in an array it works:

however it does show up in the model schema:

Is this a bug or is there something wrong with my swagger file. I tried master and develop_2.0, they both gave the same result.
A stripped down version of the swagger file is shown below:

{
   "paths" : {
      "/person" : {
         "post" : {
            "parameters" : [
               {
                  "in" : "body",
                  "name" : "body",
                  "schema" : {
                     "$ref" : "Person"
                  }
               }
            ],
            "tags" : [
               "person"
            ],
            "summary" : "Create new person",
            "responses" : {
               "200" : {
                  "schema" : {
                     "$ref" : "Person"
                  },
                  "description" : "Success"
               }
            }
         }
      }
   },
   "swagger" : "2.0",
   "basePath" : "/person",
   "info" : {
      "title" : "Person API",
      "version" : "1",
      "description" : ""
   },
   "tags" : [
      {
         "name" : "person",
         "description" : "Persons"
      }
   ],
   "definitions" : {
      "map1" : {
         "type" : "object",
         "properties" : {
            "anId1" : {
               "title" : "Id",
               "type" : "string"
            }
         },
         "title" : "map1"
      },
      "map2" : {
         "type" : "object",
         "properties" : {
            "anId2" : {
               "title" : "Id",
               "type" : "string"
            }
         },
         "title" : "map2"
      },
       "Person" : {
         "type" : "object",
         "title" : "Information about a person",
         "properties" : {
            "externalId1" : {
               "title" : "first",
               "type" : "object",
               "$ref" : "#/definitions/map1"
            },
            "externalId2" : {
               "title" : "second",
                "type" : "array",
                "items": {
                    "$ref" : "#/definitions/map2"
                }
            }
         }
      }       
   }
}

[webron]

@ralphvanetten - by definition you need to use full refs. So "$ref" : "Person" should be "$ref" : "#/definitions/Person"

[ponelat]

Yes, and you need to wrap your $ref in a schema... like so
@webron, is a $ref allowed to be outside a schema, like this case?

"externalId1" : {
               "title" : "first",
               "type" : "object",
               "schema": {  // < -------------- This will make it work like you expect
                    "$ref" : "#/definitions/map1"
                } // ------------------- :)
            },
...

Then it'll work as expected (I tested :) )

[x12a1f]

Ah, yes, ofcourse... I knew it had to be some silly mistake..
Thanks!

[ponelat]

@ralphvanetten ...and by tested I mean with the latest source, so it'll be in a release soon :(
There was a bug with it, at some point. Apologies.

[x12a1f]

@ponelat oh, I guess was a bit optimistic with closing then :)

Anyway, I guess it is fixed in swagger-js? Can you tell which commit and is it documented somewhere how to use your own swagger-js instead of the default one used by swagger-ui?

Thanks.

[ponelat]

@ralphvanetten Funny you should ask! We wrote up this a few day(s) ago....
DIY: #1133 (comment)
But first a take a look at
What @mohsen1 suggests (npm link) and what I want to add as a feature...
#1220

[ponelat]

I made another guide, might be easier to maintain than the DIY version.
#1220 (comment)

[x12a1f]

When I use the develop_2.0 branch of both swagger-ui and swagger-js it is indeed fixed.

Thanks!

[webron]

So we can close the issue ;)

[x12a1f]

Actually. The correct solution is to use:

"externalId1" : {
                    "$ref" : "#/definitions/map1"
            }

As soon as you add anything else like title it does not work. See also swagger-api/swagger-js#402