docusaurus-theme-openapi-docs 1.1.3 → 1.1.4

package/lib/markdown/utils.js

@@ -28,6 +28,10 @@ function create(tag, props) {
 }
 
 function guard(value, cb) {
+  if (typeof value === "boolean") {
+    value = value.toString();
+  }
+
   if (value) {
     const children = cb(value);
     return render(children);

package/lib/theme/ParamsItem/index.js

@@ -37,6 +37,15 @@ function ParamsItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(
+    schema.items ? schema.items.default : schema.default,
+    (value) => (
+      <div>
+        <ReactMarkdown children={`**Default value:** \`${value}\``} />
+      </div>
+    )
+  );
+
   const renderExample = guard(example, (example) => (
     <div>{`Example: ${example}`}</div>
   ));
@@ -58,6 +67,7 @@ function ParamsItem({
       {renderSchemaName}
       {renderSchemaRequired}
       {renderSchema}
+      {renderDefaultValue}
       {renderDescription}
       {renderExample}
       {renderExamples}

package/lib/theme/SchemaItem/index.js

@@ -21,6 +21,7 @@ function SchemaItem({
   required,
   schemaDescription,
   schemaName,
+  defaultValue,
 }) {
   const renderRequired = guard(required, () => (
     <strong className={styles.required}> required</strong>
@@ -38,12 +39,19 @@ function SchemaItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className={styles.schemaQualifierMessage}>
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
+
   const schemaContent = (
     <div>
       <strong>{name}</strong>
       <span className={styles.schemaName}> {schemaName}</span>
       {renderRequired}
       {renderQualifierMessage}
+      {renderDefaultValue}
       {renderSchemaDescription}
     </div>
   );

package/lib-next/markdown/utils.js

@@ -15,6 +15,10 @@ export function create(tag, props) {
   return `<${tag}${propString}>${render(children)}</${tag}>`;
 }
 export function guard(value, cb) {
+  if (typeof value === "boolean") {
+    value = value.toString();
+  }
+
   if (value) {
     const children = cb(value);
     return render(children);

package/lib-next/theme/ParamsItem/index.js

@@ -37,6 +37,15 @@ function ParamsItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(
+    schema.items ? schema.items.default : schema.default,
+    (value) => (
+      <div>
+        <ReactMarkdown children={`**Default value:** \`${value}\``} />
+      </div>
+    )
+  );
+
   const renderExample = guard(example, (example) => (
     <div>{`Example: ${example}`}</div>
   ));
@@ -58,6 +67,7 @@ function ParamsItem({
       {renderSchemaName}
       {renderSchemaRequired}
       {renderSchema}
+      {renderDefaultValue}
       {renderDescription}
       {renderExample}
       {renderExamples}

package/lib-next/theme/SchemaItem/index.js

@@ -21,6 +21,7 @@ function SchemaItem({
   required,
   schemaDescription,
   schemaName,
+  defaultValue,
 }) {
   const renderRequired = guard(required, () => (
     <strong className={styles.required}> required</strong>
@@ -38,12 +39,19 @@ function SchemaItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className={styles.schemaQualifierMessage}>
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
+
   const schemaContent = (
     <div>
       <strong>{name}</strong>
       <span className={styles.schemaName}> {schemaName}</span>
       {renderRequired}
       {renderQualifierMessage}
+      {renderDefaultValue}
       {renderSchemaDescription}
     </div>
   );

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -50,7 +50,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^1.1.3",
+    "docusaurus-plugin-openapi-docs": "^1.1.4",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "process": "^0.11.10",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "4897267289b035aed8155f6001e14c80ba9003a8"
+  "gitHead": "dadb0aa5d3516b3020ff1d94288efd6f136e02ba"
 }

package/src/markdown/utils.ts

@@ -21,11 +21,14 @@ export function create(tag: string, props: Props): string {
 }
 
 export function guard<T>(
-  value: T | undefined,
+  value: T | undefined | string,
   cb: (value: T) => Children
 ): string {
+  if (typeof value === "boolean") {
+    value = value.toString();
+  }
   if (value) {
-    const children = cb(value);
+    const children = cb(value as T);
     return render(children);
   }
   return "";

package/src/theme/ParamsItem/index.js

@@ -37,6 +37,15 @@ function ParamsItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(
+    schema.items ? schema.items.default : schema.default,
+    (value) => (
+      <div>
+        <ReactMarkdown children={`**Default value:** \`${value}\``} />
+      </div>
+    )
+  );
+
   const renderExample = guard(example, (example) => (
     <div>{`Example: ${example}`}</div>
   ));
@@ -58,6 +67,7 @@ function ParamsItem({
       {renderSchemaName}
       {renderSchemaRequired}
       {renderSchema}
+      {renderDefaultValue}
       {renderDescription}
       {renderExample}
       {renderExamples}

package/src/theme/SchemaItem/index.js

@@ -21,6 +21,7 @@ function SchemaItem({
   required,
   schemaDescription,
   schemaName,
+  defaultValue,
 }) {
   const renderRequired = guard(required, () => (
     <strong className={styles.required}> required</strong>
@@ -38,12 +39,19 @@ function SchemaItem({
     </div>
   ));
 
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className={styles.schemaQualifierMessage}>
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
+
   const schemaContent = (
     <div>
       <strong>{name}</strong>
       <span className={styles.schemaName}> {schemaName}</span>
       {renderRequired}
       {renderQualifierMessage}
+      {renderDefaultValue}
       {renderSchemaDescription}
     </div>
   );