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
+3 −6
Merged

Remove initialValue and edit description of default in ParamField #916

Show file tree
Hide file tree
Changes from 2 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
11 changes: 4 additions & 7 deletions components/fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: "Fields"
description: "Set parameters for your API or SDK references"
icon: 'letter-text'
icon: "letter-text"
---

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

## 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 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 Down Expand Up @@ -47,7 +47,8 @@

Supports `number`, `string`, `bool`, `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 @@ -59,11 +60,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
8 changes: 4 additions & 4 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ pnpm add -g mint

After you set up your environment, you can start editing your documentation files. For example, update the title of the introduction page:

Open your repository created during onboarding, find the `introduction.mdx` file, and find the top of the file:
Open your repository created during onboarding, find the `index.mdx` file, and find the top of the file:

```mdx introduction.mdx
```mdx index.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
Expand All @@ -118,7 +118,7 @@ description: "This is the introduction to the documentation"

Update the `title` field to `"Hello World"`.

```mdx introduction.mdx {2}
```mdx index.mdx {2}
---
title: "Hello World"
description: "This is the introduction to the documentation"
Expand Down Expand Up @@ -174,7 +174,7 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf

In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:

Find and select `introduction.mdx` in the file explorer.
Find and select `index.mdx` in the file explorer.

Then, in the editor, update the title field to "Hello World".

Expand Down