@gitbook/react-openapi 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @gitbook/react-openapi
 
+## 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
+
+-   f8d4c76: Sync tabs across all OpenAPI blocks
+-   dddb4ec: Fix long tab group description
+-   f8d4c76: Support for OpenAPI references
+
 ## 1.0.0
 
 ### Major Changes

package/dist/InteractiveSection.d.ts

@@ -27,7 +27,5 @@ export declare function InteractiveSection(props: {
     children?: React.ReactNode;
     /** Children to display within the container */
     overlay?: React.ReactNode;
-    /** An optional key referencing a value in global state */
-    stateKey?: string;
 }): import("react").JSX.Element;
 export {};

package/dist/InteractiveSection.jsx

@@ -1,55 +1,25 @@
 'use client';
-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 clsx from 'clsx';
-import { useCallback, useRef, useState, useSyncExternalStore } from 'react';
+import { useRef, useState } from 'react';
 import { mergeProps, useButton, useDisclosure, useFocusRing } from 'react-aria';
 import { useDisclosureState } from 'react-stately';
-var globalState = {};
-var listeners = new Set();
-function useSyncedTabsGlobalState() {
-    var subscribe = useCallback(function (callback) {
-        listeners.add(callback);
-        return function () { return listeners.delete(callback); };
-    }, []);
-    var getSnapshot = useCallback(function () { return globalState; }, []);
-    var setSyncedTabs = useCallback(function (updater) {
-        globalState = updater(globalState);
-        listeners.forEach(function (listener) { return listener(); });
-    }, []);
-    var tabs = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
-    return [tabs, setSyncedTabs];
-}
 /**
  * To optimize rendering, most of the components are server-components,
  * and the interactiveness is mainly handled by a few key components like this one.
  */
 export function InteractiveSection(props) {
-    var _a, _b, _c, _d;
-    var id = props.id, className = props.className, _e = props.toggeable, toggeable = _e === void 0 ? false : _e, _f = props.defaultOpened, defaultOpened = _f === void 0 ? true : _f, _g = props.tabs, tabs = _g === void 0 ? [] : _g, _h = props.defaultTab, defaultTab = _h === void 0 ? (_a = tabs[0]) === null || _a === void 0 ? void 0 : _a.key : _h, header = props.header, children = props.children, overlay = props.overlay, _j = props.toggleIcon, toggleIcon = _j === void 0 ? '▶' : _j, stateKey = props.stateKey;
-    var _k = useSyncedTabsGlobalState(), syncedTabs = _k[0], setSyncedTabs = _k[1];
-    var tabFromState = stateKey && stateKey in syncedTabs
-        ? tabs.find(function (tab) { return tab.key === syncedTabs[stateKey]; })
-        : undefined;
-    var _l = useState((_b = tabFromState === null || tabFromState === void 0 ? void 0 : tabFromState.key) !== null && _b !== void 0 ? _b : defaultTab), selectedTabKey = _l[0], setSelectedTab = _l[1];
-    var selectedTab = (_c = tabFromState !== null && tabFromState !== void 0 ? tabFromState : tabs.find(function (tab) { return tab.key === selectedTabKey; })) !== null && _c !== void 0 ? _c : tabs[0];
+    var _a, _b, _c;
+    var id = props.id, className = props.className, _d = props.toggeable, toggeable = _d === void 0 ? false : _d, _e = props.defaultOpened, defaultOpened = _e === void 0 ? true : _e, _f = props.tabs, tabs = _f === void 0 ? [] : _f, _g = props.defaultTab, defaultTab = _g === void 0 ? (_a = tabs[0]) === null || _a === void 0 ? void 0 : _a.key : _g, header = props.header, children = props.children, overlay = props.overlay, _h = props.toggleIcon, toggleIcon = _h === void 0 ? '▶' : _h;
+    var _j = useState(defaultTab), selectedTabKey = _j[0], setSelectedTab = _j[1];
+    var selectedTab = (_b = tabs.find(function (tab) { return tab.key === selectedTabKey; })) !== null && _b !== void 0 ? _b : tabs[0];
     var state = useDisclosureState({
         defaultExpanded: defaultOpened,
     });
     var panelRef = useRef(null);
     var triggerRef = useRef(null);
-    var _m = useDisclosure({}, state, panelRef), triggerProps = _m.buttonProps, panelProps = _m.panelProps;
+    var _k = useDisclosure({}, state, panelRef), triggerProps = _k.buttonProps, panelProps = _k.panelProps;
     var buttonProps = useButton(triggerProps, triggerRef).buttonProps;
-    var _o = useFocusRing(), isFocusVisible = _o.isFocusVisible, focusProps = _o.focusProps;
+    var _l = useFocusRing(), isFocusVisible = _l.isFocusVisible, focusProps = _l.focusProps;
     return (<div id={id} className={clsx('openapi-section', toggeable ? 'openapi-section-toggeable' : null, className, toggeable ? "".concat(className, "-").concat(state.isExpanded ? 'opened' : 'closed') : null)}>
             {header ? (<div onClick={function () {
                 if (toggeable) {
@@ -69,14 +39,8 @@ export function InteractiveSection(props) {
                     <div className={clsx('openapi-section-header-controls', "".concat(className, "-header-controls"))} onClick={function (event) {
                 event.stopPropagation();
             }}>
-                        {tabs.length > 1 ? (<select className={clsx('openapi-section-select', 'openapi-select', "".concat(className, "-tabs-select"))} value={(_d = selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key) !== null && _d !== void 0 ? _d : ''} onChange={function (event) {
+                        {tabs.length > 1 ? (<select className={clsx('openapi-section-select', 'openapi-select', "".concat(className, "-tabs-select"))} value={(_c = selectedTab === null || selectedTab === void 0 ? void 0 : selectedTab.key) !== null && _c !== void 0 ? _c : ''} onChange={function (event) {
                     setSelectedTab(event.target.value);
-                    if (stateKey) {
-                        setSyncedTabs(function (state) {
-                            var _a;
-                            return (__assign(__assign({}, state), (_a = {}, _a[stateKey] = event.target.value, _a)));
-                        });
-                    }
                     state.expand();
                 }}>
                                 {tabs.map(function (tab) { return (<option key={tab.key} value={tab.key}>

package/dist/OpenAPICodeSample.jsx

@@ -13,9 +13,10 @@ import { codeSampleGenerators } from './code-samples';
 import { generateMediaTypeExample, generateSchemaExample } from './generateSchemaExample';
 import { InteractiveSection } from './InteractiveSection';
 import { getServersURL } from './OpenAPIServerURL';
-import { noReference } from './utils';
+import { createStateKey } from './utils';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
+import { checkIsReference } from './utils';
 /**
  * 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/)
@@ -25,30 +26,27 @@ export function OpenAPICodeSample(props) {
     var data = props.data, context = props.context;
     var searchParams = new URLSearchParams();
     var headersObject = {};
-    (_a = data.operation.parameters) === null || _a === void 0 ? void 0 : _a.forEach(function (rawParam) {
-        var param = noReference(rawParam);
+    (_a = data.operation.parameters) === null || _a === void 0 ? void 0 : _a.forEach(function (param) {
         if (!param) {
             return;
         }
         if (param.in === 'header' && param.required) {
-            var example = param.schema
-                ? generateSchemaExample(noReference(param.schema))
-                : undefined;
+            var example = param.schema ? generateSchemaExample(param.schema) : undefined;
             if (example !== undefined && param.name) {
                 headersObject[param.name] =
                     typeof example !== 'string' ? stringifyOpenAPI(example) : example;
             }
         }
         else if (param.in === 'query' && param.required) {
-            var example = param.schema
-                ? generateSchemaExample(noReference(param.schema))
-                : undefined;
+            var example = param.schema ? generateSchemaExample(param.schema) : undefined;
             if (example !== undefined && param.name) {
                 searchParams.append(param.name, String(Array.isArray(example) ? example[0] : example));
             }
         }
     });
-    var requestBody = noReference(data.operation.requestBody);
+    var requestBody = !checkIsReference(data.operation.requestBody)
+        ? data.operation.requestBody
+        : undefined;
     var requestBodyContentEntries = (requestBody === null || requestBody === void 0 ? void 0 : requestBody.content)
         ? Object.entries(requestBody.content)
         : undefined;
@@ -59,7 +57,9 @@ export function OpenAPICodeSample(props) {
             (searchParams.size ? "?".concat(searchParams.toString()) : ''),
         method: data.method,
         body: requestBodyContent
-            ? generateMediaTypeExample(requestBodyContent[1], { onlyRequired: true })
+            ? generateMediaTypeExample(requestBodyContent[1], {
+                omitEmptyAndOptionalProperties: true,
+            })
             : undefined,
         headers: __assign(__assign(__assign({}, getSecurityHeaders(data.securities)), headersObject), (requestBodyContent
             ? {
@@ -97,7 +97,7 @@ export function OpenAPICodeSample(props) {
     if (samples.length === 0) {
         return null;
     }
-    return (<OpenAPITabs items={samples}>
+    return (<OpenAPITabs stateKey={createStateKey('codesample')} items={samples}>
             <InteractiveSection header={<OpenAPITabsList />} className="openapi-codesample">
                 <OpenAPITabsPanels />
             </InteractiveSection>

package/dist/OpenAPIOperation.jsx

@@ -17,12 +17,15 @@ export function OpenAPIOperation(props) {
         icons: context.icons,
         blockKey: context.blockKey,
     };
-    var description = (_a = resolveDescription(operation)) === null || _a === void 0 ? void 0 : _a.trim();
+    var description = resolveDescription(operation);
     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">
+                {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">

package/dist/OpenAPIRequestBody.d.ts

@@ -4,6 +4,6 @@ import type { OpenAPIClientContext } from './types';
  * Display an interactive request body.
  */
 export declare function OpenAPIRequestBody(props: {
-    requestBody: OpenAPIV3.RequestBodyObject;
+    requestBody: OpenAPIV3.RequestBodyObject | OpenAPIV3.ReferenceObject;
     context: OpenAPIClientContext;
-}): import("react").JSX.Element;
+}): import("react").JSX.Element | null;

package/dist/OpenAPIRequestBody.jsx

@@ -1,19 +1,22 @@
 import { OpenAPIRootSchema } from './OpenAPISchema';
-import { noReference } from './utils';
 import { InteractiveSection } from './InteractiveSection';
+import { checkIsReference } from './utils';
 /**
  * Display an interactive request body.
  */
 export function OpenAPIRequestBody(props) {
     var _a;
     var requestBody = props.requestBody, context = props.context;
+    if (checkIsReference(requestBody)) {
+        return null;
+    }
     return (<InteractiveSection header="Body" className="openapi-requestbody" tabs={Object.entries((_a = requestBody.content) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
             var _b;
             var contentType = _a[0], mediaTypeObject = _a[1];
             return {
                 key: contentType,
                 label: contentType,
-                body: (<OpenAPIRootSchema schema={(_b = noReference(mediaTypeObject.schema)) !== null && _b !== void 0 ? _b : {}} context={context}/>),
+                body: (<OpenAPIRootSchema schema={(_b = mediaTypeObject.schema) !== null && _b !== void 0 ? _b : {}} context={context}/>),
             };
         })}/>);
 }

package/dist/OpenAPIResponse.jsx

@@ -1,16 +1,26 @@
+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 { checkIsReference, noReference, 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 _b;
         var name = _a[0], header = _a[1];
-        return [name, (_b = noReference(header)) !== null && _b !== void 0 ? _b : {}];
+        return [name, header !== null && header !== void 0 ? header : {}];
     });
     var content = Object.entries((_b = mediaType.schema) !== null && _b !== void 0 ? _b : {});
     var description = resolveDescription(response);
@@ -18,32 +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 = noReference(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 = handleUnresolvedReference(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>);
 }
-function handleUnresolvedReference(input) {
-    var isReference = checkIsReference(input);
-    if (isReference || input === undefined) {
-        // If we find a reference that wasn't resolved or needed to be resolved externally, do not try to render it.
-        // Instead we render `any`
-        return {};
-    }
-    return input;
-}

package/dist/OpenAPIResponseExample.jsx

@@ -1,8 +1,8 @@
 import { generateSchemaExample } from './generateSchemaExample';
-import { checkIsReference, noReference, resolveDescription } from './utils';
-import { stringifyOpenAPI } from './stringifyOpenAPI';
+import { checkIsReference, createStateKey, resolveDescription } from './utils';
 import { OpenAPITabs, OpenAPITabsList, OpenAPITabsPanels } from './OpenAPITabs';
 import { InteractiveSection } from './InteractiveSection';
+import { json2xml } from './json2xml';
 /**
  * Display an example of the response content.
  */
@@ -31,78 +31,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 = noReference(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: resolveDescription(responseObject),
+                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: 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 = noReference(examples[key_1]);
-                    if (firstExample) {
-                        return firstExample;
-                    }
-                }
-            }
-            if (example) {
-                return { value: example };
-            }
-            var schema = noReference(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 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.CodeBlock 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 JSON.stringify(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/OpenAPIResponses.jsx

@@ -1,4 +1,3 @@
-import { createStateKey, resolveDescription } from './utils';
 import { OpenAPIResponse } from './OpenAPIResponse';
 import { InteractiveSection } from './InteractiveSection';
 import { OpenAPIDisclosureGroup } from './OpenAPIDisclosureGroup';
@@ -8,12 +7,12 @@ import { Markdown } from './Markdown';
  */
 export function OpenAPIResponses(props) {
     var responses = props.responses, context = props.context;
-    return (<InteractiveSection stateKey={createStateKey('response', context.blockKey)} header="Responses" className="openapi-responses">
+    return (<InteractiveSection header="Responses" className="openapi-responses">
             <OpenAPIDisclosureGroup allowsMultipleExpanded icon={context.icons.chevronRight} groups={Object.entries(responses).map(function (_a) {
             var _b;
             var statusCode = _a[0], response = _a[1];
             var content = Object.entries((_b = response.content) !== null && _b !== void 0 ? _b : {});
-            var description = resolveDescription(response);
+            var description = response.description;
             return {
                 id: statusCode,
                 label: (<div className="openapi-response-tab-content" key={"response-".concat(statusCode)}>

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;
 }
 /**