docusaurus-theme-openapi-docs 4.7.1 → 5.0.0

package/src/theme/ApiExplorer/MethodEndpoint/index.tsx

@@ -8,6 +8,7 @@
 import React from "react";
 
 import BrowserOnly from "@docusaurus/BrowserOnly";
+import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { useTypedSelector } from "@theme/ApiItem/hooks";
 
 function colorForMethod(method: string) {
@@ -38,6 +39,26 @@ export interface Props {
 }
 
 function MethodEndpoint({ method, path, context }: Props) {
+  // During SSR, render without Redux store access to avoid "Cannot read properties
+  // of null (reading 'store')" errors caused by useSelector running outside a Provider.
+  if (!ExecutionEnvironment.canUseDOM) {
+    return (
+      <>
+        <pre className="openapi__method-endpoint">
+          <span className={"badge badge--" + colorForMethod(method)}>
+            {method === "event" ? "Webhook" : method.toUpperCase()}
+          </span>{" "}
+          {method !== "event" && (
+            <h2 className="openapi__method-endpoint-path">
+              {`${path.replace(/{([a-z0-9-_]+)}/gi, ":$1")}`}
+            </h2>
+          )}
+        </pre>
+        <div className="openapi__divider" />
+      </>
+    );
+  }
+
   let serverValue = useTypedSelector((state: any) => state.server.value);
   let serverUrlWithVariables = "";
 

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx

@@ -10,6 +10,7 @@ import React, { useEffect, useState } from "react";
 import { translate } from "@docusaurus/Translate";
 import { ErrorMessage } from "@hookform/error-message";
 import { nanoid } from "@reduxjs/toolkit";
+import FormLabel from "@theme/ApiExplorer/FormLabel";
 import FormSelect from "@theme/ApiExplorer/FormSelect";
 import FormTextInput from "@theme/ApiExplorer/FormTextInput";
 import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
@@ -19,6 +20,9 @@ import { Controller, useFormContext } from "react-hook-form";
 
 export interface ParamProps {
   param: Param;
+  label?: string;
+  type?: string;
+  required?: boolean;
 }
 
 function ArrayItem({
@@ -31,6 +35,7 @@ function ArrayItem({
   if (param.schema?.items?.type === "boolean") {
     return (
       <FormSelect
+        ariaLabel={param.description || param.name}
         options={["---", "true", "false"]}
         onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
           const val = e.target.value;
@@ -52,7 +57,12 @@ function ArrayItem({
   );
 }
 
-export default function ParamArrayFormItem({ param }: ParamProps) {
+export default function ParamArrayFormItem({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps) {
   const [items, setItems] = useState<{ id: string; value?: string }[]>([]);
   const dispatch = useTypedDispatch();
 
@@ -122,6 +132,7 @@ export default function ParamArrayFormItem({ param }: ParamProps) {
 
   return (
     <>
+      {label && <FormLabel label={label} type={type} required={required} />}
       <Controller
         control={control}
         rules={{
@@ -145,6 +156,7 @@ export default function ParamArrayFormItem({ param }: ParamProps) {
                 <button
                   className="openapi-explorer__delete-btn"
                   onClick={handleDeleteItem(item)}
+                  aria-label="Delete"
                 >
                   <svg
                     focusable="false"
@@ -157,7 +169,6 @@ export default function ParamArrayFormItem({ param }: ParamProps) {
                     aria-hidden="true"
                   >
                     <path d="M24 9.4L22.6 8 16 14.6 9.4 8 8 9.4 14.6 16 8 22.6 9.4 24 16 17.4 22.6 24 24 22.6 17.4 16 24 9.4z"></path>
-                    <title>Delete</title>
                   </svg>
                 </button>
               </div>

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx

@@ -17,9 +17,17 @@ import { Controller, useFormContext } from "react-hook-form";
 
 export interface ParamProps {
   param: Param;
+  label?: string;
+  type?: string;
+  required?: boolean;
 }
 
-export default function ParamBooleanFormItem({ param }: ParamProps) {
+export default function ParamBooleanFormItem({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps) {
   const dispatch = useTypedDispatch();
 
   const {
@@ -44,6 +52,9 @@ export default function ParamBooleanFormItem({ param }: ParamProps) {
         name="paramBoolean"
         render={({ field: { onChange } }) => (
           <FormSelect
+            label={label}
+            type={type}
+            required={required}
             options={["---", "true", "false"]}
             onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
               const val = e.target.value;

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx

@@ -10,6 +10,7 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import { ErrorMessage } from "@hookform/error-message";
 import FormMultiSelect from "@theme/ApiExplorer/FormMultiSelect";
+import { getSchemaEnum } from "@theme/ApiExplorer/ParamOptions";
 import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import { OPENAPI_FORM } from "@theme/translationIds";
@@ -17,9 +18,17 @@ import { Controller, useFormContext } from "react-hook-form";
 
 export interface ParamProps {
   param: Param;
+  label?: string;
+  type?: string;
+  required?: boolean;
 }
 
-export default function ParamMultiSelectFormItem({ param }: ParamProps) {
+export default function ParamMultiSelectFormItem({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps) {
   const {
     control,
     formState: { errors },
@@ -29,7 +38,7 @@ export default function ParamMultiSelectFormItem({ param }: ParamProps) {
 
   const dispatch = useTypedDispatch();
 
-  const options = param.schema?.items?.enum ?? [];
+  const options = getSchemaEnum(param.schema?.items) ?? [];
 
   const pathParams = useTypedSelector((state: any) => state.params.path);
   const queryParams = useTypedSelector((state: any) => state.params.query);
@@ -74,6 +83,9 @@ export default function ParamMultiSelectFormItem({ param }: ParamProps) {
         name="paramMultiSelect"
         render={({ field: { onChange } }) => (
           <FormMultiSelect
+            label={label}
+            type={type}
+            required={required}
             options={options as string[]}
             onChange={(e: any) => handleChange(e, onChange)}
             showErrors={!!showErrorMessage}

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx

@@ -10,6 +10,7 @@ import React from "react";
 import { translate } from "@docusaurus/Translate";
 import { ErrorMessage } from "@hookform/error-message";
 import FormSelect from "@theme/ApiExplorer/FormSelect";
+import { getSchemaEnum } from "@theme/ApiExplorer/ParamOptions";
 import { Param, setParam } from "@theme/ApiExplorer/ParamOptions/slice";
 import { useTypedDispatch } from "@theme/ApiItem/hooks";
 import { OPENAPI_FORM } from "@theme/translationIds";
@@ -17,9 +18,17 @@ import { Controller, useFormContext } from "react-hook-form";
 
 export interface ParamProps {
   param: Param;
+  label?: string;
+  type?: string;
+  required?: boolean;
 }
 
-export default function ParamSelectFormItem({ param }: ParamProps) {
+export default function ParamSelectFormItem({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps) {
   const {
     control,
     formState: { errors },
@@ -29,7 +38,7 @@ export default function ParamSelectFormItem({ param }: ParamProps) {
 
   const dispatch = useTypedDispatch();
 
-  const options = param.schema?.enum ?? [];
+  const options = getSchemaEnum(param.schema) ?? [];
 
   return (
     <>
@@ -46,6 +55,9 @@ export default function ParamSelectFormItem({ param }: ParamProps) {
         name="paramSelect"
         render={({ field: { onChange } }) => (
           <FormSelect
+            label={label}
+            type={type}
+            required={required}
             options={["---", ...(options as string[])]}
             onChange={(e: React.ChangeEvent<HTMLSelectElement>) => {
               const val = e.target.value;

package/src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx

@@ -13,12 +13,23 @@ import { useTypedDispatch } from "@theme/ApiItem/hooks";
 
 export interface ParamProps {
   param: Param;
+  label?: string;
+  type?: string;
+  required?: boolean;
 }
 
-export default function ParamTextFormItem({ param }: ParamProps) {
+export default function ParamTextFormItem({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps) {
   const dispatch = useTypedDispatch();
   return (
     <FormTextInput
+      label={label}
+      type={type}
+      required={required}
       isRequired={param.required}
       paramName={param.name}
       placeholder={param.description || param.name}
@@ -27,9 +38,11 @@ export default function ParamTextFormItem({ param }: ParamProps) {
           setParam({
             ...param,
             value:
-              param.in === "path" || param.in === "query"
+              param.in === "path"
                 ? e.target.value.replace(/\s/g, "%20")
-                : e.target.value,
+                : param.in === "query"
+                  ? encodeURIComponent(e.target.value)
+                  : e.target.value,
           })
         )
       }

package/src/theme/ApiExplorer/ParamOptions/_ParamOptions.scss

@@ -63,15 +63,10 @@
   margin-top: calc(var(--ifm-pre-padding) / 2);
   background-color: var(--openapi-input-background);
   border: none;
-  outline: none;
   color: var(--ifm-pre-color);
   border-radius: 4px;
   margin-left: 4px;
 
-  &:focus {
-    outline: 0;
-  }
-
   &:active {
     box-shadow: inset 0px 0px 0px 2px var(--openapi-input-border);
   }
@@ -102,10 +97,6 @@
     background-color: var(--openapi-input-border);
   }
 
-  &:focus {
-    outline: 0;
-  }
-
   &:active {
     box-shadow:
       inset 0 0 0 1px var(--openapi-input-border),

package/src/theme/ApiExplorer/ParamOptions/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { useState } from "react";
+import React, { useState, useId } from "react";
 
 import { translate } from "@docusaurus/Translate";
 import FormItem from "@theme/ApiExplorer/FormItem";
@@ -19,36 +19,117 @@ import { OPENAPI_PARAM_OPTIONS } from "@theme/translationIds";
 
 import { Param } from "./slice";
 
+export interface LabelProps {
+  label?: string;
+  type?: string;
+  required?: boolean;
+}
+
 export interface ParamProps {
   param: Param;
 }
 
-function ParamOption({ param }: ParamProps) {
-  if (param.schema?.type === "array" && param.schema.items?.enum) {
-    return <ParamMultiSelectFormItem param={param} />;
+/**
+ * Extracts enum values from a schema, including when wrapped in allOf.
+ * This handles cases where an enum is referenced via allOf for composition.
+ */
+export function getSchemaEnum(schema: any): any[] | undefined {
+  // Direct enum on schema
+  if (schema?.enum) {
+    return schema.enum;
+  }
+
+  // Enum inside allOf - check each item
+  if (schema?.allOf && Array.isArray(schema.allOf)) {
+    for (const item of schema.allOf) {
+      if (item.enum) {
+        return item.enum;
+      }
+    }
+  }
+
+  // const is semantically a single-value enum
+  if (schema?.const !== undefined) {
+    return [schema.const];
+  }
+
+  return undefined;
+}
+
+function ParamOption({
+  param,
+  label,
+  type,
+  required,
+}: ParamProps & LabelProps) {
+  const schemaEnum = getSchemaEnum(param.schema);
+  const itemsEnum = getSchemaEnum(param.schema?.items);
+
+  if (param.schema?.type === "array" && itemsEnum) {
+    return (
+      <ParamMultiSelectFormItem
+        param={param}
+        label={label}
+        type={type}
+        required={required}
+      />
+    );
   }
 
   if (param.schema?.type === "array") {
-    return <ParamArrayFormItem param={param} />;
+    return (
+      <ParamArrayFormItem
+        param={param}
+        label={label}
+        type={type}
+        required={required}
+      />
+    );
   }
 
-  if (param.schema?.enum) {
-    return <ParamSelectFormItem param={param} />;
+  if (schemaEnum) {
+    return (
+      <ParamSelectFormItem
+        param={param}
+        label={label}
+        type={type}
+        required={required}
+      />
+    );
   }
 
   if (param.schema?.type === "boolean") {
-    return <ParamBooleanFormItem param={param} />;
+    return (
+      <ParamBooleanFormItem
+        param={param}
+        label={label}
+        type={type}
+        required={required}
+      />
+    );
   }
 
   // integer, number, string, int32, int64, float, double, object, byte, binary,
   // date-time, date, password
-  return <ParamTextFormItem param={param} />;
+  return (
+    <ParamTextFormItem
+      param={param}
+      label={label}
+      type={type}
+      required={required}
+    />
+  );
 }
 
 function ParamOptionWrapper({ param }: ParamProps) {
   return (
-    <FormItem label={param.name} type={param.in} required={param.required}>
-      <ParamOption param={param} />
+    <FormItem>
+      <ParamOption
+        param={param}
+        label={param.name}
+        type={param.in}
+        required={param.required}
+      />
     </FormItem>
   );
 }
@@ -56,6 +137,8 @@ function ParamOptionWrapper({ param }: ParamProps) {
 function ParamOptions() {
   const [showOptional, setShowOptional] = useState(false);
 
+  const optionalId = useId();
+
   const pathParams = useTypedSelector((state: any) => state.params.path);
   const queryParams = useTypedSelector((state: any) => state.params.query);
   const cookieParams = useTypedSelector((state: any) => state.params.cookie);
@@ -84,6 +167,8 @@ function ParamOptions() {
           <button
             type="button"
             className="openapi-explorer__show-more-btn"
+            aria-expanded={showOptional}
+            aria-controls={optionalId}
             onClick={() => setShowOptional((prev) => !prev)}
           >
             <span
@@ -137,6 +222,7 @@ function ParamOptions() {
                 ? "openapi-explorer__show-options"
                 : "openapi-explorer__hide-options"
             }
+            id={optionalId}
           >
             {optionalParams.map((param) => (
               <ParamOptionWrapper

package/src/theme/ApiExplorer/Request/_Request.scss

@@ -48,6 +48,17 @@
 }
 
 .openapi-explorer__expand-details-btn {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  appearance: none;
+  padding: 0;
+  cursor: pointer;
+  border: 0px solid transparent;
+  background-color: transparent;
+  text-transform: inherit;
+  font-weight: inherit;
+  font-size: inherit;
+
   &:hover {
     cursor: pointer;
   }

package/src/theme/ApiExplorer/Request/index.tsx

@@ -6,7 +6,7 @@
  * ========================================================================== */
 
 // @ts-nocheck
-import React, { useState } from "react";
+import React, { useState, useId } from "react";
 
 import { useDoc } from "@docusaurus/plugin-content-docs/client";
 import { translate } from "@docusaurus/Translate";
@@ -25,6 +25,7 @@ import {
   clearHeaders,
 } from "@theme/ApiExplorer/Response/slice";
 import Server from "@theme/ApiExplorer/Server";
+import { useResolvedEncoding } from "@theme/ApiExplorer/EncodingSelection/useResolvedEncoding";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import { OPENAPI_REQUEST } from "@theme/translationIds";
 import type { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
@@ -43,6 +44,7 @@ function Request({ item }: { item: ApiItem }) {
   const { siteConfig } = useDocusaurusContext();
   const themeConfig = siteConfig.themeConfig as ThemeConfig;
   const requestTimeout = themeConfig.api?.requestTimeout;
+  const requestCredentials = themeConfig.api?.requestCredentials;
   // Frontmatter proxy (per-spec) takes precedence over theme config proxy (site-wide)
   const proxy = frontMatterProxy ?? themeConfig.api?.proxy;
 
@@ -66,6 +68,8 @@ function Request({ item }: { item: ApiItem }) {
   const [expandParams, setExpandParams] = useState(true);
   const [expandServer, setExpandServer] = useState(true);
 
+  const serverLabelId = useId();
+
   const allParams = [
     ...pathParams,
     ...queryParams,
@@ -73,6 +77,8 @@ function Request({ item }: { item: ApiItem }) {
     ...headerParams,
   ];
 
+  const encoding = useResolvedEncoding(item.requestBody);
+
   const postmanRequest = buildPostmanRequest(postman, {
     queryParams,
     pathParams,
@@ -83,6 +89,7 @@ function Request({ item }: { item: ApiItem }) {
     body,
     server,
     auth,
+    encoding,
   });
 
   const delay = (ms: number) =>
@@ -99,7 +106,7 @@ function Request({ item }: { item: ApiItem }) {
     (param: { in: "path" | "query" | "header" | "cookie" }) => {
       const paramType = param.in;
       const paramsArray: ParameterObject[] = paramsObject[paramType];
-      paramsArray.push(param as ParameterObject);
+      paramsArray?.push(param as ParameterObject);
     }
   );
 
@@ -171,7 +178,9 @@ function Request({ item }: { item: ApiItem }) {
         postmanRequest,
         proxy,
         body,
-        requestTimeout
+        requestTimeout,
+        requestCredentials,
+        encoding
       );
       if (res.headers.get("content-type")?.includes("text/event-stream")) {
         await handleEventStream(res);
@@ -249,7 +258,8 @@ function Request({ item }: { item: ApiItem }) {
             })}
           </span>
           {allDetailsExpanded ? (
-            <span
+            <button
+              type="button"
               className="openapi-explorer__expand-details-btn"
               onClick={collapseAllDetails}
             >
@@ -257,9 +267,10 @@ function Request({ item }: { item: ApiItem }) {
                 id: OPENAPI_REQUEST.COLLAPSE_ALL,
                 message: "Collapse all",
               })}
-            </span>
+            </button>
           ) : (
-            <span
+            <button
+              type="button"
               className="openapi-explorer__expand-details-btn"
               onClick={expandAllDetails}
             >
@@ -267,7 +278,7 @@ function Request({ item }: { item: ApiItem }) {
                 id: OPENAPI_REQUEST.EXPAND_ALL,
                 message: "Expand all",
               })}
-            </span>
+            </button>
           )}
         </div>
         <div className="openapi-explorer__details-outer-container">
@@ -277,6 +288,7 @@ function Request({ item }: { item: ApiItem }) {
               className="openapi-explorer__details-container"
             >
               <summary
+                id={serverLabelId}
                 className="openapi-explorer__details-summary"
                 onClick={(e) => {
                   e.preventDefault();
@@ -288,7 +300,7 @@ function Request({ item }: { item: ApiItem }) {
                   message: "Base URL",
                 })}
               </summary>
-              <Server />
+              <Server labelId={serverLabelId} />
             </details>
           )}
           {showAuth && (

package/src/theme/ApiExplorer/Request/makeRequest.ts

@@ -114,7 +114,9 @@ async function makeRequest(
   request: sdk.Request,
   proxy: string | undefined,
   _body: Body,
-  timeout: number = DEFAULT_REQUEST_TIMEOUT
+  timeout: number = DEFAULT_REQUEST_TIMEOUT,
+  credentials?: RequestCredentials,
+  encoding?: Record<string, { contentType?: string }>
 ) {
   const headers = request.toJSON().header;
 
@@ -226,12 +228,25 @@ async function makeRequest(
         const members = (request.body as any)?.formdata?.members;
         if (Array.isArray(members)) {
           for (const data of members) {
+            const partContentType = encoding?.[data.key]?.contentType
+              ?.split(",")[0]
+              .trim();
             if (data.key && data.value.content) {
-              myBody.append(data.key, data.value.content);
+              const blob = partContentType
+                ? new Blob([data.value.content], { type: partContentType })
+                : data.value.content;
+              myBody.append(data.key, blob);
             }
             // handle generic key-value payload
             if (data.key && typeof data.value === "string") {
-              myBody.append(data.key, data.value);
+              if (partContentType) {
+                myBody.append(
+                  data.key,
+                  new Blob([data.value], { type: partContentType })
+                );
+              } else {
+                myBody.append(data.key, data.value);
+              }
             }
           }
         }
@@ -252,6 +267,7 @@ async function makeRequest(
     method: request.method,
     headers: myHeaders,
     body: myBody,
+    ...(credentials && { credentials }),
   };
 
   let finalUrl = request.url.toString();

package/src/theme/ApiExplorer/Response/_Response.scss

@@ -43,6 +43,17 @@
 }
 
 .openapi-explorer__response-clear-btn {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  appearance: none;
+  padding: 0;
+  cursor: pointer;
+  border: 0px solid transparent;
+  background-color: transparent;
+  text-transform: inherit;
+  font-weight: inherit;
+  font-size: inherit;
+
   &:hover {
     cursor: pointer;
   }