diff --git a/packages/chronicle/src/components/api/api-field-list.module.css b/packages/chronicle/src/components/api/api-field-list.module.css index bf91645..a8d551b 100644 --- a/packages/chronicle/src/components/api/api-field-list.module.css +++ b/packages/chronicle/src/components/api/api-field-list.module.css @@ -30,6 +30,20 @@ color: var(--rs-color-foreground-base-secondary); } +.fieldExample { + font-size: var(--rs-font-size-small); + line-height: var(--rs-line-height-small); + color: var(--rs-color-foreground-base-tertiary); +} + +.fieldExample code { + font-family: var(--rs-font-mono); + font-size: var(--rs-font-size-mono-small); + background: var(--rs-color-background-neutral-secondary); + padding: 1px var(--rs-space-2); + border-radius: 3px; +} + .statusDescription { font-size: var(--rs-font-size-regular); line-height: var(--rs-line-height-regular); diff --git a/packages/chronicle/src/components/api/api-field-list.tsx b/packages/chronicle/src/components/api/api-field-list.tsx index 7a2876c..a4f2da4 100644 --- a/packages/chronicle/src/components/api/api-field-list.tsx +++ b/packages/chronicle/src/components/api/api-field-list.tsx @@ -44,10 +44,14 @@ function FieldItem({ field }: { field: SchemaField }) { {field.name} {field.type} + {field.required && required} {field.description && ( {field.description} )} + {field.example !== undefined && ( + Example: {JSON.stringify(field.example)} + )} {hasChildren && } ) diff --git a/packages/chronicle/src/components/api/api-overview.module.css b/packages/chronicle/src/components/api/api-overview.module.css index 1b3917d..29e4d19 100644 --- a/packages/chronicle/src/components/api/api-overview.module.css +++ b/packages/chronicle/src/components/api/api-overview.module.css @@ -49,7 +49,7 @@ .divider { padding: 0; - margin: var(--rs-space-2) 0; + margin: var(--rs-space-4) 0; } @media (max-width: 1100px) { diff --git a/packages/chronicle/src/components/api/api-overview.tsx b/packages/chronicle/src/components/api/api-overview.tsx index b92a809..76c4b01 100644 --- a/packages/chronicle/src/components/api/api-overview.tsx +++ b/packages/chronicle/src/components/api/api-overview.tsx @@ -47,7 +47,7 @@ export function ApiOverview({ method, path, operation, auth }: ApiOverviewProps) return ( - + {operation.summary && ( diff --git a/packages/chronicle/src/components/api/playground-dialog.tsx b/packages/chronicle/src/components/api/playground-dialog.tsx index 4bd1cfe..eb329d8 100644 --- a/packages/chronicle/src/components/api/playground-dialog.tsx +++ b/packages/chronicle/src/components/api/playground-dialog.tsx @@ -486,7 +486,7 @@ function BodyFieldRow({ field, value, onChange }: { return ( - {field.name} + {field.name} {field.required && required} onChange([...items, ''])} aria-label="Add item"> @@ -537,7 +537,7 @@ function BodyFieldRow({ field, value, onChange }: { return ( - {field.name} + {field.name} {field.required && required}
{JSON.stringify(field.example)}