@gitbook/react-openapi 1.1.8 → 1.1.10

package/dist/schemas/OpenAPISchemas.jsx

@@ -1,62 +1,69 @@
 import clsx from 'clsx';
 import { OpenAPIDisclosureGroup } from '../OpenAPIDisclosureGroup';
+import { OpenAPIExample, getExampleFromSchema } from '../OpenAPIExample';
 import { OpenAPIRootSchema } from '../OpenAPISchemaServer';
-import { Section, SectionBody } from '../StaticSection';
+import { Section, SectionBody, StaticSection } from '../StaticSection';
+import { getOpenAPIClientContext } from '../context';
 /**
- * Display OpenAPI Schemas.
+ * OpenAPI Schemas component.
  */
 export function OpenAPISchemas(props) {
-    var className = props.className, data = props.data, context = props.context, grouped = props.grouped;
-    var schemas = data.schemas;
-    var clientContext = {
-        defaultInteractiveOpened: context.defaultInteractiveOpened,
-        icons: context.icons,
-        blockKey: context.blockKey,
-    };
-    if (!schemas.length) {
+    var schemas = props.schemas, context = props.context, grouped = props.grouped, className = props.className;
+    var firstSchema = schemas[0];
+    if (!firstSchema) {
         return null;
     }
-    return (<div className={clsx('openapi-schemas', className)}>
-            <OpenAPIRootSchemasSchema grouped={grouped} schemas={schemas} context={clientContext}/>
-        </div>);
-}
-/**
- * Root schema for OpenAPI schemas.
- * It displays a single model or a disclosure group for multiple schemas.
- */
-function OpenAPIRootSchemasSchema(props) {
-    var _a;
-    var schemas = props.schemas, context = props.context, grouped = props.grouped;
+    var clientContext = getOpenAPIClientContext(context);
     // 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;
-        }
-        return (<Section>
-                <SectionBody>
-                    <OpenAPIRootSchema schema={schema} context={context}/>
-                </SectionBody>
-            </Section>);
+        var title = "The ".concat(firstSchema.name, " object");
+        return (<div className={clsx('openapi-schemas', className)}>
+                <div className="openapi-summary" id={context.id}>
+                    {context.renderHeading({
+                title: title,
+            })}
+                </div>
+                <div className="openapi-columns">
+                    <div className="openapi-column-spec">
+                        <StaticSection className="openapi-parameters" header="Attributes">
+                            <OpenAPIRootSchema schema={firstSchema.schema} context={clientContext}/>
+                        </StaticSection>
+                    </div>
+                    <div className="openapi-column-preview">
+                        <div className="openapi-column-preview-body">
+                            <div className="openapi-panel">
+                                <h4 className="openapi-panel-heading">{title}</h4>
+                                <div className="openapi-panel-body">
+                                    <OpenAPIExample example={getExampleFromSchema({
+                schema: firstSchema.schema,
+            })} context={context} syntax="json"/>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>);
     }
     // If there are multiple schemas, we use a disclosure group to show them all.
-    return (<OpenAPIDisclosureGroup allowsMultipleExpanded icon={context.icons.chevronRight} groups={schemas.map(function (_a) {
+    return (<div className={clsx('openapi-schemas', className)}>
+            <OpenAPIDisclosureGroup allowsMultipleExpanded icon={context.icons.chevronRight} groups={schemas.map(function (_a) {
             var name = _a.name, schema = _a.schema;
             return ({
                 id: name,
                 label: (<div className="openapi-response-tab-content" key={"model-".concat(name)}>
-                        <span className="openapi-response-statuscode">{name}</span>
-                    </div>),
+                            <span className="openapi-response-statuscode">{name}</span>
+                        </div>),
                 tabs: [
                     {
                         id: 'model',
                         body: (<Section className="openapi-section-schemas">
-                                <SectionBody>
-                                    <OpenAPIRootSchema schema={schema} context={context}/>
-                                </SectionBody>
-                            </Section>),
+                                    <SectionBody>
+                                        <OpenAPIRootSchema schema={schema} context={clientContext}/>
+                                    </SectionBody>
+                                </Section>),
                     },
                 ],
             });
-        })}/>);
+        })}/>
+        </div>);
 }

package/dist/schemas/resolveOpenAPISchemas.d.ts

@@ -1,9 +1,10 @@
-import type { Filesystem, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
-import type { OpenAPISchemasData } from '../types';
+import type { Filesystem, OpenAPISchema, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
 /**
  * Resolve an OpenAPI schemas from a file and compile it to a more usable format.
  * Schemas are extracted from the OpenAPI components.schemas
  */
 export declare function resolveOpenAPISchemas(filesystem: Filesystem<OpenAPIV3xDocument>, options: {
     schemas: string[];
-}): Promise<OpenAPISchemasData | null>;
+}): Promise<{
+    schemas: OpenAPISchema[];
+} | null>;

package/dist/schemas/resolveOpenAPISchemas.js

@@ -36,7 +36,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 import { filterSelectedOpenAPISchemas } from '@gitbook/openapi-parser';
 import { dereferenceFilesystem } from '../dereference';
-//!!TODO: We should return only the schemas that are used in the block. Still a WIP awaiting future work.
 /**
  * Resolve an OpenAPI schemas from a file and compile it to a more usable format.
  * Schemas are extracted from the OpenAPI components.schemas