docusaurus-plugin-openapi-docs 0.0.0-1055 → 0.0.0-1068

package/lib/markdown/createRequestHeader.js

@@ -11,11 +11,13 @@ const utils_1 = require("./utils");
 function createRequestHeader(header) {
     return [
         (0, utils_1.create)("Heading", {
-            children: header,
             id: header.replace(" ", "-").toLowerCase(),
             as: "h2",
             className: "openapi-tabs__heading",
-        }, { inline: true }),
-        `\n\n`,
+            children: [
+                `<Translate id="theme.openapi.request.title">${header}</Translate>`,
+            ],
+        }),
+        "\n\n",
     ];
 }

package/lib/markdown/createSchema.js

@@ -316,7 +316,7 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
                                         : required === true, () => [
                                         (0, utils_1.create)("span", {
                                             className: "openapi-schema__required",
-                                            children: "required",
+                                            children: "<Translate id='theme.openapi.schemaItem.required'>required</Translate>",
                                         }),
                                     ]),
                                     (0, utils_1.guard)(schema.deprecated, () => [
@@ -454,7 +454,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
                         (0, utils_1.guard)(required, () => [
                             (0, utils_1.create)("span", {
                                 className: "openapi-schema__required",
-                                children: "required",
+                                children: "<Translate id='theme.openapi.schemaItem.required'>required</Translate>",
                             }),
                         ]),
                     ],

package/lib/markdown/index.js

@@ -37,7 +37,8 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         `import StatusCodes from "@theme/StatusCodes";\n`,
         `import OperationTabs from "@theme/OperationTabs";\n`,
         `import TabItem from "@theme/TabItem";\n`,
-        `import Heading from "@theme/Heading";\n\n`,
+        `import Heading from "@theme/Heading";\n`,
+        `import Translate from "@docusaurus/Translate";\n\n`,
         (0, createHeading_1.createHeading)(title),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),

package/lib/types.d.ts

@@ -1,6 +1,6 @@
-import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
+import type { SidebarItemDoc } from "@docusaurus/plugin-content-docs/lib/sidebars/types";
 import { InfoObject, OperationObject, SchemaObject, SecuritySchemeObject, TagObject } from "./openapi/types";
-export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
+export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs/lib/sidebars/types";
 export interface PluginOptions {
     id?: string;
     docsPlugin?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1055",
+  "version": "0.0.0-1068",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "032eb64b64b19ba5d04fad6c1dcfaa2a96952f71"
+  "gitHead": "d18835ed938d31e72d4c57d272902a3818eac708"
 }

package/src/markdown/createRequestHeader.ts

@@ -9,16 +9,14 @@ import { create } from "./utils";
 
 export function createRequestHeader(header: string) {
   return [
-    create(
-      "Heading",
-      {
-        children: header,
-        id: header.replace(" ", "-").toLowerCase(),
-        as: "h2",
-        className: "openapi-tabs__heading",
-      },
-      { inline: true }
-    ),
-    `\n\n`,
+    create("Heading", {
+      id: header.replace(" ", "-").toLowerCase(),
+      as: "h2",
+      className: "openapi-tabs__heading",
+      children: [
+        `<Translate id="theme.openapi.request.title">${header}</Translate>`,
+      ],
+    }),
+    "\n\n",
   ];
 }

package/src/markdown/createSchema.ts

@@ -375,7 +375,8 @@ function createDetailsNode(
                     () => [
                       create("span", {
                         className: "openapi-schema__required",
-                        children: "required",
+                        children:
+                          "<Translate id='theme.openapi.schemaItem.required'>required</Translate>",
                       }),
                     ]
                   ),
@@ -530,7 +531,8 @@ function createPropertyDiscriminator(
             guard(required, () => [
               create("span", {
                 className: "openapi-schema__required",
-                children: "required",
+                children:
+                  "<Translate id='theme.openapi.schemaItem.required'>required</Translate>",
               }),
             ]),
           ],

package/src/markdown/index.ts

@@ -72,7 +72,8 @@ export function createApiPageMD({
     `import StatusCodes from "@theme/StatusCodes";\n`,
     `import OperationTabs from "@theme/OperationTabs";\n`,
     `import TabItem from "@theme/TabItem";\n`,
-    `import Heading from "@theme/Heading";\n\n`,
+    `import Heading from "@theme/Heading";\n`,
+    `import Translate from "@docusaurus/Translate";\n\n`,
     createHeading(title),
     createMethodEndpoint(method, path),
     infoPath && createAuthorization(infoPath),

package/src/plugin-openapi.d.ts

@@ -11,7 +11,7 @@ import type { FrontMatter as DocsFrontMatter } from "@docusaurus/types";
 import type { Props as DocsProps } from "@docusaurus/types";
 
 declare module "docusaurus-plugin-openapi-docs" {
-  import type { PropSidebars } from "@docusaurus/plugin-content-docs-types";
+  import type { PropSidebars } from "@docusaurus/plugin-content-docs/lib/sidebars/types";
 
   export type Options = Partial<import("./types").APIOptions>;
 

package/src/types.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
+import type { SidebarItemDoc } from "@docusaurus/plugin-content-docs/lib/sidebars/types";
 import Request from "postman-collection";
 
 import {
@@ -21,7 +21,7 @@ export type {
   SidebarItemLink,
   PropSidebar,
   PropSidebarItem,
-} from "@docusaurus/plugin-content-docs-types";
+} from "@docusaurus/plugin-content-docs/lib/sidebars/types";
 export interface PluginOptions {
   id?: string;
   docsPlugin?: string;

package/src/plugin-content-docs-types.d.ts

@@ -1,42 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-declare module "@docusaurus/plugin-content-docs-types" {
-  // Makes all properties visible when hovering over the type
-  type Expand<T extends Record<string, unknown>> = { [P in keyof T]: T[P] };
-
-  export type SidebarItemBase = {
-    className?: string;
-    customProps?: Record<string, unknown>;
-  };
-
-  export type SidebarItemLink = SidebarItemBase & {
-    type: "link";
-    href: string;
-    label: string;
-    docId: string;
-  };
-
-  type SidebarItemCategoryBase = SidebarItemBase & {
-    type: "category";
-    label: string;
-    collapsed: boolean;
-    collapsible: boolean;
-  };
-
-  export type PropSidebarItemCategory = Expand<
-    SidebarItemCategoryBase & {
-      items: PropSidebarItem[];
-    }
-  >;
-
-  export type PropSidebarItem = SidebarItemLink | PropSidebarItemCategory;
-  export type PropSidebar = PropSidebarItem[];
-  export type PropSidebars = {
-    [sidebarId: string]: PropSidebar;
-  };
-}