Skip to content

fix: handled example section for masked schemas #2871

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

Open
SB-venkatyadavilli wants to merge 2 commits into
base: main
Choose a base branch
from
+51 −9
Open

fix: handled example section for masked schemas #2871

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83cdcdf
fix: handled example section for masked schemas
SB-venkatyadavilli Feb 10, 2026
e517b54
fix: optimise the code of generateExamples function
SB-venkatyadavilli Feb 16, 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
60 changes: 51 additions & 9 deletions packages/elements-core/src/utils/exampleGeneration/exampleGeneration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,31 @@ export const generateExamplesFromJsonSchema = (schema: JSONSchema7 & { 'x-exampl
label: index === 0 ? 'default' : `example-${index}`,
});
});
// if (!('x-stoplight' in schema)) {
// try {
// const originalExamples = Array.isArray(schema.examples) ? JSON.parse(JSON.stringify(schema.examples)) : [];
// delete schema.examples;
// const generated = Sampler.sample(schema, {
// maxSampleDepth: 4,
// ticks: 6000,
// });
// let examples2: Example[] =
// generated !== null
// ? [
// {
// label: 'default',
// data: safeStringify(generated, undefined, 2) ?? '',
// },
// ]
// : [{ label: 'default', data: '' }];
// schema.examples = originalExamples;
// examples.forEach(item => {
// item.data = examples2[0].data;
// });
// } catch (e) {
// return [{ label: '', data: `Example cannot be created for this schema\n${e}` }];
// }
// }
} else if (isPlainObject(schema?.['x-examples'])) {
for (const [label, example] of Object.entries(schema['x-examples'])) {
if (isPlainObject(example)) {
Expand All @@ -82,24 +107,41 @@ export const generateExamplesFromJsonSchema = (schema: JSONSchema7 & { 'x-exampl
}
}

if (examples.length) {
if (examples.length && 'x-stoplight' in schema) {
return examples;
}

try {
let originalExamples = [];
if (Array.isArray(schema?.examples)) {
originalExamples = JSON.parse(JSON.stringify(schema.examples));
delete schema.examples;
}
// originalExamples = Array.isArray(schema.examples) ? JSON.parse(JSON.stringify(schema.examples)) : [];
// delete schema.examples;
const generated = Sampler.sample(schema, {
maxSampleDepth: 4,
ticks: 6000,
});

return generated !== null
? [
{
label: 'default',
data: safeStringify(generated, undefined, 2) ?? '',
},
]
: [{ label: 'default', data: '' }];
let examples2: Example[] =
generated !== null
? [
{
label: 'default',
data: safeStringify(generated, undefined, 2) ?? '',
},
]
: [{ label: 'default', data: '' }];
if (originalExamples.length) {
schema.examples = originalExamples;
examples.forEach(item => {
item.data = examples2[0].data;
});
return examples;
} else {
return examples2;
}
} catch (e) {
return [{ label: '', data: `Example cannot be created for this schema\n${e}` }];
}
Expand Down