CO-622-initial-commit-changeset

Ahkshaey Ravi · Ahkshaey Ravi · commit e0e13ead611b · 2026-03-10T13:41:16.000+05:30
diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml
@@ -18,7 +18,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             node_modules
@@ -37,7 +37,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             node_modules
@@ -59,7 +59,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             node_modules
@@ -79,7 +79,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: "18"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             node_modules
diff --git a/demo/.env.sample b/demo/.env.sample
@@ -0,0 +1,3 @@
+ALGOLIA_API_KEY=xxxxxxxx
+ALGOLIA_APP_ID=yyyyyyyy
+ALGOLIA_INDEX_NAME=zzzzzzzz
diff --git a/demo/.gitignore b/demo/.gitignore
@@ -14,6 +14,7 @@
 .env.development.local
 .env.test.local
 .env.production.local
+.env
 
 npm-debug.log*
 yarn-debug.log*
diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js
@@ -2,6 +2,7 @@
 // Note: type annotations allow type checking and IDEs autocompletion
 
 const { DOCUSAURUS_VERSION } = require("@docusaurus/utils");
+require("dotenv").config();
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -190,9 +191,9 @@ const config = {
         },
       ],
       algolia: {
-        apiKey: "441074cace987cbf4640c039ebed303c",
-        appId: "J0EABTYI1A",
-        indexName: "docusaurus-openapi",
+        apiKey: process.env.ALGOLIA_API_KEY,
+        appId: process.env.ALGOLIA_APP_ID,
+        indexName: process.env.ALGOLIA_INDEX_NAME,
       },
       announcementBar: {
         id: "announcementBar_1",
diff --git a/demo/package.json b/demo/package.json
@@ -28,6 +28,7 @@
     "@mxenabled/docusaurus-plugin-openapi-docs": "^2.0.3",
     "@mxenabled/docusaurus-theme-openapi-docs": "^2.0.3",
     "clsx": "^1.1.1",
+    "dotenv": "^17.3.1",
     "prism-react-renderer": "^2.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createAuthentication.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createAuthentication.ts
@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { OAuthFlowObject, SecuritySchemeObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { create, guard } from "./utils";
+import { OAuthFlowObject, SecuritySchemeObject } from "../openapi/types";
 
 export function createAuthentication(securitySchemes: SecuritySchemeObject) {
   if (!securitySchemes || !Object.keys(securitySchemes).length) return "";
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createContactInfo.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createContactInfo.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ContactObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { ContactObject } from "../openapi/types";
 
 export function createContactInfo(contact: ContactObject) {
   if (!contact || !Object.keys(contact).length) return "";
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createEndpoint.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createEndpoint.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ApiPageMetadata } from "../types";
 import { create } from "./utils";
+import { ApiPageMetadata } from "../types";
 
 type Method = Pick<ApiPageMetadata, "api">["api"]["method"];
 type Path = Pick<ApiPageMetadata, "api">["api"]["path"];
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createLicense.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createLicense.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { LicenseObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { LicenseObject } from "../openapi/types";
 
 export function createLicense(license: LicenseObject) {
   if (!license || !Object.keys(license).length) return "";
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createLogo.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createLogo.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { LogoObject } from "../openapi/types";
 import { create, guard } from "./utils";
+import { LogoObject } from "../openapi/types";
 
 export function createLogo(
   logo: LogoObject | undefined,
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createParamsDetails.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createParamsDetails.ts
@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import { create } from "./utils";
 import { ApiItem } from "../types";
 // import { createDetails } from "./createDetails";
 // import { createDetailsSummary } from "./createDetailsSummary";
-import { create } from "./utils";
 
 interface Props {
   parameters: ApiItem["parameters"];
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestBodyDetails.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestBodyDetails.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject } from "../openapi/types";
 import { createRequestSchema } from "./createRequestSchema";
+import { MediaTypeObject } from "../openapi/types";
 
 interface Props {
   title: string;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createRequestSchema.ts
@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject, SchemaObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { createNodes } from "./createSchema";
 import { create } from "./utils";
+import { MediaTypeObject, SchemaObject } from "../openapi/types";
 
 interface Props {
   style?: any;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createResponseSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createResponseSchema.ts
@@ -5,18 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { MediaTypeObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 // import { createDetails } from "./createDetails";
 // import { createDetailsSummary } from "./createDetailsSummary";
 import { getRequestBody as getResponseBody } from "./createRequestSchema";
+import { create } from "./utils";
+import { MediaTypeObject } from "../openapi/types";
 // import { createNodes } from "./createSchema";
 // import {
 //   createExampleFromSchema,
 //   createResponseExample,
 //   createResponseExamples,
 // } from "./createStatusCodes";
-import { create } from "./utils";
 
 interface Props {
   style?: any;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createSchema.ts
@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { SchemaObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { getQualifierMessage, getSchemaName } from "./schema";
 import { create } from "./utils";
+import { SchemaObject } from "../openapi/types";
 
 const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/createStatusCodes.ts
@@ -7,14 +7,14 @@
 
 import format from "xml-formatter";
 
-import { sampleResponseFromSchema } from "../openapi/createResponseExample";
-import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
 import { createResponseSchema } from "./createResponseSchema";
 import { create } from "./utils";
 import { guard } from "./utils";
+import { sampleResponseFromSchema } from "../openapi/createResponseExample";
+import { ApiItem } from "../types";
 
 export default function json2xml(o: any, tab: any) {
   var toXml = function (v: any, name: string, ind: any) {
diff --git a/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts b/packages/docusaurus-plugin-openapi-docs/src/markdown/index.ts
@@ -5,29 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import { createVersionBadge } from "./createVersionBadge";
+import { greaterThan, lessThan, render } from "./utils";
 import {
   ContactObject,
   LicenseObject,
   // MediaTypeObject,
   SecuritySchemeObject,
 } from "../openapi/types";
 import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
-import { createAuthentication } from "./createAuthentication";
-import { createContactInfo } from "./createContactInfo";
-// import { createDeprecationNotice } from "./createDeprecationNotice";
-import { createDescription } from "./createDescription";
-import { createDownload } from "./createDownload";
-import { createEndpoint } from "./createEndpoint";
-import { createLicense } from "./createLicense";
-import { createLogo } from "./createLogo";
-import { createParamsDetails } from "./createParamsDetails";
-// import { createRequestBodyDetails } from "./createRequestBodyDetails";
-import { createRequestSchema } from "./createRequestSchema";
-import { createStatusCodes } from "./createStatusCodes";
-import { createTermsOfService } from "./createTermsOfService";
-// import { createVendorExtensions } from "./createVendorExtensions";
-import { createVersionBadge } from "./createVersionBadge";
-import { greaterThan, lessThan, render } from "./utils";
 
 // interface Props {
 //   title: string;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/createRequestExample.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/createRequestExample.ts
@@ -8,8 +8,8 @@
 import chalk from "chalk";
 import merge from "lodash/merge";
 
-import { mergeAllOf } from "../markdown/createSchema";
 import { SchemaObject } from "./types";
+import { mergeAllOf } from "../markdown/createSchema";
 
 interface OASTypeToTypeMap {
   string: string;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/createResponseExample.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/createResponseExample.ts
@@ -8,8 +8,8 @@
 import chalk from "chalk";
 import merge from "lodash/merge";
 
-import { mergeAllOf } from "../markdown/createSchema";
 import { SchemaObject } from "./types";
+import { mergeAllOf } from "../markdown/createSchema";
 
 interface OASTypeToTypeMap {
   string: string;
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts
@@ -18,6 +18,9 @@ import kebabCase from "lodash/kebabCase";
 import unionBy from "lodash/unionBy";
 import uniq from "lodash/uniq";
 
+import { sampleRequestFromSchema } from "./createRequestExample";
+import { OpenApiObject, TagObject } from "./types";
+import { loadAndResolveSpec } from "./utils/loadAndResolveSpec";
 import { isURL } from "../index";
 import {
   ApiMetadata,
@@ -27,9 +30,6 @@ import {
   SidebarOptions,
   TagPageMetadata,
 } from "../types";
-import { sampleRequestFromSchema } from "./createRequestExample";
-import { OpenApiObject, TagObject } from "./types";
-import { loadAndResolveSpec } from "./utils/loadAndResolveSpec";
 
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/loadAndResolveSpec.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/loadAndResolveSpec.ts
@@ -13,8 +13,8 @@ import chalk from "chalk";
 // @ts-ignore
 import { convertObj } from "swagger2openapi";
 
-import { OpenApiObject } from "../types";
 import { OpenAPIParser } from "./services/OpenAPIParser";
+import { OpenApiObject } from "../types";
 
 function serializer(replacer: any, cycleReplacer: any) {
   var stack: any = [],
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/services/OpenAPIParser.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/services/OpenAPIParser.ts
@@ -7,11 +7,11 @@
 
 // @ts-nocheck
 
+import { RedocNormalizedOptions } from "./RedocNormalizedOptions";
 import { OpenAPIRef, OpenAPISchema, OpenAPISpec, Referenced } from "../types";
 import { isArray, isBoolean } from "../utils/helpers";
 import { JsonPointer } from "../utils/JsonPointer";
 import { getDefinitionName, isNamedDefinition } from "../utils/openapi";
-import { RedocNormalizedOptions } from "./RedocNormalizedOptions";
 
 export type MergedOpenAPISchema = OpenAPISchema & { parentRefs?: string[] };
 
diff --git a/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/utils/openapi.ts b/packages/docusaurus-plugin-openapi-docs/src/openapi/utils/utils/openapi.ts
@@ -9,6 +9,13 @@
 
 import { dirname } from "path";
 
+import {
+  isNumeric,
+  removeQueryString,
+  resolveUrl,
+  isArray,
+  isBoolean,
+} from "./helpers";
 import { OpenAPIParser } from "../services/OpenAPIParser";
 import {
   OpenAPIEncoding,
@@ -21,13 +28,6 @@ import {
   OpenAPIServer,
   Referenced,
 } from "../types";
-import {
-  isNumeric,
-  removeQueryString,
-  resolveUrl,
-  isArray,
-  isBoolean,
-} from "./helpers";
 
 function isWildcardStatusCode(
   statusCode: string | number
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/slice.ts b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Authorization/slice.ts
@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createSlice, PayloadAction } from "@reduxjs/toolkit";
-import { createStorage, hashArray } from "@theme/ApiExplorer/storage-utils";
 import {
   SecurityRequirementObject,
   SecuritySchemeObject,
 } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
-/* eslint-disable import/no-extraneous-dependencies*/
-import { ThemeConfig } from "@mxenabled/docusaurus-theme-openapi-docs/src/types";
+import { createSlice, PayloadAction } from "@reduxjs/toolkit";
+import { createStorage, hashArray } from "@theme/ApiExplorer/storage-utils";
 
 import { getAuthDataKeys } from "./auth-types";
+import { ThemeConfig } from "../../types";
 
 // The global definitions
 // "securitySchemes": {
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx
@@ -7,6 +7,7 @@
 
 import React from "react";
 
+import { RequestBodyObject } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
 import json2xml from "@theme/ApiExplorer/Body/json2xml";
 import FormFileUpload from "@theme/ApiExplorer/FormFileUpload";
 import FormItem from "@theme/ApiExplorer/FormItem";
@@ -17,7 +18,6 @@ import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import Markdown from "@theme/Markdown";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
-import { RequestBodyObject } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
 import format from "xml-formatter";
 
 import {
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/slice.ts b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/ParamOptions/slice.ts
@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { createSlice, PayloadAction } from "@reduxjs/toolkit";
 import { ParameterObject } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
+import { createSlice, PayloadAction } from "@reduxjs/toolkit";
 
 export type Param = ParameterObject & { value?: string[] | string };
 
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Request/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Request/index.tsx
@@ -9,6 +9,8 @@
 import React, { useState } from "react";
 
 import { useDoc } from "@docusaurus/theme-common/internal";
+import { ParameterObject } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
+import { ApiItem } from "@mxenabled/docusaurus-plugin-openapi-docs/src/types";
 import sdk from "@paloaltonetworks/postman-collection";
 import Accept from "@theme/ApiExplorer/Accept";
 import Authorization from "@theme/ApiExplorer/Authorization";
@@ -25,8 +27,6 @@ import {
 } from "@theme/ApiExplorer/Response/slice";
 import Server from "@theme/ApiExplorer/Server";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import { ParameterObject } from "@mxenabled/docusaurus-plugin-openapi-docs/src/openapi/types";
-import { ApiItem } from "@mxenabled/docusaurus-plugin-openapi-docs/src/types";
 import { FormProvider, useForm } from "react-hook-form";
 
 import makeRequest from "./makeRequest";
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Response/index.tsx
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/slice.ts b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Server/slice.ts
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/index.tsx
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/persistanceMiddleware.ts b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/persistanceMiddleware.ts
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiItem/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiItem/index.tsx

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ALGOLIA_API_KEY=xxxxxxxx`
	`2`	`+ALGOLIA_APP_ID=yyyyyyyy`
	`3`	`+ALGOLIA_INDEX_NAME=zzzzzzzz`