docusaurus-theme-openapi-docs 4.7.0 → 5.0.0

package/lib/theme/ApiExplorer/Body/index.js

@@ -80,11 +80,11 @@ const Markdown_1 = __importDefault(require("@theme/Markdown"));
 const SchemaTabs_1 = __importDefault(require("@theme/SchemaTabs"));
 const TabItem_1 = __importDefault(require("@theme/TabItem"));
 const translationIds_1 = require("@theme/translationIds");
-const createSchemaExample_1 = require("docusaurus-plugin-openapi-docs/src/openapi/createSchemaExample");
+const createSchemaExample_1 = require("docusaurus-plugin-openapi-docs/lib/openapi/createSchemaExample");
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
-const slice_1 = require("./slice");
 const FormBodyItem_1 = __importDefault(require("./FormBodyItem"));
 const resolveSchemaWithSelections_1 = require("./resolveSchemaWithSelections");
+const slice_1 = require("./slice");
 function BodyWrap({
   requestBodyMetadata,
   jsonRequestBodyExample,
@@ -140,6 +140,7 @@ function Body({
   const rawSchema = requestBodyMetadata?.content?.[contentType]?.schema;
   const example = requestBodyMetadata?.content?.[contentType]?.example;
   const examples = requestBodyMetadata?.content?.[contentType]?.examples;
+  const encoding = requestBodyMetadata?.content?.[contentType]?.encoding;
   // Resolve the schema based on user's anyOf/oneOf tab selections
   const schema = (0, react_1.useMemo)(() => {
     if (!rawSchema) return rawSchema;
@@ -365,22 +366,92 @@ function Body({
     return react_1.default.createElement(
       FormItem_1.default,
       { className: "openapi-explorer__form-item-body-container" },
-      Object.entries(schema.properties ?? {}).map(([key, val]) => {
-        return react_1.default.createElement(
-          FormItem_1.default,
+      react_1.default.createElement(
+        SchemaTabs_1.default,
+        { className: "openapi-tabs__schema", lazy: true },
+        react_1.default.createElement(
+          TabItem_1.default,
           {
-            key: key,
-            label: key,
-            required:
-              Array.isArray(schema.required) && schema.required.includes(key),
+            label: (0, Translate_1.translate)({
+              id: translationIds_1.OPENAPI_BODY.EXAMPLE_FROM_SCHEMA,
+              message: "Example (from schema)",
+            }),
+            value: "Example (from schema)",
+            default: true,
           },
-          react_1.default.createElement(FormBodyItem_1.default, {
-            schemaObject: val,
-            id: key,
-            schema: schema,
+          Object.entries(schema.properties ?? {}).map(([key, val]) => {
+            return react_1.default.createElement(
+              FormItem_1.default,
+              { key: key },
+              react_1.default.createElement(FormBodyItem_1.default, {
+                schemaObject: val,
+                id: key,
+                schema: schema,
+                exampleValue: val.example,
+                label: key,
+                required:
+                  Array.isArray(schema.required) &&
+                  schema.required.includes(key),
+                fieldEncoding: encoding?.[key]?.contentType,
+              })
+            );
           })
-        );
-      })
+        ),
+        example &&
+          // @ts-ignore
+          react_1.default.createElement(
+            TabItem_1.default,
+            { label: "Example", value: "example" },
+            Object.entries(schema.properties ?? {}).map(
+              ([schemaKey, schemaVal]) => {
+                return react_1.default.createElement(
+                  FormItem_1.default,
+                  { key: schemaKey },
+                  react_1.default.createElement(FormBodyItem_1.default, {
+                    schemaObject: schemaVal,
+                    id: schemaKey,
+                    schema: schema,
+                    exampleValue: example[schemaKey],
+                    label: schemaKey,
+                    required:
+                      Array.isArray(schema.required) &&
+                      schema.required.includes(schemaKey),
+                    fieldEncoding: encoding?.[schemaKey]?.contentType,
+                  })
+                );
+              }
+            )
+          ),
+        examples &&
+          Object.entries(examples).map(([key, value]) => {
+            return (
+              // @ts-ignore
+              react_1.default.createElement(
+                TabItem_1.default,
+                { label: key, value: key, key: key },
+                Object.entries(schema.properties ?? {}).map(
+                  ([schemaKey, schemaVal]) => {
+                    return react_1.default.createElement(
+                      FormItem_1.default,
+                      { key: schemaKey },
+                      react_1.default.createElement(FormBodyItem_1.default, {
+                        schemaObject: schemaVal,
+                        id: schemaKey,
+                        schema: schema,
+                        exampleValue: value.value?.[schemaKey],
+                        label: schemaKey,
+                        required:
+                          Array.isArray(schema.required) &&
+                          schema.required.includes(schemaKey),
+                        fieldEncoding: encoding?.[schemaKey]?.contentType,
+                      })
+                    );
+                  }
+                )
+              )
+            );
+          })
+      )
     );
   }
   if (exampleBody) {

package/lib/theme/ApiExplorer/Body/resolveSchemaWithSelections.d.ts

@@ -1,4 +1,4 @@
-import { SchemaObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
+import type { SchemaObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
 export interface SchemaSelections {
     [schemaPath: string]: number;
 }