Parameters Reference
Complete reference for REST API parameters including path, query, header, and cookie parameters.
Parameters define input values for REST API endpoints. NeoArc supports path, query, header, and cookie parameters.
Parameter Properties
| Property | Type | Description |
|---|---|---|
| name | string | Parameter name |
| in | enum | Location (path, query, header, cookie) |
| description | string | Parameter description |
| required | boolean | Whether parameter is required |
| deprecated | boolean | Deprecation flag |
| schema | object | Data type and validation rules |
Parameter Locations
Schema Properties
| Property | Description |
|---|---|
| type | Data type (string, integer, number, boolean, array) |
| format | Format hint (date, date-time, email, uuid, etc.) |
| enum | List of allowed values |
| default | Default value if not provided |
| minimum/maximum | Numeric bounds (inclusive) |
| minLength/maxLength | String length bounds |
| pattern | Regular expression pattern |
Array Parameters
| Property | Description |
|---|---|
| items | Schema for array items |
| style | Serialisation style (form, spaceDelimited, pipeDelimited) |
| explode | How arrays are serialised (true: a=1&a=2, false: a=1,2) |