docusaurus-plugin-openapi-docs 2.0.0 → 2.0.2

package/lib/markdown/createRequestSchema.js

@@ -74,7 +74,7 @@ function createRequestSchema({ title, body, ...rest }) {
                                 }),
                                 (0, utils_1.create)("ul", {
                                     style: { marginLeft: "1rem" },
-                                    children: (0, createSchema_1.createNodes)(firstBody),
+                                    children: (0, createSchema_1.createNodes)(firstBody, "request"),
                                 }),
                             ],
                         }),
@@ -139,7 +139,7 @@ function createRequestSchema({ title, body, ...rest }) {
                             }),
                             (0, utils_1.create)("ul", {
                                 style: { marginLeft: "1rem" },
-                                children: (0, createSchema_1.createNodes)(firstBody),
+                                children: (0, createSchema_1.createNodes)(firstBody, "request"),
                             }),
                         ],
                     }),

package/lib/markdown/createResponseSchema.js

@@ -89,7 +89,7 @@ function createResponseSchema({ title, body, ...rest }) {
                                                     }),
                                                     (0, utils_1.create)("ul", {
                                                         style: { marginLeft: "1rem" },
-                                                        children: (0, createSchema_1.createNodes)(firstBody),
+                                                        children: (0, createSchema_1.createNodes)(firstBody, "response"),
                                                     }),
                                                 ],
                                             }),

package/lib/markdown/createSchema.d.ts

@@ -9,4 +9,4 @@ export declare function mergeAllOf(allOf: SchemaObject[]): {
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
-export declare function createNodes(schema: SchemaObject): any;
+export declare function createNodes(schema: SchemaObject, schemaType: "request" | "response"): any;

package/lib/markdown/createSchema.js

@@ -18,6 +18,7 @@ const createDetailsSummary_1 = require("./createDetailsSummary");
 const schema_1 = require("./schema");
 const utils_1 = require("./utils");
 const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
+let SCHEMA_TYPE;
 /**
  * Returns a merged representation of allOf array of schemas.
  */
@@ -27,6 +28,9 @@ function mergeAllOf(allOf) {
             readOnly: function () {
                 return true;
             },
+            writeOnly: function () {
+                return true;
+            },
             example: function () {
                 return true;
             },
@@ -68,7 +72,7 @@ function createAnyOneOf(schema) {
                         delete anyOneSchema.properties;
                     }
                     if (anyOneSchema.allOf !== undefined) {
-                        anyOneChildren.push(createNodes(anyOneSchema));
+                        anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
                         delete anyOneSchema.allOf;
                     }
                     if (anyOneSchema.items !== undefined) {
@@ -79,7 +83,7 @@ function createAnyOneOf(schema) {
                         anyOneSchema.type === "number" ||
                         anyOneSchema.type === "integer" ||
                         anyOneSchema.type === "boolean") {
-                        anyOneChildren.push(createNodes(anyOneSchema));
+                        anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
                     }
                     if (anyOneChildren.length) {
                         if (schema.type === "array") {
@@ -257,7 +261,7 @@ function createItems(schema) {
         ((_l = schema.items) === null || _l === void 0 ? void 0 : _l.type) === "object") {
         return [
             (0, createArrayBracket_1.createOpeningArrayBracket)(),
-            createNodes(schema.items),
+            createNodes(schema.items, SCHEMA_TYPE),
             (0, createArrayBracket_1.createClosingArrayBracket)(),
         ].flat();
     }
@@ -344,7 +348,7 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
                                 style: { marginTop: ".5rem", marginBottom: ".5rem" },
                                 children: (0, createDescription_1.createDescription)(description),
                             })),
-                            createNodes(schema),
+                            createNodes(schema, SCHEMA_TYPE),
                         ],
                     }),
                 ],
@@ -466,7 +470,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
                             // className: "openapi-tabs__discriminator-item",
                             label: label,
                             value: `${index}-item-discriminator`,
-                            children: [createNodes(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping[key])],
+                            children: [createNodes(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping[key], SCHEMA_TYPE)],
                         });
                     }),
                 }),
@@ -503,8 +507,15 @@ function createEdges({ name, schema, required, discriminator, }) {
         if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
             return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
         }
-        if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
-            return undefined;
+        if (SCHEMA_TYPE === "request") {
+            if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+                return undefined;
+            }
+        }
+        if (SCHEMA_TYPE === "response") {
+            if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
+                return undefined;
+            }
         }
         return (0, utils_1.create)("SchemaItem", {
             collapsible: false,
@@ -528,8 +539,15 @@ function createEdges({ name, schema, required, discriminator, }) {
     if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
         return createDetailsNode(name, schemaName, schema, required, schema.nullable);
     }
-    if (schema.readOnly && schema.readOnly === true) {
-        return undefined;
+    if (SCHEMA_TYPE === "request") {
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
+    }
+    if (SCHEMA_TYPE === "response") {
+        if (schema.writeOnly && schema.writeOnly === true) {
+            return undefined;
+        }
     }
     // primitives and array of non-objects
     return (0, utils_1.create)("SchemaItem", {
@@ -544,7 +562,8 @@ function createEdges({ name, schema, required, discriminator, }) {
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
-function createNodes(schema) {
+function createNodes(schema, schemaType) {
+    SCHEMA_TYPE = schemaType;
     const nodes = [];
     // if (schema.discriminator !== undefined) {
     //   return createDiscriminator(schema);

package/lib/markdown/createSchema.test.js

@@ -68,6 +68,6 @@ describe("createNodes", () => {
                 },
             },
         };
-        expect((0, createSchema_1.createNodes)(schema).map((md) => prettier.format(md, { parser: "babel" }))).toMatchSnapshot();
+        expect((0, createSchema_1.createNodes)(schema, "request").map((md) => prettier.format(md, { parser: "babel" }))).toMatchSnapshot();
     });
 });

package/lib/openapi/openapi.js

@@ -373,7 +373,7 @@ function bindCollectionToApiItems(items, postmanCollection) {
         const method = item.request.method.toLowerCase();
         const path = item.request.url
             .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
-            .replace(/:([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
+            .replace(/(?<![a-z0-9-_]+):([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
         const apiItem = items.find((item) => {
             if (item.type === "info" || item.type === "tag") {
                 return false;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ec57fe9cac964cff00f5433fb829ce2d6219da7e"
+  "gitHead": "7f9528595b373f7691fd63845d84870549e6895c"
 }

package/src/markdown/createRequestSchema.ts

@@ -90,7 +90,7 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
                 }),
                 create("ul", {
                   style: { marginLeft: "1rem" },
-                  children: createNodes(firstBody),
+                  children: createNodes(firstBody, "request"),
                 }),
               ],
             }),
@@ -161,7 +161,7 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
               }),
               create("ul", {
                 style: { marginLeft: "1rem" },
-                children: createNodes(firstBody),
+                children: createNodes(firstBody, "request"),
               }),
             ],
           }),

package/src/markdown/createResponseSchema.ts

@@ -118,7 +118,7 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
                           }),
                           create("ul", {
                             style: { marginLeft: "1rem" },
-                            children: createNodes(firstBody!),
+                            children: createNodes(firstBody!, "response"),
                           }),
                         ],
                       }),

