docusaurus-plugin-openapi-docs 1.2.1 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Palo Alto Networks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/markdown/createStatusCodes.js

@@ -117,6 +117,11 @@ function createResponseExamples(responseExamples, mimeType) {
                 label: `${finalFormattedName}`,
                 value: `${finalFormattedName}`,
                 children: [
+                    (0, utils_2.guard)(exampleValue.summary, (summary) => [
+                        (0, utils_1.create)("p", {
+                            children: ` ${summary}`,
+                        }),
+                    ]),
                     (0, utils_1.create)("ResponseSamples", {
                         responseExample: JSON.stringify(exampleValue.value, null, 2),
                         language: language,
@@ -128,6 +133,11 @@ function createResponseExamples(responseExamples, mimeType) {
             label: `${finalFormattedName}`,
             value: `${finalFormattedName}`,
             children: [
+                (0, utils_2.guard)(exampleValue.summary, (summary) => [
+                    (0, utils_1.create)("p", {
+                        children: ` ${summary}`,
+                    }),
+                ]),
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: exampleValue.value,
                     language: language,
@@ -150,6 +160,11 @@ function createResponseExample(responseExample, mimeType) {
             label: `Example`,
             value: `Example`,
             children: [
+                (0, utils_2.guard)(responseExample.summary, (summary) => [
+                    (0, utils_1.create)("p", {
+                        children: ` ${summary}`,
+                    }),
+                ]),
                 (0, utils_1.create)("ResponseSamples", {
                     responseExample: JSON.stringify(responseExample, null, 2),
                     language: language,
@@ -161,6 +176,11 @@ function createResponseExample(responseExample, mimeType) {
         label: `Example`,
         value: `Example`,
         children: [
+            (0, utils_2.guard)(responseExample.summary, (summary) => [
+                (0, utils_1.create)("p", {
+                    children: ` ${summary}`,
+                }),
+            ]),
             (0, utils_1.create)("ResponseSamples", {
                 responseExample: responseExample,
                 language: language,

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.1",
+  "version": "1.3.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,6 @@
   },
   "engines": {
     "node": ">=14"
-  }
+  },
+  "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/markdown/createStatusCodes.ts

@@ -129,6 +129,11 @@ export function createResponseExamples(
           label: `${finalFormattedName}`,
           value: `${finalFormattedName}`,
           children: [
+            guard(exampleValue.summary, (summary) => [
+              create("p", {
+                children: ` ${summary}`,
+              }),
+            ]),
             create("ResponseSamples", {
               responseExample: JSON.stringify(exampleValue.value, null, 2),
               language: language,
@@ -140,6 +145,11 @@ export function createResponseExamples(
         label: `${finalFormattedName}`,
         value: `${finalFormattedName}`,
         children: [
+          guard(exampleValue.summary, (summary) => [
+            create("p", {
+              children: ` ${summary}`,
+            }),
+          ]),
           create("ResponseSamples", {
             responseExample: exampleValue.value,
             language: language,
@@ -163,6 +173,11 @@ export function createResponseExample(responseExample: any, mimeType: string) {
       label: `Example`,
       value: `Example`,
       children: [
+        guard(responseExample.summary, (summary) => [
+          create("p", {
+            children: ` ${summary}`,
+          }),
+        ]),
         create("ResponseSamples", {
           responseExample: JSON.stringify(responseExample, null, 2),
           language: language,
@@ -174,6 +189,11 @@ export function createResponseExample(responseExample: any, mimeType: string) {
     label: `Example`,
     value: `Example`,
     children: [
+      guard(responseExample.summary, (summary) => [
+        create("p", {
+          children: ` ${summary}`,
+        }),
+      ]),
       create("ResponseSamples", {
         responseExample: responseExample,
         language: language,

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,