Skip to content

Update the type of "default" in ParamField to be "any" #976

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

Merged
merged 1 commit into from
Jul 31, 2025
Merged

Update the type of "default" in ParamField to be "any" #976

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
5 changes: 3 additions & 2 deletions components/fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Parameter field

The `<ParamField>` component is used to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview).

Check warning on line 11 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L11 

Did you really mean 'SDKs'?

<ParamField path="param" type="string" required>
An example of a parameter field
Expand All @@ -23,7 +23,8 @@
### Properties

<ParamField body="query, path, body, or header" type="string">
Whether the parameter is a query, path, body, or header. Followed by the parameter name.
Whether the parameter is a query, path, body, or header. Followed by the
parameter name.
</ParamField>

<ParamField body="type" type="string">
Expand All @@ -43,7 +44,7 @@
Indicate whether the parameter is deprecated.
</ParamField>

<ParamField body="default" type="string">
<ParamField body="default" type="any">
Default value populated when the request value is empty
</ParamField>

Expand Down