diff --git a/.changeset/kind-baboons-sort.md b/.changeset/kind-baboons-sort.md new file mode 100644 index 000000000..48aab4f3c --- /dev/null +++ b/.changeset/kind-baboons-sort.md @@ -0,0 +1,5 @@ +--- +'@gitbook/react-openapi': patch +--- + +Fix OpenAPI example display error diff --git a/packages/react-openapi/src/OpenAPISchema.tsx b/packages/react-openapi/src/OpenAPISchema.tsx index 31cddaa0b..7d93e2ef9 100644 --- a/packages/react-openapi/src/OpenAPISchema.tsx +++ b/packages/react-openapi/src/OpenAPISchema.tsx @@ -217,7 +217,7 @@ function OpenAPISchemaPresentation(props: { property: OpenAPISchemaPropertyEntry propertyName={propertyName} required={required} /> - {schema['x-deprecated-sunset'] ? ( + {typeof schema['x-deprecated-sunset'] === 'string' ? (
Sunset date:{' '} @@ -228,7 +228,7 @@ function OpenAPISchemaPresentation(props: { property: OpenAPISchemaPropertyEntry {description ? ( ) : null} - {example ? ( + {typeof example === 'string' ? (
Example: {example}
diff --git a/packages/react-openapi/src/utils.ts b/packages/react-openapi/src/utils.ts index a9fd74f13..2a6ce7b84 100644 --- a/packages/react-openapi/src/utils.ts +++ b/packages/react-openapi/src/utils.ts @@ -51,12 +51,12 @@ export function extractDescriptions(object: AnyObject) { /** * Resolve the first example from an object. */ -export function resolveFirstExample(object: AnyObject) { +export function resolveFirstExample(object: AnyObject): string | undefined { if ('examples' in object && typeof object.examples === 'object' && object.examples) { const keys = Object.keys(object.examples); const firstKey = keys[0]; if (firstKey && object.examples[firstKey]) { - return object.examples[firstKey]; + return formatExample(object.examples[firstKey]); } }