docusaurus-theme-openapi-docs 4.6.0 → 4.7.0

package/lib/theme/ApiExplorer/SchemaSelection/slice.d.ts

@@ -0,0 +1,37 @@
+import { PayloadAction } from "@reduxjs/toolkit";
+export interface SchemaSelectionState {
+    /**
+     * Maps schema path (e.g., "requestBody", "requestBody.anyOf.0.layer3")
+     * to the selected anyOf/oneOf option index
+     */
+    selections: {
+        [schemaPath: string]: number;
+    };
+}
+export declare const slice: import("@reduxjs/toolkit").Slice<SchemaSelectionState, {
+    /**
+     * Set the selected index for a specific schema path
+     */
+    setSchemaSelection: (state: {
+        selections: {
+            [x: string]: number;
+        };
+    }, action: PayloadAction<{
+        path: string;
+        index: number;
+    }>) => void;
+    /**
+     * Clear all schema selections (useful when navigating to a new API endpoint)
+     */
+    clearSchemaSelections: (state: {
+        selections: {
+            [x: string]: number;
+        };
+    }) => void;
+}, "schemaSelection", "schemaSelection", import("@reduxjs/toolkit").SliceSelectors<SchemaSelectionState>>;
+export declare const setSchemaSelection: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    path: string;
+    index: number;
+}, "schemaSelection/setSchemaSelection">, clearSchemaSelections: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"schemaSelection/clearSchemaSelections">;
+declare const _default: import("redux").Reducer<SchemaSelectionState>;
+export default _default;

package/lib/theme/ApiExplorer/SchemaSelection/slice.js

@@ -0,0 +1,39 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearSchemaSelections =
+  exports.setSchemaSelection =
+  exports.slice =
+    void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const initialState = {
+  selections: {},
+};
+exports.slice = (0, toolkit_1.createSlice)({
+  name: "schemaSelection",
+  initialState,
+  reducers: {
+    /**
+     * Set the selected index for a specific schema path
+     */
+    setSchemaSelection: (state, action) => {
+      state.selections[action.payload.path] = action.payload.index;
+    },
+    /**
+     * Clear all schema selections (useful when navigating to a new API endpoint)
+     */
+    clearSchemaSelections: (state) => {
+      state.selections = {};
+    },
+  },
+});
+((_a = exports.slice.actions),
+  (exports.setSchemaSelection = _a.setSchemaSelection),
+  (exports.clearSchemaSelections = _a.clearSchemaSelections));
+exports.default = exports.slice.reducer;

package/lib/theme/ApiExplorer/persistenceMiddleware.d.ts

@@ -8,6 +8,7 @@ export declare function createPersistenceMiddleware(options: ThemeConfig["api"])
     body: import("./Body/slice").FormBody | import("./Body/slice").RawBody | import("./Body/slice").EmptyBody;
     params: import("./ParamOptions/slice").State;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("./SchemaSelection").SchemaSelectionState;
 }, import("redux-thunk").ThunkDispatch<{
     accept: import("./Accept/slice").State;
     contentType: import("./ContentType/slice").State;
@@ -16,4 +17,5 @@ export declare function createPersistenceMiddleware(options: ThemeConfig["api"])
     body: import("./Body/slice").FormBody | import("./Body/slice").RawBody | import("./Body/slice").EmptyBody;
     params: import("./ParamOptions/slice").State;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("./SchemaSelection").SchemaSelectionState;
 }, undefined, import("redux").UnknownAction> & import("redux").Dispatch<import("redux").UnknownAction>>;

package/lib/theme/ApiItem/hooks.d.ts

@@ -8,5 +8,6 @@ export declare const useTypedDispatch: () => import("redux-thunk").ThunkDispatch
     body: import("../ApiExplorer/Body/slice").FormBody | import("../ApiExplorer/Body/slice").RawBody | import("../ApiExplorer/Body/slice").EmptyBody;
     params: import("../ApiExplorer/ParamOptions/slice").State;
     auth: import("../ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("../ApiExplorer/SchemaSelection").SchemaSelectionState;
 }, undefined, import("redux").UnknownAction> & import("redux").Dispatch<import("redux").UnknownAction>;
 export declare const useTypedSelector: TypedUseSelectorHook<RootState>;

package/lib/theme/ApiItem/index.js

