docusaurus-plugin-openapi-docs 1.2.2 → 1.3.0

package/lib/markdown/createRequestSchema.js

@@ -566,7 +566,7 @@ function createRequestSchema({ title, body, ...rest }) {
     const mimeTypes = Object.keys(body.content);
     if (mimeTypes && mimeTypes.length > 1) {
         return (0, utils_1.create)("MimeTabs", {
-            groupId: "mime-type",
+            schemaType: "request",
             children: mimeTypes.map((mimeType) => {
                 const firstBody = body.content[mimeType].schema;
                 if (firstBody === undefined) {

package/lib/markdown/createResponseSchema.js

@@ -566,7 +566,7 @@ function createResponseSchema({ title, body, ...rest }) {
     const mimeTypes = Object.keys(body.content);
     if (mimeTypes && mimeTypes.length) {
         return (0, utils_1.create)("MimeTabs", {
-            groupId: "mime-type",
+            schemaType: "response",
             children: mimeTypes.map((mimeType) => {
                 const responseExamples = body.content[mimeType].examples;
                 const responseExample = body.content[mimeType].example;

package/lib/openapi/openapi.js

@@ -18,6 +18,7 @@ const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
+const unionBy_1 = __importDefault(require("lodash/unionBy"));
 const index_1 = require("../index");
 const createRequestExample_1 = require("./createRequestExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
@@ -151,6 +152,16 @@ function createItems(openapiData, sidebarOptions) {
             }
             // TODO: Don't include summary temporarilly
             const { summary, ...defaults } = operationObject;
+            // Merge common parameters with operation parameters
+            // Operation params take precendence over common params
+            if (parameters !== undefined) {
+                if (operationObject.parameters !== undefined) {
+                    defaults.parameters = (0, unionBy_1.default)(operationObject.parameters, parameters, "name");
+                }
+                else {
+                    defaults.parameters = parameters;
+                }
+            }
             const apiPage = {
                 type: "api",
                 id: baseId,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "cfeb5216f143133a1c35587fef21f75a44b75854"
+  "gitHead": "b599d062a8e4f1cff86b01ac9b82dc564defbf5f"
 }

package/src/markdown/createRequestSchema.ts

@@ -721,7 +721,7 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
 
   if (mimeTypes && mimeTypes.length > 1) {
     return create("MimeTabs", {
-      groupId: "mime-type",
+      schemaType: "request",
       children: mimeTypes.map((mimeType) => {
         const firstBody = body.content![mimeType].schema;
         if (firstBody === undefined) {

package/src/markdown/createResponseSchema.ts

@@ -721,7 +721,7 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
 
   if (mimeTypes && mimeTypes.length) {
     return create("MimeTabs", {
-      groupId: "mime-type",
+      schemaType: "response",
       children: mimeTypes.map((mimeType: any) => {
         const responseExamples = body.content![mimeType].examples;
         const responseExample = body.content![mimeType].example;

package/src/openapi/openapi.ts

@@ -15,6 +15,7 @@ import chalk from "chalk";
 import fs from "fs-extra";
 import cloneDeep from "lodash/cloneDeep";
 import kebabCase from "lodash/kebabCase";
+import unionBy from "lodash/unionBy";
 
 import { isURL } from "../index";
 import {
@@ -193,6 +194,20 @@ function createItems(
       // TODO: Don't include summary temporarilly
       const { summary, ...defaults } = operationObject;
 
+      // Merge common parameters with operation parameters
+      // Operation params take precendence over common params
+      if (parameters !== undefined) {
+        if (operationObject.parameters !== undefined) {
+          defaults.parameters = unionBy(
+            operationObject.parameters,
+            parameters,
+            "name"
+          );
+        } else {
+          defaults.parameters = parameters;
+        }
+      }
+
       const apiPage: PartialPage<ApiPageMetadata> = {
         type: "api",
         id: baseId,