@gitbook/react-openapi 1.1.7 → 1.1.9

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @gitbook/react-openapi
 
+## 1.1.9
+
+### Patch Changes
+
+- da7b369: Fix missing headers in OpenAPIResponses
+- da485f5: Fix read-only in generateSchemaExample
+- 139a805: Fix OpenAPI enum display
+
+## 1.1.8
+
+### Patch Changes
+
+- 7d0b422: Handle grouped OpenAPISchemas
+
 ## 1.1.7
 
 ### Patch Changes

package/dist/OpenAPIResponse.jsx

@@ -34,8 +34,8 @@ export function OpenAPIResponse(props) {
                 return parameterToProperty(__assign({ name: name }, header));
             })} context={context}/>
                 </OpenAPIDisclosure>) : null}
-            <div className="openapi-responsebody">
-                <OpenAPISchemaProperties id={"response-".concat(context.blockKey)} properties={mediaType.schema ? [{ schema: mediaType.schema }] : []} context={context}/>
-            </div>
+            {mediaType.schema && (<div className="openapi-responsebody">
+                    <OpenAPISchemaProperties id={"response-".concat(context.blockKey)} properties={[{ schema: mediaType.schema }]} context={context}/>
+                </div>)}
         </div>);
 }

package/dist/OpenAPIResponseExample.jsx

@@ -184,6 +184,7 @@ function getExamplesFromMediaTypeObject(args) {
                         value: (_a = {},
                             _a[root] = generateSchemaExample(mediaTypeObject.schema, {
                                 xml: mediaType === 'application/xml',
+                                mode: 'read',
                             }),
                             _a),
                     },
@@ -193,7 +194,11 @@ function getExamplesFromMediaTypeObject(args) {
         return [
             {
                 key: 'default',
-                example: { value: generateSchemaExample(mediaTypeObject.schema) },
+                example: {
+                    value: generateSchemaExample(mediaTypeObject.schema, {
+                        mode: 'read',
+                    }),
+                },
             },
         ];
     }

package/dist/OpenAPIResponses.jsx

@@ -9,9 +9,29 @@ export function OpenAPIResponses(props) {
     var responses = props.responses, context = props.context;
     return (<StaticSection 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 tabs = (function () {
+                var _a;
+                // If there is no content, but there are headers, we need to show the headers
+                if ((!response.content || !Object.keys(response.content).length) &&
+                    response.headers &&
+                    Object.keys(response.headers).length) {
+                    return [
+                        {
+                            id: 'default',
+                            body: (<OpenAPIResponse response={response} mediaType={{}} context={context}/>),
+                        },
+                    ];
+                }
+                return Object.entries((_a = response.content) !== null && _a !== void 0 ? _a : {}).map(function (_a) {
+                    var contentType = _a[0], mediaType = _a[1];
+                    return ({
+                        id: contentType,
+                        label: contentType,
+                        body: (<OpenAPIResponse response={response} mediaType={mediaType} context={context}/>),
+                    });
+                });
+            })();
             var description = response.description;
             return {
                 id: statusCode,
@@ -21,14 +41,7 @@ export function OpenAPIResponses(props) {
                                     </span>
                                     {description ? (<Markdown source={description} className="openapi-response-description"/>) : null}
                                 </div>),
-                tabs: content.map(function (_a) {
-                    var contentType = _a[0], mediaType = _a[1];
-                    return ({
-                        id: contentType,
-                        label: contentType,
-                        body: (<OpenAPIResponse response={response} mediaType={mediaType} context={context}/>),
-                    });
-                }),
+                tabs: tabs,
             };
         })}/>
         </StaticSection>);

package/dist/OpenAPISchema.jsx

@@ -132,16 +132,14 @@ function OpenAPISchemaEnum(props) {
     if (!(enumValues === null || enumValues === void 0 ? void 0 : enumValues.length)) {
         return null;
     }
-    return (<div className="openapi-schema-enum">
-            <span>Available options:</span>
-            <div className="openapi-schema-enum-list">
-                {enumValues.map(function (item, index) { return (<span key={index} className="openapi-schema-enum-value">
-                        <OpenAPICopyButton value={item.value} label={item.description} withTooltip={!!item.description}>
-                            <code>{"".concat(item.value)}</code>
-                        </OpenAPICopyButton>
-                    </span>); })}
-            </div>
-        </div>);
+    return (<span className="openapi-schema-enum">
+            Available options:{' '}
+            {enumValues.map(function (item, index) { return (<span key={index} className="openapi-schema-enum-value">
+                    <OpenAPICopyButton value={item.value} label={item.description} withTooltip={!!item.description}>
+                        <code>{"".concat(item.value)}</code>
+                    </OpenAPICopyButton>
+                </span>); })}
+        </span>);
 }
 /**
  * Render the top row of a schema. e.g: name, type, and required status.

package/dist/generateSchemaExample.d.ts

@@ -41,5 +41,5 @@ declare const getExampleFromSchema: (schema: Record<string, any>, options?: {
      * @default false
      */
     omitEmptyAndOptionalProperties?: boolean;
