Skip to content

Remove initialValue and edit description of default in ParamField #916

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 3 commits into from
Jul 28, 2025
Merged

Remove initialValue and edit description of default in ParamField #916

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08e2539
Change mentions of introduction.mdx to index.mdx
mycho2003 Jun 27, 2025
ba8a3af
Remove initial value and edit description of default
mycho2003 Jul 15, 2025
ac14e91
Merge branch 'main' into michael/removeinitialvalue
mycho2003 Jul 24, 2025
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
9 changes: 3 additions & 6 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 @@ -31,7 +31,8 @@

Supports `number`, `string`, `boolean`, `object`.

Arrays can be defined using the `[]` suffix. For example, `string[]`.
Arrays can be defined using the `[]` suffix. For example `string[]`.

</ParamField>

<ParamField body="required" type="boolean">
Expand All @@ -43,11 +44,7 @@
</ParamField>

<ParamField body="default" type="string">
Default value used by the server if the request does not provide a value.
</ParamField>

<ParamField body="initialValue" type="any">
Value that will be used to initialize the playground.
Default value populated when the request value is empty
</ParamField>

<ParamField body="placeholder" type="string">
Expand Down