@gitbook/react-openapi 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @gitbook/react-openapi
 
+## 1.0.3
+
+### Patch Changes
+
+-   dc2dbc5: Update OpenAPI code examples to support multiple content-type
+-   f1d1d2f: Return empty string if no server provided
+-   05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
+-   b4a12d6: Fix circularRef in schema + examples OpenAPI
+-   9f0de74: Fix ID not set when there is no operation summary
+-   da55fac: Render GitBook blocks in OpenAPI operation description
+-   Updated dependencies [c808bb1]
+-   Updated dependencies [e24206e]
+-   Updated dependencies [a054554]
+-   Updated dependencies [da55fac]
+    -   @gitbook/openapi-parser@2.0.0
+
+## 1.0.2
+
+### Patch Changes
+
+-   bb5c6a4: Support multiple response media types and examples
+-   a3f1fea: Fix display of OpenAPI header description
+-   6157583: Improve Markdown parsing
+-   7419ee7: Show additional fields in OpenAPI block
+-   82cd9f2: Add support for anchor links in OpenAPI blocks
+-   Updated dependencies [6157583]
+    -   @gitbook/openapi-parser@1.0.1
+
 ## 1.0.1
 
 ### Patch Changes

package/dist/OpenAPICodeSample.jsx

@@ -12,11 +12,11 @@ var __assign = (this && this.__assign) || function () {
 import { codeSampleGenerators } from './code-samples';
 import { generateMediaTypeExample, generateSchemaExample } from './generateSchemaExample';
 import { InteractiveSection } from './InteractiveSection';
-import { getServersURL } from './OpenAPIServerURL';
 import { createStateKey } from './utils';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { checkIsReference } from './utils';
+import { getDefaultServerURL } from './util/server';
 /**
  * Display code samples to execute the operation.
  * It supports the Redocly custom syntax as well (https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples/)
@@ -52,13 +52,11 @@ export function OpenAPICodeSample(props) {
         : undefined;
     var requestBodyContent = requestBodyContentEntries === null || requestBodyContentEntries === void 0 ? void 0 : requestBodyContentEntries[0];
     var input = {
-        url: getServersURL(data.servers) +
+        url: getDefaultServerURL(data.servers) +
             data.path +
             (searchParams.size ? "?".concat(searchParams.toString()) : ''),
         method: data.method,
-        body: requestBodyContent
-            ? generateMediaTypeExample(requestBodyContent[1], { onlyRequired: true })
-            : undefined,
+        body: requestBodyContent ? generateMediaTypeExample(requestBodyContent[1]) : undefined,
         headers: __assign(__assign(__assign({}, getSecurityHeaders(data.securities)), headersObject), (requestBodyContent
             ? {
                 'Content-Type': requestBodyContent[0],
@@ -68,7 +66,10 @@ export function OpenAPICodeSample(props) {
     var autoCodeSamples = codeSampleGenerators.map(function (generator) { return ({
         key: "default-".concat(generator.id),
         label: generator.label,
-        body: <context.CodeBlock code={generator.generate(input)} syntax={generator.syntax}/>,
+        body: context.renderCodeBlock({
+            code: generator.generate(input),
+            syntax: generator.syntax,
+        }),
     }); });
     // Use custom samples if defined
     var customCodeSamples = null;
@@ -84,7 +85,10 @@ export function OpenAPICodeSample(props) {
                 .map(function (sample) { return ({
                 key: "redocly-".concat(sample.lang),
                 label: sample.label,
-                body: <context.CodeBlock code={sample.source} syntax={sample.lang}/>,
+                body: context.renderCodeBlock({
+                    code: sample.source,
+                    syntax: sample.lang,
+                }),
             }); });
         }
     });

package/dist/OpenAPIOperation.jsx

@@ -17,12 +17,14 @@ export function OpenAPIOperation(props) {
         icons: context.icons,
         blockKey: context.blockKey,
     };
-    var description = (_a = resolveDescription(operation)) === null || _a === void 0 ? void 0 : _a.trim();
     return (<div className={clsx('openapi-operation', className)}>
-            <div className="openapi-summary" id={context.id}>
-                <h2 className="openapi-summary-title" data-deprecated={operation.deprecated}>
-                    {operation.summary}
-                </h2>
+            <div className="openapi-summary" id={operation.summary ? undefined : context.id}>
+                {operation.summary
+            ? context.renderHeading({
+                deprecated: (_a = operation.deprecated) !== null && _a !== void 0 ? _a : false,
+                title: operation.summary,
+            })
+            : null}
                 {operation.deprecated && <div className="openapi-deprecated">Deprecated</div>}
             </div>
             <div className="openapi-columns">
@@ -34,9 +36,7 @@ export function OpenAPIOperation(props) {
                             </span>
                             {"."}
                         </div>) : null}
-                    {description ? (<div className="openapi-intro">
-                            <Markdown className="openapi-description" source={description}/>
-                        </div>) : null}
+                    <OpenAPIOperationDescription operation={operation} context={context}/>
                     <OpenAPIPath data={data} context={context}/>
                     <OpenAPISpec data={data} context={clientContext}/>
                 </div>
@@ -49,3 +49,20 @@ export function OpenAPIOperation(props) {
             </div>
         </div>);
 }
+function OpenAPIOperationDescription(props) {
+    var operation = props.operation;
+    if (operation['x-gitbook-description-document']) {
+        return (<div className="openapi-intro">
+                {props.context.renderDocument({
+                document: operation['x-gitbook-description-document'],
+            })}
+            </div>);
+    }
+    var description = resolveDescription(operation);
+    if (!description) {
+        return null;
+    }
+    return (<div className="openapi-intro">
+            <Markdown className="openapi-description" source={description}/>
+        </div>);
+}

package/dist/OpenAPIResponse.jsx

@@ -1,11 +1,22 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 import { OpenAPISchemaProperties } from './OpenAPISchema';
-import { resolveDescription } from './utils';
+import { parameterToProperty, resolveDescription } from './utils';
 import { OpenAPIDisclosure } from './OpenAPIDisclosure';
 /**
  * Display an interactive response body.
  */
 export function OpenAPIResponse(props) {
-    var _a, _b, _c;
+    var _a, _b;
     var response = props.response, context = props.context, mediaType = props.mediaType;
     var headers = Object.entries((_a = response.headers) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
         var name = _a[0], header = _a[1];
@@ -17,23 +28,14 @@ export function OpenAPIResponse(props) {
         return null;
     }
     return (<div className="openapi-response-body">
-            {headers.length > 0 ? (<OpenAPIDisclosure context={context} label={'Headers'}>
+            {headers.length > 0 ? (<OpenAPIDisclosure context={context} label="Headers">
                     <OpenAPISchemaProperties properties={headers.map(function (_a) {
-                var _b;
                 var name = _a[0], header = _a[1];
-                return ({
-                    propertyName: name,
-                    schema: (_b = header.schema) !== null && _b !== void 0 ? _b : {},
-                    required: header.required,
-                });
+                return parameterToProperty(__assign({ name: name }, header));
             })} context={context}/>
                 </OpenAPIDisclosure>) : null}
             <div className="openapi-responsebody">
-                <OpenAPISchemaProperties id={"response-".concat(context.blockKey)} properties={[
-            {
-                schema: (_c = mediaType.schema) !== null && _c !== void 0 ? _c : {},
-            },
-        ]} context={context}/>
+                <OpenAPISchemaProperties id={"response-".concat(context.blockKey)} properties={mediaType.schema ? [{ schema: mediaType.schema }] : []} context={context}/>
             </div>
         </div>);
 }

package/dist/OpenAPIResponseExample.jsx

@@ -1,8 +1,9 @@
 import { generateSchemaExample } from './generateSchemaExample';
 import { checkIsReference, createStateKey, resolveDescription } from './utils';
-import { stringifyOpenAPI } from './stringifyOpenAPI';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { InteractiveSection } from './InteractiveSection';
+import { json2xml } from './json2xml';
+import { stringifyOpenAPI } from './stringifyOpenAPI';
 /**
  * Display an example of the response content.
  */
@@ -31,78 +32,187 @@ export function OpenAPIResponseExample(props) {
         }
         return Number(a) - Number(b);
     });
-    var examples = responses
+    var tabs = responses
         .map(function (_a) {
-        var key = _a[0], value = _a[1];
-        var responseObject = value;
-        var mediaTypeObject = (function () {
-            var _a;
-            if (!responseObject.content) {
-                return null;
-            }
-            var key = Object.keys(responseObject.content)[0];
-            return ((_a = responseObject.content['application/json']) !== null && _a !== void 0 ? _a : (key ? responseObject.content[key] : null));
-        })();
-        if (!mediaTypeObject) {
+        var key = _a[0], responseObject = _a[1];
+        var description = resolveDescription(responseObject);
+        if (checkIsReference(responseObject)) {
+            return {
+                key: key,
+                label: key,
+                description: description,
+                body: (<OpenAPIExample example={getExampleFromReference(responseObject)} context={context} syntax="json"/>),
+            };
+        }
+        if (!responseObject.content || Object.keys(responseObject.content).length === 0) {
             return {
                 key: key,
                 label: key,
-                description: resolveDescription(responseObject),
+                description: description,
                 body: <OpenAPIEmptyResponseExample />,
             };
         }
-        var example = handleUnresolvedReference((function () {
-            var examples = mediaTypeObject.examples, example = mediaTypeObject.example;
-            if (examples) {
-                var key_1 = Object.keys(examples)[0];
-                if (key_1) {
-                    // @TODO handle multiple examples
-                    var firstExample = examples[key_1];
-                    if (firstExample) {
-                        return firstExample;
-                    }
-                }
-            }
-            if (example) {
-                return { value: example };
-            }
-            var schema = mediaTypeObject.schema;
-            if (!schema) {
-                return null;
-            }
-            return { value: generateSchemaExample(schema) };
-        })());
         return {
             key: key,
             label: key,
             description: resolveDescription(responseObject),
-            body: (example === null || example === void 0 ? void 0 : example.value) ? (<context.CodeBlock code={typeof example.value === 'string'
-                    ? example.value
-                    : stringifyOpenAPI(example.value, null, 2)} syntax="json"/>) : (<OpenAPIEmptyResponseExample />),
+            body: <OpenAPIResponse context={context} content={responseObject.content}/>,
         };
     })
         .filter(function (val) {
         return Boolean(val);
     });
-    if (examples.length === 0) {
+    if (tabs.length === 0) {
         return null;
     }
-    return (<OpenAPITabs stateKey={createStateKey('response-example')} items={examples}>
+    return (<OpenAPITabs stateKey={createStateKey('response-example')} items={tabs}>
             <InteractiveSection header={<OpenAPITabsList />} className="openapi-response-example">
                 <OpenAPITabsPanels />
             </InteractiveSection>
         </OpenAPITabs>);
 }
+function OpenAPIResponse(props) {
+    var context = props.context, content = props.content;
+    var entries = Object.entries(content);
+    var firstEntry = entries[0];
+    if (!firstEntry) {
+        throw new Error('One media type is required');
+    }
+    if (entries.length === 1) {
+        var mediaType = firstEntry[0], mediaTypeObject = firstEntry[1];
+        return (<OpenAPIResponseMediaType context={context} mediaType={mediaType} mediaTypeObject={mediaTypeObject}/>);
+    }
+    var tabs = entries.map(function (entry) {
+        var mediaType = entry[0], mediaTypeObject = entry[1];
+        return {
+            key: mediaType,
+            label: mediaType,
+            body: (<OpenAPIResponseMediaType context={context} mediaType={mediaType} mediaTypeObject={mediaTypeObject}/>),
+        };
+    });
+    return (<OpenAPITabs stateKey={createStateKey('response-media-types')} items={tabs}>
+            <InteractiveSection header={<OpenAPITabsList />} className="openapi-response-media-types">
+                <OpenAPITabsPanels />
+            </InteractiveSection>
+        </OpenAPITabs>);
+}
+function OpenAPIResponseMediaType(props) {
+    var mediaTypeObject = props.mediaTypeObject, mediaType = props.mediaType;
+    var examples = getExamplesFromMediaTypeObject({ mediaTypeObject: mediaTypeObject, mediaType: mediaType });
+    var syntax = getSyntaxFromMediaType(mediaType);
+    var firstExample = examples[0];
+    if (!firstExample) {
+        return <OpenAPIEmptyResponseExample />;
+    }
+    if (examples.length === 1) {
+        return (<OpenAPIExample example={firstExample.example} context={props.context} syntax={syntax}/>);
+    }
+    var tabs = examples.map(function (example) {
+        return {
+            key: example.key,
+            label: example.example.summary || example.key,
+            body: (<OpenAPIExample example={firstExample.example} context={props.context} syntax={syntax}/>),
+        };
+    });
+    return (<OpenAPITabs stateKey={createStateKey('response-media-type-examples')} items={tabs}>
+            <InteractiveSection header={<OpenAPITabsList />} className="openapi-response-media-type-examples">
+                <OpenAPITabsPanels />
+            </InteractiveSection>
+        </OpenAPITabs>);
+}
+/**
+ * Display an example.
+ */
+function OpenAPIExample(props) {
+    var example = props.example, context = props.context, syntax = props.syntax;
+    var code = stringifyExample({ example: example, xml: syntax === 'xml' });
+    if (code === null) {
+        return <OpenAPIEmptyResponseExample />;
+    }
+    return context.renderCodeBlock({ code: code, syntax: syntax });
+}
+function stringifyExample(args) {
+    var example = args.example, xml = args.xml;
+    if (!example.value) {
+        return null;
+    }
+    if (typeof example.value === 'string') {
+        return example.value;
+    }
+    if (xml) {
+        return json2xml(example.value);
+    }
+    return stringifyOpenAPI(example.value, null, 2);
+}
+/**
+ * Get the syntax from a media type.
+ */
+function getSyntaxFromMediaType(mediaType) {
+    if (mediaType.includes('json')) {
+        return 'json';
+    }
+    if (mediaType === 'application/xml') {
+        return 'xml';
+    }
+    return 'text';
+}
+/**
+ * Get examples from a media type object.
+ */
+function getExamplesFromMediaTypeObject(args) {
+    var _a;
+    var _b, _c;
+    var mediaTypeObject = args.mediaTypeObject, mediaType = args.mediaType;
+    if (mediaTypeObject.examples) {
+        return Object.entries(mediaTypeObject.examples).map(function (_a) {
+            var key = _a[0], example = _a[1];
+            return {
+                key: key,
+                example: checkIsReference(example) ? getExampleFromReference(example) : example,
+            };
+        });
+    }
+    if (mediaTypeObject.example) {
+        return [{ key: 'default', example: { value: mediaTypeObject.example } }];
+    }
+    if (mediaTypeObject.schema) {
+        if (mediaType === 'application/xml') {
+            // @TODO normally we should use the name of the schema but we don't have it
+            // fix it when we got the reference name
+            var root = (_c = (_b = mediaTypeObject.schema.xml) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : 'object';
+            return [
+                {
+                    key: 'default',
+                    example: {
+                        value: (_a = {},
+                            _a[root] = generateSchemaExample(mediaTypeObject.schema, {
+                                xml: mediaType === 'application/xml',
+                            }),
+                            _a),
+                    },
+                },
+            ];
+        }
+        return [
+            {
+                key: 'default',
+                example: { value: generateSchemaExample(mediaTypeObject.schema) },
+            },
+        ];
+    }
+    return [];
+}
+/**
+ * Empty response example.
+ */
 function OpenAPIEmptyResponseExample() {
     return (<pre className="openapi-response-example-empty">
             <p>No body</p>
         </pre>);
 }
-function handleUnresolvedReference(input) {
-    var isReference = checkIsReference(input === null || input === void 0 ? void 0 : input.value);
-    if (isReference) {
-        // If we find a reference that wasn't resolved or needed to be resolved externally, render out the URL
-        return { value: input.value.$ref };
-    }
-    return input;
+/**
+ * Generate an example from a reference object.
+ */
+function getExampleFromReference(ref) {
+    return { summary: 'Unresolved reference', value: { $ref: ref.$ref } };
 }

package/dist/OpenAPISchema.d.ts

@@ -2,8 +2,8 @@ import type { OpenAPIV3 } from '@gitbook/openapi-parser';
 import type { OpenAPIClientContext } from './types';
 type CircularRefsIds = Map<OpenAPIV3.SchemaObject, string>;
 export interface OpenAPISchemaPropertyEntry {
-    propertyName?: string;
-    required?: boolean;
+    propertyName?: string | undefined;
+    required?: boolean | undefined;
     schema: OpenAPIV3.SchemaObject;
 }
 /**

package/dist/OpenAPISchema.jsx

@@ -29,18 +29,20 @@ export function OpenAPISchemaProperty(props) {
     var alternatives = parentCircularRef
         ? null
         : getSchemaAlternatives(schema, new Set(circularRefs.keys()));
-    if ((properties && !!properties.length) || schema.type === 'object') {
+    if ((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) {
         return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
                 <OpenAPISchemaPresentation {...props}/>
-                {properties && properties.length > 0 ? (<OpenAPIDisclosure context={context}>
-                        <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
-                    </OpenAPIDisclosure>) : null}
+                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={"alternative-".concat(index)} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
+                {parentCircularRef ? (<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>) : null}
             </InteractiveSection>);
     }
-    if ((_a = alternatives === null || alternatives === void 0 ? void 0 : alternatives[0]) === null || _a === void 0 ? void 0 : _a.length) {
+    if ((properties && properties.length > 0) || schema.type === 'object') {
         return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
                 <OpenAPISchemaPresentation {...props}/>
-                {alternatives[0].map(function (alternative, index) { return (<OpenAPISchemaAlternative key={"alternative-".concat(index)} schema={alternative} circularRefs={circularRefs} context={context}/>); })}
+                {properties && properties.length > 0 ? (<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
+                        <OpenAPISchemaProperties properties={properties} circularRefs={circularRefs} context={context}/>
+                    </OpenAPIDisclosure>) : null}
+                {parentCircularRef ? (<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema}/>) : null}
             </InteractiveSection>);
     }
     return (<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
@@ -86,9 +88,13 @@ function OpenAPISchemaAlternative(props) {
     var schema = props.schema, circularRefs = props.circularRefs, context = props.context;
     var id = useId();
     var subProperties = getSchemaProperties(schema);
-    return (<OpenAPIDisclosure context={context}>
-            <OpenAPISchemaProperties id={id} properties={subProperties !== null && subProperties !== void 0 ? subProperties : [{ schema: schema }]} circularRefs={subProperties ? new Map(circularRefs).set(schema, id) : circularRefs} context={context}/>
-        </OpenAPIDisclosure>);
+    var description = resolveDescription(schema);
+    return (<>
+            {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
+            <OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
+                <OpenAPISchemaProperties id={id} properties={subProperties !== null && subProperties !== void 0 ? subProperties : [{ schema: schema }]} circularRefs={subProperties ? new Map(circularRefs).set(schema, id) : circularRefs} context={context}/>
+            </OpenAPIDisclosure>
+        </>);
 }
 /**
  * Render a circular reference to a schema.
@@ -118,7 +124,7 @@ export function OpenAPISchemaEnum(props) {
 export function OpenAPISchemaPresentation(props) {
     var schema = props.schema, propertyName = props.propertyName, required = props.required;
     var shouldDisplayExample = function (schema) {
-        return (typeof schema.example === 'string' ||
+        return ((typeof schema.example === 'string' && !!schema.example) ||
             typeof schema.example === 'number' ||
             typeof schema.example === 'boolean' ||
             (Array.isArray(schema.example) && schema.example.length > 0) ||
@@ -128,7 +134,7 @@ export function OpenAPISchemaPresentation(props) {
     };
     var description = resolveDescription(schema);
     return (<div className="openapi-schema-presentation">
-            <OpenAPISchemaName type={getSchemaTitle(schema)} propertyName={propertyName} required={required} deprecated={schema.deprecated}/>
+            <OpenAPISchemaName schema={schema} type={getSchemaTitle(schema)} propertyName={propertyName} required={required}/>
             {schema['x-deprecated-sunset'] ? (<div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown">
                     Sunset date:{' '}
                     <span className="openapi-deprecated-sunset-date">
@@ -137,12 +143,7 @@ export function OpenAPISchemaPresentation(props) {
                 </div>) : null}
             {description ? (<Markdown source={description} className="openapi-schema-description"/>) : null}
             {shouldDisplayExample(schema) ? (<div className="openapi-schema-example">
-                    Example:{' '}
-                    <code>
-                        {typeof schema.example === 'string'
-                ? schema.example
-                : stringifyOpenAPI(schema.example)}
-                    </code>
+                    Example: <code>{formatExample(schema.example)}</code>
                 </div>) : null}
             {schema.pattern ? (<div className="openapi-schema-pattern">
                     Pattern: <code>{schema.pattern}</code>
@@ -154,17 +155,6 @@ export function OpenAPISchemaPresentation(props) {
  * Get the sub-properties of a schema.
  */
 function getSchemaProperties(schema) {
-    if (schema.allOf) {
-        return schema.allOf.reduce(function (acc, subSchema) {
-            var _a;
-            var properties = (_a = getSchemaProperties(subSchema)) !== null && _a !== void 0 ? _a : [
-                {
-                    schema: subSchema,
-                },
-            ];
-            return __spreadArray(__spreadArray([], acc, true), properties, true);
-        }, []);
-    }
     // check array AND schema.items as this is sometimes null despite what the type indicates
     if (schema.type === 'array' && !!schema.items) {
         var items = schema.items;
@@ -172,6 +162,10 @@ function getSchemaProperties(schema) {
         if (itemProperties) {
             return itemProperties;
         }
+        // If the items are a primitive type, we don't need to display them
+        if (['string', 'number', 'boolean', 'integer'].includes(items.type) && !items.enum) {
+            return null;
+        }
         return [
             {
                 propertyName: 'items',
@@ -217,8 +211,7 @@ export function getSchemaAlternatives(schema, ancestors) {
         return [flattenAlternatives('oneOf', schema.oneOf, downAncestors), schema.discriminator];
     }
     if (schema.allOf) {
-        // allOf is managed in `getSchemaProperties`
-        return null;
+        return [flattenAlternatives('allOf', schema.allOf, downAncestors), schema.discriminator];
     }
     return null;
 }
@@ -235,10 +228,6 @@ export function getSchemaTitle(schema,
 /** If the title is inferred in a oneOf with discriminator, we can use it to optimize the title */
 discriminator) {
     var _a;
-    if (schema.title) {
-        // If the schema has a title, use it
-        return schema.title;
-    }
     // Try using the discriminator
     if ((discriminator === null || discriminator === void 0 ? void 0 : discriminator.propertyName) && schema.properties) {
         var discriminatorProperty = schema.properties[discriminator.propertyName];
@@ -251,7 +240,7 @@ discriminator) {
     // Otherwise try to infer a nice title
     var type = 'any';
     if (schema.enum) {
-        type = 'enum';
+        type = "".concat(schema.type, " \u00B7 enum");
         // check array AND schema.items as this is sometimes null despite what the type indicates
     }
     else if (schema.type === 'array' && !!schema.items) {
@@ -263,7 +252,7 @@ discriminator) {
     else if (schema.type || schema.properties) {
         type = (_a = schema.type) !== null && _a !== void 0 ? _a : 'object';
         if (schema.format) {
-            type += " ".concat(schema.format);
+            type += " \u00B7 ".concat(schema.format);
         }
     }
     else if ('anyOf' in schema) {
@@ -278,8 +267,30 @@ discriminator) {
     else if ('not' in schema) {
         type = 'not';
     }
-    if (schema.nullable) {
-        type = "nullable ".concat(type);
-    }
     return type;
 }
+function getDisclosureLabel(schema) {
+    var _a, _b;
+    if (schema.type === 'array' && !!schema.items) {
+        if (schema.items.oneOf) {
+            return 'available items';
+        }
+        // Fallback to "child attributes" for enums and objects
+        if (schema.items.enum || schema.items.type === 'object') {
+            return;
+        }
+        return (_b = (_a = schema.items.title) !== null && _a !== void 0 ? _a : schema.title) !== null && _b !== void 0 ? _b : getSchemaTitle(schema.items);
+    }
+    return schema.title;
+}
+function formatExample(example) {
+    if (typeof example === 'string') {
+        return example
+            .replace(/\n/g, ' ') // Replace newlines with spaces
+            .replace(/\s+/g, ' ') // Collapse multiple spaces/newlines into a single space
+            .replace(/([\{\}:,])\s+/g, '$1 ') // Ensure a space after {, }, :, and ,
+            .replace(/\s+([\{\}:,])/g, ' $1') // Ensure a space before {, }, :, and ,
+            .trim();
+    }
+    return stringifyOpenAPI(example);
+}

package/dist/OpenAPISchemaName.d.ts

@@ -1,8 +1,9 @@
+import { OpenAPIV3 } from '@gitbook/openapi-parser';
 interface OpenAPISchemaNameProps {
+    schema?: OpenAPIV3.SchemaObject;
     propertyName?: string | JSX.Element;
     required?: boolean;
     type?: string;
-    deprecated?: boolean;
 }
 /**
  * Display the schema name row.