docusaurus-theme-openapi-docs 0.0.0-1267 → 0.0.0-1293

package/lib/theme/ApiItem/index.js

@@ -101,9 +101,21 @@ function ApiItem(props) {
     api?.parameters?.forEach((param) => {
       const paramType = param.in;
       const paramsArray = params[paramType];
-      const defaultValue = param.schema?.default;
+      const p = param;
+      // Prefill order: schema.default, then example sources. `default` is
+      // semantically a server-side fallback, so for required params authors
+      // typically rely on `example` / `examples`. See #544 and #1079.
+      const firstNamedExample =
+        p.examples && typeof p.examples === "object"
+          ? Object.values(p.examples)[0]?.value
+          : undefined;
+      const prefill =
+        p.schema?.default ??
+        p.example ??
+        p.schema?.example ??
+        firstNamedExample;
       const initialized =
-        defaultValue !== undefined ? { ...param, value: defaultValue } : param;
+        prefill !== undefined ? { ...param, value: prefill } : param;
       paramsArray?.push(initialized);
     });
     const auth = (0, slice_1.createAuth)({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-1267",
+  "version": "0.0.0-1293",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -38,7 +38,7 @@
     "@types/postman-collection": "^3.5.11",
     "@types/react-modal": "^3.16.3",
     "concurrently": "^9.2.0",
-    "docusaurus-plugin-openapi-docs": "0.0.0-1267",
+    "docusaurus-plugin-openapi-docs": "0.0.0-1293",
     "docusaurus-plugin-sass": "^0.2.6",
     "eslint-plugin-prettier": "^5.5.1"
   },
@@ -82,5 +82,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "fae66624a389286ba5ccf067ff73ac435307cbb9"
+  "gitHead": "b0f99481fef92f91530e08164d5a98e3b4ddb65d"
 }

package/src/theme/ApiItem/index.tsx

@@ -123,10 +123,22 @@ export default function ApiItem(props: Props): JSX.Element {
       (param: { in: "path" | "query" | "header" | "cookie" }) => {
         const paramType = param.in;
         const paramsArray: ParameterObject[] = params[paramType];
-        const defaultValue = (param as any).schema?.default;
+        const p = param as any;
+        // Prefill order: schema.default, then example sources. `default` is
+        // semantically a server-side fallback, so for required params authors
+        // typically rely on `example` / `examples`. See #544 and #1079.
+        const firstNamedExample =
+          p.examples && typeof p.examples === "object"
+            ? (Object.values(p.examples)[0] as any)?.value
+            : undefined;
+        const prefill =
+          p.schema?.default ??
+          p.example ??
+          p.schema?.example ??
+          firstNamedExample;
         const initialized =
-          defaultValue !== undefined
-            ? ({ ...param, value: defaultValue } as unknown as ParameterObject)
+          prefill !== undefined
+            ? ({ ...param, value: prefill } as unknown as ParameterObject)
             : (param as ParameterObject);
         paramsArray?.push(initialized);
       }