Can i define nested array objects in swagger 2.0

Question

We are using Swagger 2.0 for our documentation. We are Pro-grammatically creating swagger 2.0 spec straight out our data design documents.

Our Model is very complex and nested. I would like to understand can we define nested array objects defined inline.

for e.g :

{
    "definitions": {
        "user": {
            "type": "object",
            "required": ["name"],
            "properties": {
                "name": {
                    "type": "string"
                },
                "address": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "type": {
                                "type": "string",
                                "enum": ["home",
                                "office"]
                            },
                            "line1": {
                                "type": "string"
                            }
                        },
                        "Person": {
                            "type": "object",
                            "properties": {
                                "name": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

We have many cases where we encounter this in our model and defining a #ref is not an option that we want to consider at this time. We need this to handled inline.

As per the following post : https://github.com/swagger-api/swagger-editor/issues/603#evenenter code heret-391465196 looks like its not supported to handle nested array objects defined inline.

Since lot of big enterprise's have a very complex data model we would like to have this this feature to be supported in swagger 2.0 spec.

Is there any thought on this feature to be added.

Looks like this question rather belongs to the swagger homepage / forum / bugtracker. — m02ph3u5
– m02ph3u5, Commented Aug 27, 2015 at 18:43
Many frameworks will create $ref schemas for you automatically. Can you share more of why that's not possible from a modeling point of view? — fehguy
– fehguy, Commented Aug 28, 2015 at 2:31
@fehguy can you please point us to some frameworks that will create $ref schemas. — Darshan Shivashankar
– Darshan Shivashankar, Commented Aug 28, 2015 at 3:11
Well, the swagger-supported swagger-jaxrs will do this. If you have a property which is a complex type, the $ref will automatically be created. — fehguy
– fehguy, Commented Aug 31, 2015 at 2:47
Check this URL, it's not marked as solved, but I think it's fine: link — Elbassel
– Elbassel, Commented Dec 22, 2016 at 15:47

dolmen · Accepted Answer · 2015-09-29 12:46:56Z

3

You document is just invalid and this is not about nested arrays: the property Person is not allowed in a Swagger 2.0 schema inside items.

The only allowed properties in a schema are: $ref, format, title, description, default, multipleOf, maximum, exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, maxItems, minItems, uniqueItems, maxProperties, minProperties, required, enum, additionalProperties, type, items, allOf, properties, discriminator, readOnly, xml, externalDocs, example.

answered Sep 29, 2015 at 12:46

dolmen

8,8905 gold badges44 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Can i define nested array objects in swagger 2.0

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related