From c6637b09e248013f30fccff57a3fa640c9b18243 Mon Sep 17 00:00:00 2001 From: "Nolann B." <100787331+nolannbiron@users.noreply.github.com> Date: Tue, 13 May 2025 22:07:41 +0200 Subject: [PATCH] Use default value if string/number/boolean in generateSchemaExample (#3234) --- .changeset/ten-apples-march.md | 5 +++++ packages/react-openapi/src/generateSchemaExample.ts | 8 ++++++++ 2 files changed, 13 insertions(+) create mode 100644 .changeset/ten-apples-march.md diff --git a/.changeset/ten-apples-march.md b/.changeset/ten-apples-march.md new file mode 100644 index 000000000..dd13b276c --- /dev/null +++ b/.changeset/ten-apples-march.md @@ -0,0 +1,5 @@ +--- +'@gitbook/react-openapi': patch +--- + +Use default value if string number or boolean in generateSchemaExample diff --git a/packages/react-openapi/src/generateSchemaExample.ts b/packages/react-openapi/src/generateSchemaExample.ts index 37695b9fe..5a038db06 100644 --- a/packages/react-openapi/src/generateSchemaExample.ts +++ b/packages/react-openapi/src/generateSchemaExample.ts @@ -204,6 +204,14 @@ const getExampleFromSchema = ( return cache(schema, schema.example); } + // Use a default value, if there’s one and it’s a string or number + if ( + schema.default !== undefined && + ['string', 'number', 'boolean'].includes(typeof schema.default) + ) { + return cache(schema, schema.default); + } + // enum: [ 'available', 'pending', 'sold' ] if (Array.isArray(schema.enum) && schema.enum.length > 0) { return cache(schema, schema.enum[0]);