Skip to content

Commit 4f12df2

Browse files
committed
fixes #230 - examples at schema level is not allowed and shold be ignored if exist
1 parent e4c3f99 commit 4f12df2

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

src/utils/schema-utils.js

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,6 @@ export function schemaToSampleObj(schema, config = { }) {
249249

250250
if (schema.example) {
251251
obj[key] = schema.example;
252-
} else if (schema.examples && schema.example.length > 0) {
253-
obj[key] = schema.examples[0];
254252
} else {
255253
obj[key] = schemaToSampleObj(schema.properties[key], config);
256254
}
@@ -268,7 +266,7 @@ export function schemaToSampleObj(schema, config = { }) {
268266
if (schema.properties[key].readOnly && !config.includeReadOnly) { continue; }
269267
if (schema.properties[key].writeOnly && !config.includeWriteOnly) { continue; }
270268
if (schema.properties[key].type === 'array' || schema.properties[key].items) {
271-
if (schema.properties[key].items.example) {
269+
if (schema.properties[key]?.items?.example) { // schemas and properties support single example but not multiple examples.
272270
obj[key] = [schema.properties[key].items.example];
273271
} else {
274272
obj[key] = [schemaToSampleObj(schema.properties[key].items, config)];
@@ -278,18 +276,15 @@ export function schemaToSampleObj(schema, config = { }) {
278276
if (schema.example) {
279277
obj[key] = schema.example;
280278
break;
281-
} else if (schema.examples && schema.example.length > 0) {
282-
obj[key] = schema.examples[0];
283-
break;
284279
} else {
285280
obj[key] = schemaToSampleObj(schema.properties[key], config);
286281
}
287282
}
288283
} else if (schema.type === 'array' || schema.items) {
289284
if (schema.example) {
290285
obj = schema.example;
291-
} else if (schema.examples && schema.example.length > 0) {
292-
obj = schema.examples[0];
286+
} else if (schema.items?.example) { // schemas and properties support single example but not multiple examples.
287+
obj = [schema.items.example];
293288
} else {
294289
obj = [schemaToSampleObj(schema.items, config)];
295290
}

0 commit comments

Comments
 (0)