# OpenApiParameter

A path or query parameter of an HTTP connector.

**Kind:** an object, used in requests and responses. In a request it is called `OpenApiParameterInput`.

## In a request

| Field | Type | Required | Description |
|---|---|---|---|
| `description` | `string` | yes | What the parameter means. The model reads it when it fills the parameter in. Constraints: required (empty or whitespace-only strings are rejected). |
| `name` | `string` | yes | The parameter's name, as the endpoint expects it. Constraints: required (empty or whitespace-only strings are rejected). |
| `dataType` | [`OpenApiParameterDataType`](https://docs.maitento.com/reference/types/open-api-parameter-data-type.md) |  | The type of value the parameter takes. |
| `isRequired` | `boolean` |  | Whether every call must give the parameter. |

```json
{
  "description": "...",
  "name": "...",
  "dataType": "String",
  "isRequired": false
}
```

## In a response

Every field is present in a response; empty ones are `null`.

| Field | Type | Description |
|---|---|---|
| `description` | `string` | What the parameter means. The model reads it when it fills the parameter in. Constraints: required (empty or whitespace-only strings are rejected). |
| `name` | `string` | The parameter's name, as the endpoint expects it. Constraints: required (empty or whitespace-only strings are rejected). |
| `dataType` | [`OpenApiParameterDataType`](https://docs.maitento.com/reference/types/open-api-parameter-data-type.md) | The type of value the parameter takes. |
| `isRequired` | `boolean` | Whether every call must give the parameter. |

```json
{
  "description": "...",
  "name": "...",
  "dataType": "String",
  "isRequired": false
}
```

## Where it's used

- Inside [`OpenApiConnectorCreateRequest`](https://docs.maitento.com/reference/types/open-api-connector-create-request.md)
- Inside [`OpenApiConnectorVersion`](https://docs.maitento.com/reference/types/open-api-connector-version.md)