Skip to content

Minor documentation improvement to fields component #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Minor documentation improvement to fields component #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions components/fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@

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

<Tip>
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.
</Tip>

## Parameter Field

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).

Check warning on line 15 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

components/fields.mdx#L15 

Did you really mean 'SDKs'?

<ParamField path="param" type="string" required>
An example of a parameter field
Expand Down