search

mashery / iodocs

Interactive API documentation system
MIT License
1.89k stars 415 forks source link

Unhandled parameters types prevent all endpoint parameters from being displayed. #206

Open oleduc opened 10 years ago

oleduc commented 10 years ago

If any of the parameters have an unhandled type, none of the parameters will appear under the affected endpoint.

If the endpoint has a type which is not supported by iodocs (such as "array" or "double"), then none of the parameters will appear.

Affected 9f201753f018fe74a22fdcc39217ca44a155cf3a

phairow commented 10 years ago

looks like we need to document the supported types. This is also an indicator that we need to validate the definitions before attempting to render in order to avoid unintended behavior in the UI. Otherwise the definition should only use types that are supported by the form generator. It may also make sense to add a fallback to text for unsupported types (rather than breaking) and only issue a validation warning rather than an error or breaking UI.