Parameter objects can be defined inline or be a reference to a parameter of the parameters list.
Element | Used By Importer | Description | More Information at ... |
---|---|---|---|
name | The name of the parameter. Parameter names are case sensitive.
| See Path Templating for further information. | |
in | () | The location of the parameter. Possible values are "query", "header", "path" or "body". | |
description | A brief description of the parameter | ||
required | Determines whether this parameter is mandatory. If true, the multiplicity of the parameter is set to 1, else it is set to 0..1. | ||
schema | If in is "body", schema defines the type used for the body parameter. | Schema Object | |
type | if in is other than "body", type defines the type of the parameter.
| ||
format | The format of the object is used to be more specific when the type is string. | ||
items | The item is a schema object to define the type of element in the array. Only used if type is array. | Schema Object |
Overview
Content Tools