Files
temetro/.agents/skills/ai-elements/references/schema-display.md
T
Khalid Abdi 929bec8f31 feat: AI-added records save with placeholders + "Added by AI" provenance
Stop blocking AI imports/proposals on missing non-critical fields. Records
the chat agent drafts now save with safe placeholders, auto-generated file
numbers, and a source="ai" marker that surfaces an "Added by AI" badge so a
clinician can review/edit them later.

Backend:
- add `source` (manual|ai) column to patients/appointments/prescriptions
  (migration 0014) + canonical types, services, validation schemas
- relax patient/appointment validation: empty file number allowed, demographic
  + type/provider/initials fall back to placeholders (initials derived from name)
- patients.generateFileNumber() auto-assigns an MRN when one is missing
- proposeAppointment accepts a name when no file number resolves; AI commits +
  /api/ai/import stamp source="ai"

Frontend:
- `source` on Appointment/Patient/Prescription types; AI commits send source="ai"
- reusable <AiBadge> shown on the Patients table/detail and prescriptions list

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-14 19:27:17 +03:00

2.5 KiB

Schema Display

Display REST API endpoint documentation with parameters, request/response bodies.

The SchemaDisplay component visualizes REST API endpoints with HTTP methods, paths, parameters, and request/response schemas.

See scripts/schema-display.tsx for this example.

Installation

npx ai-elements@latest add schema-display

Features

  • Color-coded HTTP methods
  • Path parameter highlighting
  • Collapsible parameters section
  • Request/response body schemas
  • Nested object property display
  • Required field indicators

Method Colors

Method Color
GET Green
POST Blue
PUT Orange
PATCH Yellow
DELETE Red

Examples

Basic Usage

See scripts/schema-display-basic.tsx for this example.

With Parameters

See scripts/schema-display-params.tsx for this example.

With Request/Response Bodies

See scripts/schema-display-body.tsx for this example.

Nested Properties

See scripts/schema-display-nested.tsx for this example.

Props

<SchemaDisplay />

Prop Type Default Description
method unknown - HTTP method.
path string - API endpoint path.
description string - Endpoint description.
parameters SchemaParameter[] - URL/query parameters.
requestBody SchemaProperty[] - Request body properties.
responseBody SchemaProperty[] - Response body properties.

SchemaParameter

interface SchemaParameter {
  name: string;
  type: string;
  required?: boolean;
  description?: string;
  location?: "path" | "query" | "header";
}

SchemaProperty

interface SchemaProperty {
  name: string;
  type: string;
  required?: boolean;
  description?: string;
  properties?: SchemaProperty[]; // For objects
  items?: SchemaProperty; // For arrays
}

Subcomponents

  • SchemaDisplayHeader - Header container
  • SchemaDisplayMethod - Color-coded method badge
  • SchemaDisplayPath - Path with highlighted parameters
  • SchemaDisplayDescription - Description text
  • SchemaDisplayContent - Content container
  • SchemaDisplayParameters - Collapsible parameters section
  • SchemaDisplayParameter - Individual parameter
  • SchemaDisplayRequest - Collapsible request body
  • SchemaDisplayResponse - Collapsible response body
  • SchemaDisplayProperty - Schema property (recursive)
  • SchemaDisplayExample - Code example block