-}, level?: number, parentSchema?: Record<string, any>, name?: string) => any;
+}, level?: number, parentSchema?: Record<string, any>, name?: string, resultCache?: WeakMap<Record<string, any>, any>) => any;
 export {};

package/dist/generateSchemaExample.js

@@ -24,8 +24,7 @@ import { checkIsReference } from './utils';
  * Generate a JSON example from a schema
  */
 export function generateSchemaExample(schema, options) {
-    return getExampleFromSchema(schema, __assign({ emptyString: 'text' }, options), 3 // Max depth for circular references
-    );
+    return getExampleFromSchema(schema, __assign({ emptyString: 'text' }, options));
 }
 /**
  * Generate an example for a media type.
@@ -96,25 +95,24 @@ function guessFromFormat(schema, fallback) {
     if (fallback === void 0) { fallback = ''; }
     return (_a = genericExampleValues[schema.format]) !== null && _a !== void 0 ? _a : fallback;
 }
-/** Map of all the results */
-var resultCache = new WeakMap();
-/** Store result in the cache, and return the result */
-function cache(schema, result) {
-    // Avoid unnecessary WeakMap operations for primitive values
-    if (typeof result !== 'object' || result === null) {
-        return result;
-    }
-    resultCache.set(schema, result);
-    return result;
-}
 /**
  * This function takes an OpenAPI schema and generates an example from it
  * Forked from : https://github.com/scalar/scalar/blob/main/packages/oas-utils/src/spec-getters/getExampleFromSchema.ts
  */
-var getExampleFromSchema = function (schema, options, level, parentSchema, name) {
+var getExampleFromSchema = function (schema, options, level, parentSchema, name, resultCache) {
     var _a, _b, _c, _d;
     var _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
     if (level === void 0) { level = 0; }
+    if (resultCache === void 0) { resultCache = new WeakMap(); }
+    // Store result in the cache, and return the result
+    function cache(schema, result) {
+        // Avoid unnecessary WeakMap operations for primitive values
+        if (typeof result !== 'object' || result === null) {
+            return result;
+        }
+        resultCache.set(schema, result);
+        return result;
+    }
     // Check if the result is already cached
     if (resultCache.has(schema)) {
         return resultCache.get(schema);
@@ -184,7 +182,7 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
                 if (Object.prototype.hasOwnProperty.call(schema.properties, propertyName)) {
                     var property = schema.properties[propertyName];
                     var propertyXmlTagName = (options === null || options === void 0 ? void 0 : options.xml) ? (_o = property.xml) === null || _o === void 0 ? void 0 : _o.name : undefined;
-                    response[propertyXmlTagName !== null && propertyXmlTagName !== void 0 ? propertyXmlTagName : propertyName] = getExampleFromSchema(property, options, level + 1, schema, propertyName);
+                    response[propertyXmlTagName !== null && propertyXmlTagName !== void 0 ? propertyXmlTagName : propertyName] = getExampleFromSchema(property, options, level + 1, schema, propertyName, resultCache);
                     if (typeof response[propertyXmlTagName !== null && propertyXmlTagName !== void 0 ? propertyXmlTagName : propertyName] === 'undefined') {
                         delete response[propertyXmlTagName !== null && propertyXmlTagName !== void 0 ? propertyXmlTagName : propertyName];
                     }
@@ -198,7 +196,7 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
                     var property = schema.patternProperties[pattern];
                     // Use the regex pattern as an example key
                     var exampleKey = pattern;
-                    response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey);
+                    response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey, resultCache);
                 }
             }
         }
@@ -214,19 +212,19 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
                 response.ANY_ADDITIONAL_PROPERTY = 'anything';
             }
             else if (schema.additionalProperties !== false) {
-                response.ANY_ADDITIONAL_PROPERTY = getExampleFromSchema(schema.additionalProperties, options, level + 1);
+                response.ANY_ADDITIONAL_PROPERTY = getExampleFromSchema(schema.additionalProperties, options, level + 1, undefined, undefined, resultCache);
             }
         }
         if (schema.anyOf !== undefined) {
-            Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1));
+            Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1, undefined, undefined, resultCache));
         }
         else if (schema.oneOf !== undefined) {
-            Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1));
+            Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1, undefined, undefined, resultCache));
         }
         else if (schema.allOf !== undefined) {
             Object.assign.apply(Object, __spreadArray([response], schema.allOf
                 .map(function (item) {
-                return getExampleFromSchema(item, options, level + 1, schema);
+                return getExampleFromSchema(item, options, level + 1, schema, undefined, resultCache);
             })
                 .filter(function (item) { return item !== undefined; }), false));
         }
