From 16273c8cabd1ec15cca6725f364c60f6d7937ea3 Mon Sep 17 00:00:00 2001 From: Mohamed Shams El-Deen Date: Wed, 22 Jul 2026 02:52:21 +0300 Subject: [PATCH 1/2] feat: add added version to configurations --- scripts/markdown/api/configuration.mjs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/scripts/markdown/api/configuration.mjs b/scripts/markdown/api/configuration.mjs index fa50c6d4..5b33612d 100644 --- a/scripts/markdown/api/configuration.mjs +++ b/scripts/markdown/api/configuration.mjs @@ -268,10 +268,16 @@ const isDeprecated = (schema, definitions) => schema.deprecated ?? definitions[definitionName(schema.$ref)]?.deprecated ); +const addedInVersion = (schema, definitions) => + schema.added ?? definitions[definitionName(schema.$ref)]?.added; + const propertyBullet = (name, schema, definitions) => { const description = descriptionOf(schema, definitions); const type = summarize(schema, definitions); const notes = [ + addedInVersion(schema, definitions) + ? `**Added in: v${addedInVersion(schema, definitions)}**` + : '', isDeprecated(schema, definitions) ? '**Deprecated.**' : '', description ?? '', ] @@ -283,6 +289,11 @@ const propertyBullet = (name, schema, definitions) => { const renderOption = (path, schema, definitions, depth, exampleExtras = []) => { const lines = [`${'#'.repeat(depth + 2)} \`${formatPath(path)}\``, '']; + const added = addedInVersion(schema, definitions); + if (added) { + lines.push('', ''); + } + if (isDeprecated(schema, definitions)) { lines.push('> Stability: 0 - Deprecated', ''); } From a768556f5093f493cac2639aca3669c9e55f437d Mon Sep 17 00:00:00 2001 From: Mohamed Shams El-Deen Date: Wed, 22 Jul 2026 03:19:14 +0300 Subject: [PATCH 2/2] feat: add default value ito configuration --- scripts/markdown/api/configuration.mjs | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/scripts/markdown/api/configuration.mjs b/scripts/markdown/api/configuration.mjs index 5b33612d..5f40b54e 100644 --- a/scripts/markdown/api/configuration.mjs +++ b/scripts/markdown/api/configuration.mjs @@ -271,15 +271,21 @@ const isDeprecated = (schema, definitions) => const addedInVersion = (schema, definitions) => schema.added ?? definitions[definitionName(schema.$ref)]?.added; +const defaultOf = (schema, definitions) => + schema.default ?? definitions[definitionName(schema.$ref)]?.default; + const propertyBullet = (name, schema, definitions) => { const description = descriptionOf(schema, definitions); const type = summarize(schema, definitions); + const added = addedInVersion(schema, definitions); + const defaultValue = defaultOf(schema, definitions); const notes = [ - addedInVersion(schema, definitions) - ? `**Added in: v${addedInVersion(schema, definitions)}**` - : '', + added ? `**Added in: v${added}**` : '', isDeprecated(schema, definitions) ? '**Deprecated.**' : '', description ?? '', + defaultValue !== undefined + ? `**Default:** \`${JSON.stringify(defaultValue)}\`` + : '', ] .filter(Boolean) .join(' '); @@ -303,6 +309,11 @@ const renderOption = (path, schema, definitions, depth, exampleExtras = []) => { lines.push(`* Type: {${summarize(schema, definitions)}}`); + const defaultValue = defaultOf(schema, definitions); + if (defaultValue !== undefined) { + lines.push(`* Default: \`${JSON.stringify(defaultValue)}\``); + } + const shapes = expandableObjects(schema, definitions); const discriminator = discriminatorOf(shapes);