docusaurus-plugin-openapi-docs 0.0.0-454 → 0.0.0-458

package/lib/index.js

@@ -109,6 +109,7 @@ function pluginOpenAPIDocs(context, options) {
                 ? fs_1.default.readFileSync(template).toString()
                 : `---
 id: {{{id}}}
+description: "{{{description}}}"
 {{^api}}
 sidebar_label: Introduction
 {{/api}}
@@ -154,7 +155,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             const tagMdTemplate = `---
 id: {{{id}}}
 title: {{{description}}}
-description: {{{description}}}
+description: "{{{description}}}"
 custom_edit_url: null
 ---
 

package/lib/markdown/createRequestSchema.js

@@ -43,7 +43,7 @@ exports.mergeAllOf = mergeAllOf;
  */
 function createAnyOneOf(schema) {
     const type = schema.oneOf ? "oneOf" : "anyOf";
-    return (0, utils_1.create)("li", {
+    return (0, utils_1.create)("div", {
         children: [
             (0, utils_1.create)("div", {
                 children: [

package/lib/markdown/createResponseSchema.js

@@ -44,7 +44,7 @@ exports.mergeAllOf = mergeAllOf;
  */
 function createAnyOneOf(schema) {
     const type = schema.oneOf ? "oneOf" : "anyOf";
-    return (0, utils_1.create)("li", {
+    return (0, utils_1.create)("div", {
         children: [
             (0, utils_1.create)("div", {
                 children: [

package/lib/markdown/createStatusCodes.js

@@ -68,7 +68,7 @@ function createResponseHeaders(responseHeaders) {
             Object.entries(responseHeaders).map(([headerName, headerObj]) => {
                 const { description, schema: { type }, example, } = headerObj;
                 return (0, utils_1.create)("li", {
-                    class: "schemaItem",
+                    className: "schemaItem",
                     children: [
                         (0, createDetailsSummary_1.createDetailsSummary)({
                             children: [

package/lib/openapi/openapi.js

@@ -95,7 +95,9 @@ function createItems(openapiData, sidebarOptions) {
             id: infoId,
             unversionedId: infoId,
             title: openapiData.info.title,
-            description: openapiData.info.description,
+            description: openapiData.info.description
+                ? openapiData.info.description.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                : "",
             frontMatter: {},
             securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
@@ -155,7 +157,9 @@ function createItems(openapiData, sidebarOptions) {
                 infoId: infoId !== null && infoId !== void 0 ? infoId : "",
                 unversionedId: baseId,
                 title: title,
-                description: description !== null && description !== void 0 ? description : "",
+                description: operationObject.description
+                    ? operationObject.description.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                    : "",
                 frontMatter: {},
                 api: {
                     ...defaults,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-454",
+  "version": "0.0.0-458",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0872ad020e8a4f053206a2b7b7ab7edcefe11276"
+  "gitHead": "1c9979d056ad00b54864147ccc3c78039cd774f5"
 }

package/src/index.ts

@@ -143,6 +143,7 @@ export default function pluginOpenAPIDocs(
         ? fs.readFileSync(template).toString()
         : `---
 id: {{{id}}}
+description: "{{{description}}}"
 {{^api}}
 sidebar_label: Introduction
 {{/api}}
@@ -190,7 +191,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       const tagMdTemplate = `---
 id: {{{id}}}
 title: {{{description}}}
-description: {{{description}}}
+description: "{{{description}}}"
 custom_edit_url: null
 ---
 

package/src/markdown/createRequestSchema.ts

@@ -46,7 +46,7 @@ export function mergeAllOf(allOf: SchemaObject[]) {
  */
 function createAnyOneOf(schema: SchemaObject): any {
   const type = schema.oneOf ? "oneOf" : "anyOf";
-  return create("li", {
+  return create("div", {
     children: [
       create("div", {
         children: [

package/src/markdown/createResponseSchema.ts

@@ -51,7 +51,7 @@ export function mergeAllOf(allOf: SchemaObject[]) {
  */
 function createAnyOneOf(schema: SchemaObject): any {
   const type = schema.oneOf ? "oneOf" : "anyOf";
-  return create("li", {
+  return create("div", {
     children: [
       create("div", {
         children: [

package/src/markdown/createStatusCodes.ts

@@ -70,7 +70,7 @@ function createResponseHeaders(responseHeaders: any) {
           }: any = headerObj;
 
           return create("li", {
-            class: "schemaItem",
+            className: "schemaItem",
             children: [
               createDetailsSummary({
                 children: [

package/src/openapi/openapi.ts

@@ -119,7 +119,12 @@ function createItems(
       id: infoId,
       unversionedId: infoId,
       title: openapiData.info.title,
-      description: openapiData.info.description,
+      description: openapiData.info.description
+        ? openapiData.info.description.replace(
+            /((?:^|[^\\])(?:\\{2})*)"/g,
+            "$1'"
+          )
+        : "",
       frontMatter: {},
       securitySchemes: openapiData.components?.securitySchemes,
       info: {
@@ -194,7 +199,12 @@ function createItems(
         infoId: infoId ?? "",
         unversionedId: baseId,
         title: title,
-        description: description ?? "",
+        description: operationObject.description
+          ? operationObject.description.replace(
+              /((?:^|[^\\])(?:\\{2})*)"/g,
+              "$1'"
+            )
+          : "",
         frontMatter: {},
         api: {
           ...defaults,