@@ -133,6 +133,7 @@ function ApiItem(props) {
         body: { type: "empty" },
         params,
         auth,
+        schemaSelection: { selections: {} },
       },
       [persistenceMiddleware]
     );

package/lib/theme/ApiItem/store.d.ts

@@ -6,6 +6,7 @@ declare const rootReducer: import("redux").Reducer<{
     body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
     params: import("@theme/ApiExplorer/ParamOptions/slice").State;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState;
 }, import("redux").UnknownAction, Partial<{
     accept: import("@theme/ApiExplorer/Accept/slice").State | undefined;
     contentType: import("@theme/ApiExplorer/ContentType/slice").State | undefined;
@@ -14,6 +15,7 @@ declare const rootReducer: import("redux").Reducer<{
     body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody | undefined;
     params: import("@theme/ApiExplorer/ParamOptions/slice").State | undefined;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState | undefined;
+    schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState | undefined;
 }>>;
 export type RootState = ReturnType<typeof rootReducer>;
 export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit").EnhancedStore<{
@@ -24,6 +26,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
     body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
     params: import("@theme/ApiExplorer/ParamOptions/slice").State;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState;
 }, import("redux").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("redux").StoreEnhancer<{
     dispatch: import("redux-thunk").ThunkDispatch<{
         accept: import("@theme/ApiExplorer/Accept/slice").State;
@@ -33,6 +36,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
         body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
         params: import("@theme/ApiExplorer/ParamOptions/slice").State;
         auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+        schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState;
     }, undefined, import("redux").UnknownAction>;
 }>, import("redux").StoreEnhancer]>>;
 export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit").EnhancedStore<{
@@ -43,6 +47,7 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
     body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
     params: import("@theme/ApiExplorer/ParamOptions/slice").State;
     auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+    schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState;
 }, import("redux").UnknownAction, import("@reduxjs/toolkit").Tuple<[import("redux").StoreEnhancer<{
     dispatch: import("redux-thunk").ThunkDispatch<{
         accept: import("@theme/ApiExplorer/Accept/slice").State;
@@ -52,6 +57,7 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
         body: import("@theme/ApiExplorer/Body/slice").FormBody | import("@theme/ApiExplorer/Body/slice").RawBody | import("@theme/ApiExplorer/Body/slice").EmptyBody;
         params: import("@theme/ApiExplorer/ParamOptions/slice").State;
         auth: import("@theme/ApiExplorer/Authorization/slice").AuthState;
+        schemaSelection: import("@theme/ApiExplorer/SchemaSelection/slice").SchemaSelectionState;
     }, undefined, import("redux").UnknownAction>;
 }>, import("redux").StoreEnhancer]>>;
 export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];

package/lib/theme/ApiItem/store.js

@@ -25,15 +25,19 @@ const slice_5 = __importDefault(
   require("@theme/ApiExplorer/ParamOptions/slice")
 );
 const slice_6 = __importDefault(require("@theme/ApiExplorer/Response/slice"));
