api-designer
api-designer copied to clipboard
Named Parameters With Multiple Types don't appear in documentation
API-designer version: 0.0.5 Browser: Chrome version: 44.0.2403.155 (64-bit) OS: Mac OS X 10.10.5
The RAML 0.8 spec says that "... the value of the named parameter property MAY be an array of mappings ...", with a named parameter defined as "URI parameters, query string parameters, form parameters, request bodies (depending on the media type), and request and response headers".
I can define a named parameter to have multiple types but it does not appear in the documentation preview. Only the first type in the array is shown.
Example - not in error according to the editor panel:
#%RAML 0.8
title: Testing multiple types for named parameters.
/testResource:
get:
queryParameters:
name:
- type: string
description: I am a string type query parameter.
- type: integer
description: I am an integer type query parameter, which is an alternative option.
Documentation shows only the name parameter:
QUERY PARAMETERS
name : string