Array of schema inside another schema

[rhazegh]

I want to define a swagger schema/model for Book that has and array of chapters inside. I want the following JSON:

{
  "name": "string",
  "num_pages": 0,
  "chapters": [
    {
      "title": "string",
      "text": "string"
    }
  ]
}

So I defined the following two swagger schemas:

  swagger_schema :Chapter do
    property :title do
      key :type, :string
    end
    property :text do
      key :type, :string
    end
  end

  swagger_schema :Book do
    property :name do
      key :type, :string
    end
    property :num_pages do
      key :type, :integer
      key :format, :int64
    end
    property :chapters do
      key :'$ref', :Chapter
      key :type, :array
    end
  end

But I end up getting the following in the generated swagger documentation for Book:

{
  "name": "string",
  "num_pages": 0,
  "chapters": 
    {
      "title": "string",
      "text": "string"
    }
}

What is the proper way to define an array of a schema inside another schema?

[fotinakis]

The keys are case-sensitve, can you try :Chapter instead of :chapter?

[rhazegh]

My bad. I corrected the typo I made above. I just fabricated the above example to describe the problem I am having. My real models have so many properties and the capitalization is correct on the actual models.

[fotinakis]

Also, in Swagger JSON I believe you must use an items definition if you use the array type anywhere.

[rhazegh]

yes, I tried to use items later, but what is the swagger-blocks syntax for it?

[fotinakis]

I just added an example for arrays in schema objects. So you would do something like:

    property :chapters do
      key :type, :array
      items do
        key :'$ref', :Chapter
      end
    end

Let me know if that works.

[rhazegh]

Yes it works 👍 Thank you 😃

[ayadavkrt]

property :something do
      key :type, :array
      items do
        key :'$ref', :Chapter
        key :'$ref', :Disaster
        key :'$ref', :Creator
      end
    end

How can one do this ???