AI-Powered Field Naming

INFO

See Getting Started with AI Features for setup requirements.

Prerequisites

Additionally, you'll need to know WHERE this feature can be used:

API Documentation: Name fields in endpoint request/response schemas

Schemas: Name fields in reusable schema definitions

Components: Name fields in component schemas

Overview

AI can generate standardized, professional, and easy-to-read field names based on your description of a specific field in the current API documentation, in accordance with the API design guidelines.

Using AI-Powered Field Naming

Step 1: Locate the AI Naming Icon

You'll see the AI naming icon next to each field in your API documentation, schemas, or components. Click the icon to begin the AI naming process.

Step 2: Provide Field Description

After clicking the AI naming icon, a prompt will appear. Enter a short description of the field to guide the AI to generate a suitable field name. You can also choose a different AI model. If you've already filled in the field description, it will automatically be used.

Step 3: Review AI-Generated Names

Click Send and the AI will generate multiple field names based on the API design guidelines, current document context, and the field description. It will also provide an explanation and rating for each name.

Step 4: Apply Your Preferred Name

You can select one of the AI-generated field names and click Adopt to apply it directly to the documentation.

📷 Complete Workflow Demo

AI-Powered Field Naming

Prerequisites#

Overview#

Using AI-Powered Field Naming#

Step 1: Locate the AI Naming Icon#

Step 2: Provide Field Description#

Step 3: Review AI-Generated Names#

Step 4: Apply Your Preferred Name#

Prerequisites

Overview

Using AI-Powered Field Naming

Step 1: Locate the AI Naming Icon

Step 2: Provide Field Description

Step 3: Review AI-Generated Names

Step 4: Apply Your Preferred Name