danielgtaylor / danielgtaylor/aglio

Rendering "attributes" section and Data Structures

Open
#103 77 comments 26 reactions 0 assignees View on GitHub
feature request needs work
Dominant language
CoffeeScript
Stars
4.7k
Forks
471
PR merge metrics
No merged PRs in 30d

Description

Aglio looks fantastic but I have problems rendering complex cases as such:

I have this file: https://raw.githubusercontent.com/samwiseapi/apiary-samwise/master/apiary.apib

where I got
a) "attributes" sections such as

```
+ Response 200 (application/json)
+ Attributes (SampleDTO)
```

b) custom Data Structures such as
(note the SampleProperties which is itself a custom Data Structure)

```
# Data Structures

## SampleDTO (object)
+ SampleId: 123456789 (number, required) - Sample ID
+ SampleProperties: SamplePropertiesDTO
+ ClientSampleId: 1 (number, optional) - Identifier of Sample ID received from client in request
+ Events (array[SamplePropertiesDTO], required) - Collection of sample events
```

when I run the file agains aglio, these parts are ignored apparently. Would it be possible to add rendering to aglio for these?

apiary.io renders Attribute section as a table and does not have Data Structures and nested data structures render working but there are plans http://stackoverflow.com/questions/29848375/apiblueprint-structures-to-achieve-desired-description/29901429#29901429 - check here. I though like aglio design more.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.