apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.64k stars 2.14k forks source link

How do I get the docs to show array response schema correctly? #313

Closed akutz closed 8 years ago

akutz commented 8 years ago

I think this question is linked to #237. Take the following example:

Get [GET]

Gets information about all volumes for a service.

  • Response 200 (application/json)

    • Attributes (array)
    • (Volume)
    • Body
    [
        {
            "id":     "vol-000",
            "name":   "Volume-000",
            "size":   10240,
            "fields": {
                "priority": 2,
                "owner":    "sakutz@gmail.com"
            }
        },
        {
            "id":     "vol-001",
            "name":   "Volume-001",
            "size":   10240,
            "fields": {
                "priority": 2,
                "owner":    "sakutz@gmail.com"
            }
        }
    ]

Here is the documentation this produces:

image

I would like the Attributes section to do a better job illustrating that there is an array of Volume objects being returned. Is there a way I can define the response so that this occurs? Thank you :)

zdne commented 8 years ago

Hi @akutz this should be fixed soon with #254 and #191

neerajjain92 commented 3 years ago

@zdne How soon? it's not yet fixed.