Merge branch 'main' into fix-allof-in-array-item

Author: dsuket

.github/workflows/deploy-live.yml

@@ -39,6 +39,8 @@ jobs:
     name: Deploy
     needs: build
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
 
     steps:
       - name: Checkout repository
@@ -50,6 +52,16 @@ jobs:
           node-version: "20"
           cache: "yarn"
 
+      - name: Authenticate to Google Cloud
+        id: auth
+        uses: google-github-actions/auth@b7593ed2efd1c1617e1b0254da33b86225adb2a5
+        with:
+          workload_identity_provider: ${{ secrets.WIF_PROVIDER }}
+          service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}
+
+      - name: Export Google Cloud Credentials
+        run: echo "GCP_SA_KEY=$(cat ${{ steps.auth.outputs.credentials_file_path }})" >> $GITHUB_ENV
+
       - uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
         with:
           name: build
@@ -59,10 +71,10 @@ jobs:
 
       - name: Deploy to Firebase
         id: deploy_live
-        uses: FirebaseExtended/action-hosting-deploy@0cbcac4740c2bfb00d632f0b863b57713124eb5a # v0.9.0
+        uses: FirebaseExtended/action-hosting-deploy@e2eda2e106cfa35cdbcf4ac9ddaf6c4756df2c8c # v0.10.0
         with:
           repoToken: "${{ secrets.GITHUB_TOKEN }}"
-          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PANDEV }}"
+          firebaseServiceAccount: "${{ env.GCP_SA_KEY }}"
           projectId: pandev
           channelId: live
           target: docusaurus-openapi.tryingpan.dev

.github/workflows/deploy-preview.yml

@@ -2,7 +2,7 @@ name: "Deploy Preview"
 
 on:
   pull_request_target:
-    branches: [main, v3.0.0, v2.0.0]
+    branches: [main]
 
 jobs:
   precheck:
@@ -130,6 +130,7 @@ jobs:
       contents: read
       pull-requests: write
       checks: write
+      id-token: write
     outputs:
       preview_url: ${{ steps.deploy_preview.outputs.details_url }}
 
@@ -143,6 +144,16 @@ jobs:
           node-version: "20"
           cache: "yarn"
 
+      - name: Authenticate to Google Cloud
+        id: auth
+        uses: google-github-actions/auth@b7593ed2efd1c1617e1b0254da33b86225adb2a5
+        with:
+          workload_identity_provider: ${{ secrets.WIF_PROVIDER }}
+          service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}
+
+      - name: Export Google Cloud Credentials
+        run: echo "GCP_SA_KEY=$(cat ${{ steps.auth.outputs.credentials_file_path }})" >> $GITHUB_ENV
+
       - uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
         with:
           name: build
@@ -152,10 +163,10 @@ jobs:
 
       - name: Deploy to Firebase
         id: deploy_preview
-        uses: FirebaseExtended/action-hosting-deploy@0cbcac4740c2bfb00d632f0b863b57713124eb5a # v0.9.0
+        uses: FirebaseExtended/action-hosting-deploy@e2eda2e106cfa35cdbcf4ac9ddaf6c4756df2c8c # v0.10.0
         with:
           repoToken: "${{ secrets.GITHUB_TOKEN }}"
-          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PANDEV }}"
+          firebaseServiceAccount: "${{ env.GCP_SA_KEY }}"
           projectId: pandev
           expires: 30d
           channelId: "pr${{ github.event.number }}"
@@ -199,28 +210,3 @@ jobs:
         with:
           name: visual_diffs
           path: visual_diffs
-
-      # - name: Comment PR with results
-      #   if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target'
-      #   uses: actions/github-script@v7
-      #   with:
-      #     github-token: ${{ secrets.GITHUB_TOKEN }}
-      #     script: |
-      #       const fs = require('fs');
-      #       const results = JSON.parse(fs.readFileSync('visual_diffs/results.json', 'utf8'));
-      #       const runUrl = `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`;
-      #       let body = `### Visual Diff Summary\n\n[View Logs](${runUrl})\n\n`;
-      #       body += `Total: ${results.summary.total}, Matches: ${results.summary.matches}, Diffs: ${results.summary.mismatches}, Skipped: ${results.summary.skipped}\n\n`;
-      #       if (results.pages.length) {
-      #         body += '| Page | Status |\n| --- | --- |\n';
-      #         for (const p of results.pages) {
-      #           if (p.status !== 'match') {
-      #             body += `| ${p.path} | ${p.status} |\n`;
-      #           }
-      #         }
-      #       }
-      #       await github.rest.issues.createComment({
-      #         ...context.repo,
-      #         issue_number: context.issue.number,
-      #         body
-      #       });

demo/customMdGenerators.ts

@@ -49,7 +49,8 @@ export function myCustomApiMdGenerator({
     `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),
     createServersTable(servers),

packages/docusaurus-plugin-openapi-docs/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",
   ];
 }

packages/docusaurus-plugin-openapi-docs/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>",
               }),
             ]),
           ],

packages/docusaurus-plugin-openapi-docs/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),

packages/docusaurus-plugin-openapi-docs/src/plugin-content-docs-types.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>;
 

packages/docusaurus-plugin-openapi-docs/src/plugin-openapi.d.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;

packages/docusaurus-plugin-openapi-docs/src/types.ts

@@ -5,6 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import { translate } from "@docusaurus/Translate";
+import { OPENAPI_SCHEMA_ITEM } from "../theme/translationIds";
 import { SchemaObject } from "../types";
 
 function prettyName(schema: SchemaObject, circular?: boolean) {
@@ -72,7 +74,10 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
     return getQualifierMessage(schema.items);
   }
 
-  let message = "**Possible values:** ";
+  let message = `**${translate({
+    id: OPENAPI_SCHEMA_ITEM.POSSIBLE_VALUES,
+    message: "Possible values:",
+  })}** `;
 
   let qualifierGroups = [];