@@ -245,13 +243,13 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
             if (schema.items.allOf) {
                 // If the first item is an object type, merge all schemas
                 if (schema.items.allOf[0].type === 'object') {
-                    var mergedExample = getExampleFromSchema({ type: 'object', allOf: schema.items.allOf }, options, level + 1, schema);
+                    var mergedExample = getExampleFromSchema({ type: 'object', allOf: schema.items.allOf }, options, level + 1, schema, undefined, resultCache);
                     return cache(schema, wrapItems ? [(_b = {}, _b[itemsXmlTagName_1] = mergedExample, _b)] : [mergedExample]);
                 }
                 // For non-objects (like strings), collect all examples
                 var examples = schema.items.allOf
                     .map(function (item) {
-                    return getExampleFromSchema(item, options, level + 1, schema);
+                    return getExampleFromSchema(item, options, level + 1, schema, undefined, resultCache);
                 })
                     .filter(function (item) { return item !== undefined; });
                 return cache(schema, wrapItems
@@ -271,14 +269,14 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
                 var schemas = schema.items[rule].slice(0, 1);
                 var exampleFromRule = schemas
                     .map(function (item) {
-                    return getExampleFromSchema(item, options, level + 1, schema);
+                    return getExampleFromSchema(item, options, level + 1, schema, undefined, resultCache);
                 })
                     .filter(function (item) { return item !== undefined; });
                 return cache(schema, wrapItems ? [(_c = {}, _c[itemsXmlTagName_1] = exampleFromRule, _c)] : exampleFromRule);
             }
         }
         if ((_s = schema.items) === null || _s === void 0 ? void 0 : _s.type) {
-            var exampleFromSchema = getExampleFromSchema(schema.items, options, level + 1);
+            var exampleFromSchema = getExampleFromSchema(schema.items, options, level + 1, undefined, undefined, resultCache);
             return wrapItems ? [(_d = {}, _d[itemsXmlTagName_1] = exampleFromSchema, _d)] : [exampleFromSchema];
         }
         return [];
@@ -299,7 +297,7 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
         // Get the first item from the `oneOf` | `anyOf` array
         var firstOneOfItem = discriminateSchema[0];
         // Return an example for the first item
-        return getExampleFromSchema(firstOneOfItem, options, level + 1);
+        return getExampleFromSchema(firstOneOfItem, options, level + 1, undefined, undefined, resultCache);
     }
     // Check if schema has the `allOf` key
     if (Array.isArray(schema.allOf)) {
@@ -307,7 +305,7 @@ var getExampleFromSchema = function (schema, options, level, parentSchema, name)
         // Loop through all `allOf` schemas
         schema.allOf.forEach(function (allOfItem) {
             // Return an example from the schema
-            var newExample = getExampleFromSchema(allOfItem, options, level + 1);
+            var newExample = getExampleFromSchema(allOfItem, options, level + 1, undefined, undefined, resultCache);
             // Merge or overwrite the example
             example_1 =
                 typeof newExample === 'object' && typeof example_1 === 'object'

package/dist/schemas/OpenAPISchemas.d.ts

@@ -7,5 +7,9 @@ export declare function OpenAPISchemas(props: {
     className?: string;
     data: OpenAPISchemasData;
     context: OpenAPISchemasContextProps;
+    /**
+     * Whether to show the schema directly if there is only one.
+     */
+    grouped?: boolean;
 }): import("react").JSX.Element | null;
 export {};

package/dist/schemas/OpenAPISchemas.jsx

@@ -6,7 +6,7 @@ import { Section, SectionBody } from '../StaticSection';
  * Display OpenAPI Schemas.
  */
 export function OpenAPISchemas(props) {
-    var className = props.className, data = props.data, context = props.context;
+    var className = props.className, data = props.data, context = props.context, grouped = props.grouped;
     var schemas = data.schemas;
     var clientContext = {
         defaultInteractiveOpened: context.defaultInteractiveOpened,
@@ -17,7 +17,7 @@ export function OpenAPISchemas(props) {
         return null;
     }
     return (<div className={clsx('openapi-schemas', className)}>
-            <OpenAPIRootSchemasSchema schemas={schemas} context={clientContext}/>
+            <OpenAPIRootSchemasSchema grouped={grouped} schemas={schemas} context={clientContext}/>
         </div>);
 }
 /**
@@ -26,9 +26,9 @@ export function OpenAPISchemas(props) {
  */
 function OpenAPIRootSchemasSchema(props) {
     var _a;
-    var schemas = props.schemas, context = props.context;
-    // If there is only one model, we show it directly.
-    if (schemas.length === 1) {
+    var schemas = props.schemas, context = props.context, grouped = props.grouped;
+    // If there is only one model and we are not grouping, we show it directly.
+    if (schemas.length === 1 && !grouped) {
         var schema = (_a = schemas === null || schemas === void 0 ? void 0 : schemas[0]) === null || _a === void 0 ? void 0 : _a.schema;
         if (!schema) {
             return null;