package/src/markdown/createSchema.test.ts

@@ -48,7 +48,7 @@ describe("createNodes", () => {
       },
     };
     expect(
-      createNodes(schema).map((md: any) =>
+      createNodes(schema, "request").map((md: any) =>
         prettier.format(md, { parser: "babel" })
       )
     ).toMatchSnapshot();

package/src/markdown/createSchema.ts

@@ -20,6 +20,8 @@ import { create, guard } from "./utils";
 
 const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 
+let SCHEMA_TYPE: "request" | "response";
+
 /**
  * Returns a merged representation of allOf array of schemas.
  */
@@ -29,6 +31,9 @@ export function mergeAllOf(allOf: SchemaObject[]) {
       readOnly: function () {
         return true;
       },
+      writeOnly: function () {
+        return true;
+      },
       example: function () {
         return true;
       },
@@ -74,7 +79,7 @@ function createAnyOneOf(schema: SchemaObject): any {
           }
 
           if (anyOneSchema.allOf !== undefined) {
-            anyOneChildren.push(createNodes(anyOneSchema));
+            anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
             delete anyOneSchema.allOf;
           }
 
@@ -89,7 +94,7 @@ function createAnyOneOf(schema: SchemaObject): any {
             anyOneSchema.type === "integer" ||
             anyOneSchema.type === "boolean"
           ) {
-            anyOneChildren.push(createNodes(anyOneSchema));
+            anyOneChildren.push(createNodes(anyOneSchema, SCHEMA_TYPE));
           }
           if (anyOneChildren.length) {
             if (schema.type === "array") {
@@ -304,7 +309,7 @@ function createItems(schema: SchemaObject) {
   ) {
     return [
       createOpeningArrayBracket(),
-      createNodes(schema.items),
+      createNodes(schema.items, SCHEMA_TYPE),
       createClosingArrayBracket(),
     ].flat();
   }
@@ -411,7 +416,7 @@ function createDetailsNode(
                   children: createDescription(description),
                 })
               ),
-              createNodes(schema),
+              createNodes(schema, SCHEMA_TYPE),
             ],
           }),
         ],
@@ -565,7 +570,7 @@ function createPropertyDiscriminator(
               // className: "openapi-tabs__discriminator-item",
               label: label,
               value: `${index}-item-discriminator`,
-              children: [createNodes(discriminator?.mapping[key])],
+              children: [createNodes(discriminator?.mapping[key], SCHEMA_TYPE)],
             });
           }),
         }),
@@ -664,8 +669,16 @@ function createEdges({
       );
     }
 
-    if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
-      return undefined;
+    if (SCHEMA_TYPE === "request") {
+      if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+        return undefined;
+      }
+    }
+
+    if (SCHEMA_TYPE === "response") {
+      if (mergedSchemas.writeOnly && mergedSchemas.writeOnly === true) {
+        return undefined;
+      }
     }
 
     return create("SchemaItem", {
@@ -719,8 +732,16 @@ function createEdges({
     );
   }
 
-  if (schema.readOnly && schema.readOnly === true) {
-    return undefined;
+  if (SCHEMA_TYPE === "request") {
+    if (schema.readOnly && schema.readOnly === true) {
+      return undefined;
+    }
+  }
+
+  if (SCHEMA_TYPE === "response") {
+    if (schema.writeOnly && schema.writeOnly === true) {
+      return undefined;
+    }
   }
 
   // primitives and array of non-objects
@@ -737,7 +758,11 @@ function createEdges({
 /**
  * Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
  */
-export function createNodes(schema: SchemaObject): any {
+export function createNodes(
+  schema: SchemaObject,
+  schemaType: "request" | "response"
+): any {
+  SCHEMA_TYPE = schemaType;
   const nodes = [];
   // if (schema.discriminator !== undefined) {
   //   return createDiscriminator(schema);

package/src/openapi/openapi.ts

@@ -469,8 +469,7 @@ function bindCollectionToApiItems(
     const method = item.request.method.toLowerCase();
     const path = item.request.url
       .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
-      .replace(/:([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
-
+      .replace(/(?<![a-z0-9-_]+):([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
     const apiItem = items.find((item) => {
       if (item.type === "info" || item.type === "tag") {
         return false;