vky / iodocs

Interactive API documentation system
MIT License
5 stars 5 forks source link

Respect list and list-only parameter types #46

Open vky opened 11 years ago

vky commented 11 years ago
{                                                                                
    "Name": "exclude_dirs",                                                      
    "Required": "N",                                                             
    "Type": "list",                                                              
    "Description": "List of directories to be excluded. | stub",                 
    "parameters": [                                                              
        {                                                                        
            "Required": "N",                                                     
            "Type": "string"                                                     
        }                                                                        
    ]                                                                            
}  

I had the idea of making use of a sub-parameter in the description of a list or list-only parameter description to determine how the parameter would be displayed.

Right now, it defaults to a string type parameter, regardless of what sub-parameter may be there. It may be useful if the other types were recognized. An array of numbers for whatever reason could be something that may be expected, and this does not handle that currently.