You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ParamFieldbody="query, path, body, or header"type="string">
42
-
Whether it is a query, path, body, or header parameter followed by the name
26
+
Whether the parameter is a query, path, body, or header. Followed by the parameter name.
43
27
</ParamField>
44
28
45
29
<ParamFieldbody="type"type="string">
46
-
Expected type of the parameter's value
30
+
Expected type of the parameter's value.
47
31
48
-
Supports `number`, `string`, `bool`, `object`.
32
+
Supports `number`, `string`, `boolean`, `object`.
49
33
50
34
Arrays can be defined using the `[]` suffix. For example, `string[]`.
51
35
</ParamField>
52
36
53
37
<ParamFieldbody="required"type="boolean">
54
-
Indicate whether the parameter is required
38
+
Indicate whether the parameter is required.
55
39
</ParamField>
56
40
57
41
<ParamFieldbody="deprecated"type="boolean">
58
-
Indicate whether the parameter is deprecated
42
+
Indicate whether the parameter is deprecated.
59
43
</ParamField>
60
44
61
45
<ParamFieldbody="default"type="string">
62
-
Default value used by the server if the request does not provide a value
46
+
Default value used by the server if the request does not provide a value.
63
47
</ParamField>
64
48
65
49
<ParamFieldbody="initialValue"type="any">
66
-
Value that will be used to initialize the playground
50
+
Value that will be used to initialize the playground.
67
51
</ParamField>
68
52
69
53
<ParamFieldbody="placeholder"type="string">
70
-
Placeholder text for the input in the playground
54
+
Placeholder text for the input in the playground.
71
55
</ParamField>
72
56
73
57
<ParamFieldbody="children"type="string">
74
-
Description of the parameter (markdown enabled)
58
+
Description of the parameter (Markdown-enabled).
75
59
</ParamField>
76
60
77
61
## Response field
78
62
79
-
The `<ResponseField>` component defines the return values of an API. Many docs also use `<ResponseField>` on pages when you need to list the types of something.
63
+
The `<ResponseField>` component defines the return values of an API.
0 commit comments