Skip to main content

Interface: ParamText

A free-form text parameter.

Extends​

Properties​

id​

id: string

Stable parameter identifier within the endpoint.

Inherited from​

ParamBase.id

label​

label: string

Human-readable form label.

Inherited from​

ParamBase.label

description?​

optional description?: string

Optional usage guidance displayed by clients.

Inherited from​

ParamBase.description

hidden?​

optional hidden?: boolean

Hides the input from the user while allowing clients to provide a value.

Inherited from​

ParamBase.hidden

required?​

optional required?: boolean

Whether callers must provide a value.

Inherited from​

ParamBase.required

role?​

optional role?: ServiceParameterRole

Lets the application map a parameter without relying on its ID.

Inherited from​

ParamBase.role

value?​

optional value?: string

Default or preselected value serialized as a string.

Inherited from​

ParamBase.value

type​

type: "text"

Discriminator for a text parameter.