-const slice_7 = __importDefault(require("@theme/ApiExplorer/Server/slice"));
+const slice_7 = __importDefault(
+  require("@theme/ApiExplorer/SchemaSelection/slice")
+);
+const slice_8 = __importDefault(require("@theme/ApiExplorer/Server/slice"));
 const rootReducer = (0, toolkit_1.combineReducers)({
   accept: slice_1.default,
   contentType: slice_4.default,
   response: slice_6.default,
-  server: slice_7.default,
+  server: slice_8.default,
   body: slice_3.default,
   params: slice_5.default,
   auth: slice_2.default,
+  schemaSelection: slice_7.default,
 });
 const createStoreWithState = (preloadedState, middlewares) =>
   (0, toolkit_1.configureStore)({

package/lib/theme/RequestSchema/index.js

@@ -34,7 +34,7 @@ const RequestSchemaComponent = ({ title, body, style }) => {
   if (mimeTypes.length > 1) {
     return react_1.default.createElement(
       MimeTabs_1.default,
-      { className: "openapi-tabs__mime", schemaType: "request" },
+      { className: "openapi-tabs__mime", schemaType: "request", lazy: true },
       mimeTypes.map((mimeType) => {
         const firstBody = body.content[mimeType].schema;
         if (
@@ -50,62 +50,67 @@ const RequestSchemaComponent = ({ title, body, style }) => {
             TabItem_1.default,
             { key: mimeType, label: mimeType, value: mimeType },
             react_1.default.createElement(
-              Details_1.default,
-              {
-                className: "openapi-markdown__details mime",
-                "data-collapsed": false,
-                open: true,
-                style: style,
-                summary: react_1.default.createElement(
-                  react_1.default.Fragment,
-                  null,
-                  react_1.default.createElement(
-                    "summary",
+              "div",
+              { style: { marginTop: "1rem" } },
+              react_1.default.createElement(
+                Details_1.default,
+                {
+                  className: "openapi-markdown__details mime",
+                  "data-collapsed": false,
+                  open: true,
+                  style: style,
+                  summary: react_1.default.createElement(
+                    react_1.default.Fragment,
                     null,
                     react_1.default.createElement(
-                      "h3",
-                      {
-                        className:
-                          "openapi-markdown__details-summary-header-body",
-                      },
-                      (0, Translate_1.translate)({
-                        id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
-                        message: title,
-                      }),
-                      body.required === true &&
-                        react_1.default.createElement(
-                          "span",
-                          { className: "openapi-schema__required" },
-                          (0, Translate_1.translate)({
-                            id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
-                            message: "required",
-                          })
-                        )
+                      "summary",
+                      null,
+                      react_1.default.createElement(
+                        "h3",
+                        {
+                          className:
+                            "openapi-markdown__details-summary-header-body",
+                        },
+                        (0, Translate_1.translate)({
+                          id: translationIds_1.OPENAPI_REQUEST.BODY_TITLE,
+                          message: title,
+                        }),
+                        body.required === true &&
+                          react_1.default.createElement(
+                            "span",
+                            { className: "openapi-schema__required" },
+                            (0, Translate_1.translate)({
+                              id: translationIds_1.OPENAPI_SCHEMA_ITEM.REQUIRED,
+                              message: "required",
+                            })
+                          )
+                      )
                     )
-                  )
-                ),
-              },
-              react_1.default.createElement(
-                "div",
-                { style: { textAlign: "left", marginLeft: "1rem" } },
-                body.description &&
-                  react_1.default.createElement(
-                    "div",
-                    { style: { marginTop: "1rem", marginBottom: "1rem" } },
+                  ),
+                },
+                react_1.default.createElement(
+                  "div",
+                  { style: { textAlign: "left", marginLeft: "1rem" } },
+                  body.description &&
                     react_1.default.createElement(
-                      Markdown_1.default,
-                      null,
-                      body.description
+                      "div",
+                      { style: { marginTop: "1rem", marginBottom: "1rem" } },
+                      react_1.default.createElement(
+                        Markdown_1.default,
+                        null,
+                        body.description
+                      )
                     )
-                  )
-              ),
-              react_1.default.createElement(
-                "ul",
-                { style: { marginLeft: "1rem" } },
-                react_1.default.createElement(Schema_1.default, {
-                  schema: firstBody,
-                  schemaType: "request",
-                })
+                ),
+                react_1.default.createElement(
+                  "ul",
+                  { style: { marginLeft: "1rem" } },
+                  react_1.default.createElement(Schema_1.default, {
+                    schema: firstBody,
+                    schemaType: "request",
+                    schemaPath: "requestBody",
+                  })
+                )
               )
             )
           )
@@ -184,6 +189,7 @@ const RequestSchemaComponent = ({ title, body, style }) => {
           react_1.default.createElement(Schema_1.default, {
             schema: firstBody,
             schemaType: "request",
+            schemaPath: "requestBody",
           })
         )
       )

package/lib/theme/Schema/index.d.ts

@@ -3,6 +3,12 @@ import { SchemaObject } from "docusaurus-plugin-openapi-docs/lib/openapi/types";
 interface SchemaProps {
     schema: SchemaObject;
     schemaType: "request" | "response";
+    /**
+     * Optional path identifier for tracking anyOf/oneOf selections.
+     * When provided, tab selections will be dispatched to Redux state
+     * to enable dynamic body example updates.
+     */
+    schemaPath?: string;
 }
 declare const SchemaNode: React.FC<SchemaProps>;
 export default SchemaNode;