docusaurus-plugin-openapi-docs 4.0.0 → 4.1.0

package/src/markdown/createCallbackMethodEndpoint.ts

@@ -0,0 +1,19 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import { create } from "./utils";
+
+export function createCallbackMethodEndpoint(method: String, path: String) {
+  return [
+    create("MethodEndpoint", {
+      method: method,
+      path: path,
+      context: "callback",
+    }),
+    "\n\n",
+  ];
+}

package/src/markdown/createCallbacks.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import { createCallbackMethodEndpoint } from "./createCallbackMethodEndpoint";
 import { createDescription } from "./createDescription";
-import { createMethodEndpoint } from "./createMethodEndpoint";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
 import { createStatusCodes } from "./createStatusCodes";
 import { create } from "./utils";
@@ -78,7 +78,7 @@ export function createCallbacks({ callbacks }: Props) {
                 label: `${method.toUpperCase()} ${name}`,
                 value: `${method}-${name}`,
                 children: [
-                  createMethodEndpoint(method, path),
+                  createCallbackMethodEndpoint(method, path),
                   // TODO: add `deprecation notice` when markdown support is added
                   createDescription(description),
                   createRequestBodyDetails({

package/src/markdown/createDeprecationNotice.ts

@@ -23,8 +23,9 @@ export function createDeprecationNotice({
   return guard(deprecated, () =>
     createAdmonition({
       children:
-        clean(description) ??
-        "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+        description && description.length > 0
+          ? clean(description)
+          : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
     })
   );
 }

package/src/markdown/createMethodEndpoint.ts

@@ -8,5 +8,12 @@
 import { create } from "./utils";
 
 export function createMethodEndpoint(method: String, path: String) {
-  return [create("MethodEndpoint", { method: method, path: path }), "\n\n"];
+  return [
+    create("MethodEndpoint", {
+      method: method,
+      path: path,
+      context: "endpoint",
+    }),
+    "\n\n",
+  ];
 }

package/src/markdown/createParamsDetails.ts

@@ -43,12 +43,19 @@ export function createParamsDetails({ parameters, type }: Props) {
       create("div", {
         children: [
           create("ul", {
-            children: params.map((param) =>
-              create("ParamsItem", {
+            children: params.map((param) => {
+              return create("ParamsItem", {
                 className: "paramsItem",
-                param: param,
-              })
-            ),
+                param: {
+                  ...param,
+                  enumDescriptions: Object.entries(
+                    param?.schema?.["x-enumDescriptions"] ??
+                      param?.schema?.items?.["x-enumDescriptions"] ??
+                      {}
+                  ),
+                },
+              });
+            }),
           }),
         ],
       }),