mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
3a37747f1b
* Update Quickstart page for style and clarity - Improve readability and flow - Make language more concise and consistent - Remove unnecessary periods from numbered lists - Clarify instructions and terminology 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Expandables component page - Add clear introduction explaining the component's purpose - Remove unnecessary period from description - Improve formatting consistency for boolean values - Enhance clarity in prop descriptions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Fields component page - Add clear introduction explaining field components - Improve consistency in component naming conventions - Remove unnecessary periods from descriptions - Improve punctuation and clarity - Add comma for better readability in example 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Icons component page - Add clear introduction explaining the Icon component - Improve language clarity and flow - Remove unnecessary periods from prop descriptions - Replace 'e.g.' with 'for example' for consistency - Remove trailing space from inline example 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Mermaid diagrams page - Add clear introduction explaining Mermaid's purpose and capabilities - Improve clarity and conciseness of descriptions - Simplify section heading from 'Syntax for Mermaid diagrams' to 'Syntax' - Make language more precise and user-focused - Update code comment to be more generic 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Steps component page - Add clear introduction explaining the Steps component - Improve language clarity and consistency - Remove unnecessary periods from prop descriptions - Add Oxford comma for better readability - Make description more action-oriented 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Tabs component page - Add clear introduction explaining the Tabs component purpose - Improve clarity and user understanding - Remove unnecessary period from prop description - Make description more informative about component functionality 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Migrations guide page - Improve language clarity and conciseness - Remove unnecessary periods from command descriptions - Enhance section structure with proper headings - Update terminology for consistency - Add OpenAPI migration section header for better organization 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update React components page - Improve language clarity and conciseness throughout - Simplify and tighten explanatory text - Fix capitalization in performance best practices - Remove redundant phrases for better flow - Enhance readability and user experience 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Redirects and broken links page - Improve language clarity and conciseness - Remove unnecessary words like 'Simply' and 'will' - Use present tense for more direct communication - Fix preposition usage for better grammar - Streamline explanations for better readability 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Support integrations page - Improve language clarity and directness - Remove unnecessary words for better flow - Use more direct phrasing for instructions - Simplify conditional language for better readability 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Update CI checks page - Improve language clarity and conciseness throughout - Remove unnecessary words and phrases - Use present tense for more direct communication - Fix grammar issues and improve flow - Replace 'in-built' with 'built-in' for standard terminology - Streamline explanations for better readability 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * quickstart edits * Update cards * Apply style lessons learned from quickstart and cards feedback - Use action-oriented introductions ("Use X to..." instead of "The X component...") - Apply sentence case to all section headings ("Properties" not "Props") - Use "Properties" consistently instead of "Props" - Remove unnecessary periods from property descriptions - Update component headings to sentence case - Make language more direct and user-focused 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * fix typo * review exapandables * update fields * update icons * update mermaid * update steps * update tabs * update migration * Update react-components.mdx * Update broken-links.mdx * Update overview.mdx * Update ci.mdx * Document style preferences learned from content refresh project Add detailed style guide based on patterns identified during DOC-84 content refresh work, including: - Heading and formatting conventions - Component introduction patterns - Property description standards - Language and tone preferences - Code example best practices - Content organization principles These learnings will help maintain consistency in future documentation updates. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * add reviewer feedback --------- Co-authored-by: Claude <noreply@anthropic.com>
104 lines
2.7 KiB
Plaintext
104 lines
2.7 KiB
Plaintext
---
|
|
title: "Fields"
|
|
description: "Set parameters for your API or SDK references"
|
|
icon: "letter-text"
|
|
---
|
|
|
|
Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.
|
|
|
|
## 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).
|
|
|
|
<ParamField path="param" type="string" required>
|
|
An example of a parameter field
|
|
</ParamField>
|
|
|
|
```mdx
|
|
<ParamField path="param" type="string" required>
|
|
An example of a parameter field
|
|
</ParamField>
|
|
```
|
|
|
|
### 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.
|
|
</ParamField>
|
|
|
|
<ParamField body="type" type="string">
|
|
Expected type of the parameter's value.
|
|
|
|
Supports `number`, `string`, `boolean`, `object`.
|
|
|
|
Arrays can be defined using the `[]` suffix. For example, `string[]`.
|
|
</ParamField>
|
|
|
|
<ParamField body="required" type="boolean">
|
|
Indicate whether the parameter is required.
|
|
</ParamField>
|
|
|
|
<ParamField body="deprecated" type="boolean">
|
|
Indicate whether the parameter is deprecated.
|
|
</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.
|
|
</ParamField>
|
|
|
|
<ParamField body="placeholder" type="string">
|
|
Placeholder text for the input in the playground.
|
|
</ParamField>
|
|
|
|
<ParamField body="children" type="string">
|
|
Description of the parameter (Markdown-enabled).
|
|
</ParamField>
|
|
|
|
## Response field
|
|
|
|
The `<ResponseField>` component defines the return values of an API.
|
|
|
|
<ResponseField name="response" type="string" required>
|
|
An example of a response field
|
|
</ResponseField>
|
|
|
|
```mdx
|
|
<ResponseField name="response" type="string" required>
|
|
A response field example
|
|
</ResponseField>
|
|
```
|
|
|
|
### Properties
|
|
|
|
<ResponseField name="name" type="string" required>
|
|
The name of the response value.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="type" type="string" required>
|
|
Expected type of the response value. This can be any arbitrary string.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="default" type="string">
|
|
The default value.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="required" type="boolean">
|
|
Indicate whether the response is required.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="deprecated" type="boolean">
|
|
Whether a field is deprecated.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="pre" type="string[]">
|
|
Labels that are shown before the name of the field.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="post" type="string[]">
|
|
Labels that are shown after the name of the field.
|
|
</ResponseField>
|