Skip to content

feat: add added version to configurations #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avivkeller merged 2 commits into from
Jul 23, 2026
+22 −0
Merged

feat: add added version to configurations #204

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16273c8
feat: add added version to configurations
moshams272 Jul 21, 2026
a768556
feat: add default value ito configuration
moshams272 Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions scripts/markdown/api/configuration.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,24 @@ const isDeprecated = (schema, definitions) =>
schema.deprecated ?? definitions[definitionName(schema.$ref)]?.deprecated
);

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 = [
added ? `**Added in: v${added}**` : '',
isDeprecated(schema, definitions) ? '**Deprecated.**' : '',
description ?? '',
defaultValue !== undefined
? `**Default:** \`${JSON.stringify(defaultValue)}\``
: '',
]
.filter(Boolean)
.join(' ');
Expand All @@ -283,6 +295,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('<!-- YAML', `added: v${added}`, '-->', '');
}

if (isDeprecated(schema, definitions)) {
lines.push('> Stability: 0 - Deprecated', '');
}
Expand All @@ -292,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);

Expand Down
Loading