BlueBird v0.3.1 BlueBird.Parameter
Defines the Parameter
struct.
Link to this section Summary
Link to this section Types
Type that represents the Parameter struct.
name
: The name as it appears in the url, e.g."id"
for the path/users/:id
.type
: For example"string"
,"boolean"
,"number"
etc. You can also set it to"enum[<type>]"
(replace<type>
with the actual type).members
(optional): List of possible values for the enum type.description
(optional): A description of the parameter.additional_desc
(optional): Even more room for descriptions.default
(optional): The default value for this parameter.example
(optional): An example value for the parameter.optional
(optional): Set to true to mark the parameter as optional. oroptional
. Will not display anything if not set.