docusaurus-plugin-openapi-docs 0.0.0-934 → 0.0.0-940

package/lib/index.js

@@ -203,7 +203,11 @@ title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
 sidebar_label: "{{{title}}}"
 hide_title: true
+{{#schema}}
+hide_table_of_contents: true
+{{/schema}}
 schema: true
+sample: {{{frontMatter.sample}}}
 custom_edit_url: null
 ---
 

package/lib/markdown/index.js

@@ -21,7 +21,6 @@ const createMethodEndpoint_1 = require("./createMethodEndpoint");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createRequestHeader_1 = require("./createRequestHeader");
-const createSchema_1 = require("./createSchema");
 const createStatusCodes_1 = require("./createStatusCodes");
 const createTermsOfService_1 = require("./createTermsOfService");
 const createVendorExtensions_1 = require("./createVendorExtensions");
@@ -81,15 +80,13 @@ exports.createTagPageMD = createTagPageMD;
 function createSchemaPageMD({ schema }) {
     const { title = "", description } = schema;
     return (0, utils_1.render)([
-        `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
-        `import SchemaItem from "@theme/SchemaItem";\n`,
-        `import SchemaTabs from "@theme/SchemaTabs";\n`,
-        `import Heading from "@theme/Heading";\n`,
-        `import TabItem from "@theme/TabItem";\n\n`,
+        `import Schema from "@theme/Schema";\n`,
+        `import Heading from "@theme/Heading";\n\n`,
         (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
         (0, createDescription_1.createDescription)(description),
-        (0, utils_1.create)("ul", {
-            children: (0, createSchema_1.createNodes)(schema, "response"),
+        (0, utils_1.create)("Schema", {
+            schema: schema,
+            schemaType: "response",
         }),
     ]);
 }

package/lib/openapi/openapi.js

@@ -22,6 +22,7 @@ const openapi_to_postmanv2_1 = __importDefault(require("openapi-to-postmanv2"));
 const postman_collection_1 = __importDefault(require("postman-collection"));
 const createRequestExample_1 = require("./createRequestExample");
 const index_1 = require("../index");
+const createResponseExample_1 = require("./createResponseExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
@@ -355,6 +356,7 @@ function createItems(openapiData, options, sidebarOptions) {
                                 .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
                                 .replace(/\s+$/, "")
                             : "",
+                        sample: JSON.stringify((0, createResponseExample_1.sampleResponseFromSchema)(schemaObject)),
                     },
                     schema: schemaObject,
                 };

package/lib/options.js

@@ -23,6 +23,7 @@ const markdownGenerators = utils_validation_1.Joi.object({
     createApiPageMD: utils_validation_1.Joi.function(),
     createInfoPageMD: utils_validation_1.Joi.function(),
     createTagPageMD: utils_validation_1.Joi.function(),
+    createSchemaPageMD: utils_validation_1.Joi.function(),
 });
 exports.OptionsSchema = utils_validation_1.Joi.object({
     id: utils_validation_1.Joi.string().required(),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-934",
+  "version": "0.0.0-940",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "23c20cde70c5311d6879b113665ceddc84d1febc"
+  "gitHead": "73fe6a842a36f1da27cb0c22d2fa260b268739d6"
 }

package/src/index.ts

@@ -278,7 +278,11 @@ title: "{{{title}}}"
 description: "{{{frontMatter.description}}}"
 sidebar_label: "{{{title}}}"
 hide_title: true
+{{#schema}}
+hide_table_of_contents: true
+{{/schema}}
 schema: true
+sample: {{{frontMatter.sample}}}
 custom_edit_url: null
 ---
 

package/src/markdown/index.ts

@@ -19,7 +19,6 @@ import { createMethodEndpoint } from "./createMethodEndpoint";
 import { createParamsDetails } from "./createParamsDetails";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
 import { createRequestHeader } from "./createRequestHeader";
-import { createNodes } from "./createSchema";
 import { createStatusCodes } from "./createStatusCodes";
 import { createTermsOfService } from "./createTermsOfService";
 import { createVendorExtensions } from "./createVendorExtensions";
@@ -133,15 +132,13 @@ export function createTagPageMD({ tag: { description } }: TagPageMetadata) {
 export function createSchemaPageMD({ schema }: SchemaPageMetadata) {
   const { title = "", description } = schema;
   return render([
-    `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
-    `import SchemaItem from "@theme/SchemaItem";\n`,
-    `import SchemaTabs from "@theme/SchemaTabs";\n`,
-    `import Heading from "@theme/Heading";\n`,
-    `import TabItem from "@theme/TabItem";\n\n`,
+    `import Schema from "@theme/Schema";\n`,
+    `import Heading from "@theme/Heading";\n\n`,
     createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
     createDescription(description),
-    create("ul", {
-      children: createNodes(schema, "response"),
+    create("Schema", {
+      schema: schema,
+      schemaType: "response",
     }),
   ]);
 }

package/src/openapi/openapi.ts

@@ -30,6 +30,7 @@ import {
   SidebarOptions,
   TagPageMetadata,
 } from "../types";
+import { sampleResponseFromSchema } from "./createResponseExample";
 import { loadAndResolveSpec } from "./utils/loadAndResolveSpec";
 
 /**
@@ -451,6 +452,7 @@ function createItems(
                   .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
                   .replace(/\s+$/, "")
               : "",
+            sample: JSON.stringify(sampleResponseFromSchema(schemaObject)),
           },
           schema: schemaObject,
         };

package/src/options.ts

@@ -24,6 +24,7 @@ const markdownGenerators = Joi.object({
   createApiPageMD: Joi.function(),
   createInfoPageMD: Joi.function(),
   createTagPageMD: Joi.function(),
+  createSchemaPageMD: Joi.function(),
 });
 
 export const OptionsSchema = Joi.object({