Parameter
Summary
An API operation parameter for a Method, as part of the APIDefinition.
Description
Parameters describe the inputs for the API operation. The name, paramType, required, and type are all required fields.
Fields
| Field Name | Type | Since Version | Description |
|---|---|---|---|
name |
String | The parameter name. | |
type |
String | The parameter data type, e.g. boolean, byte, date, double, float, integer, long, string, or a type name found in APIDefinition models. | |
format |
String | none | |
paramType |
String | The parameter type, e.g. query, form, path, body, header | |
description |
String | none | |
required |
Boolean | Indicates that the parameter is required | |
allowMultiple |
Boolean | Indicates that the parameter can be included multiple times (e.g. query or form) | |
items |
SchemaObject | none | |
defaultValue |
String | Provides a default value for the parameter | |
schema |
SchemaObject | The response schema |