Parameter

The <Parameter> component is an ideal way to present API or SDK parameters.

Attributes

namestringrequired

The name of the parameter to be displayed.

---

typestringrequired

The parameter's type.

---

requiredboolean

Whether the parameter is required or not.

---

defaultstring

Define a default value to be shown with the parameter

---

Linking parameters

You can add links to name and type. For example, adding a link to the type:

<Parameter name="MyParameter" type="[MyType](/my-type)">
A Description of `MyParameter`.
</Parameter>

MyParameterMyType

A Description of MyParameter.

---