Modifying Schemas with AI
Overview#
AI can help you quickly refine your schemas by adding field descriptions, mock rules, and more β making it easier to keep your documentation complete and consistent.The AI assistant can help with:| Task | Description |
|---|
| Field Descriptions | Generate clear, contextual descriptions for schema fields |
| Mock Rules | Create realistic mock data rules for testing |
| Schema Refinement | Improve overall schema structure and completeness |
| Batch Updates | Apply changes to multiple fields at once |
Using AI to Modify Schemas#
Step 1: Access the AI Feature#
On the endpoint edit page or schema pages, hover over any schema section to reveal the AI feature. Just click the icon to get started.Step 2: Open the AI Assistant#
Clicking the AI button opens a side-by-side pop-up window:On the left, you'll see the current schemas.
On the right, you'll find the AI assistant, where you can chat naturally and ask for updates to the schemas based on your needs.
Step 3: Use Quick Suggestions or Custom Prompts#
To make things even easier, we've included a few one-click suggestions for common edits β just tap to let the AI generate content for you. Alternatively, you can type custom instructions in natural language.π· AI Schema Modification Demo
Step 4: Review and Apply Changes#
If you need to fine-tune the AI-generated content, you can edit it directly in the pop-up. Once everything looks good, click the Apply button at the bottom-right corner to save all changes to the schemas.Modified atΒ 2026-01-23 07:17:04
