Skip to content

Commit 95addbd

Browse files
Documentation edits made through Mintlify web editor
1 parent 7cad13d commit 95addbd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

components/fields.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ icon: 'letter-text'
66

77
There are two types of fields: Parameter Fields and Response Fields.
88

9+
<Tip>
10+
Use Parameter Fields to document your API inputs and Response Fields to document your API outputs. This creates a consistent structure that helps developers understand your API quickly.
11+
</Tip>
12+
913
## Parameter Field
1014

1115
A `ParamField` component is used to define the parameters for your APIs or SDKs. Adding a `ParamField` will automatically add an [API Playground](/api-playground/overview).

0 commit comments

Comments
 (0)