@@ -169,6 +169,48 @@ export function getSampleValueByType(schemaObj) {
169169 }
170170}
171171
172+ /*
173+ {
174+ 'prop1' : 'one',
175+ 'prop2' : 'two',
176+ 'prop3' : [ 'a', 'b', 'c' ],
177+ 'prop4' : {
178+ 'ob1' : 'val-1',
179+ 'ob2' : 'val-2'
180+ }
181+ }
182+ <root>
183+ <prop1>simple</prop1>
184+ <prop2>
185+ <0> a </0>
186+ <1> b </1>
187+ <2> c </2>
188+ </prop2>
189+ <prop3>
190+ <ob1>val-1</ob1>
191+ <ob2>val-2</ob2>
192+ </prop3>
193+ </root>
194+ */
195+
196+ export function json2xml ( obj , level = 1 ) {
197+ const indent = ' ' . repeat ( level ) ;
198+ let xmlText = '' ;
199+ if ( level === 1 && typeof obj !== 'object' ) {
200+ return `\n${ indent } ${ obj . toString ( ) } ;
201+ }
202+ for ( const prop in obj ) {
203+ if ( Array . isArray ( obj [ prop ] ) ) {
204+ xmlText = `${ xmlText } ${ indent } ${ prop } ${ json2xml ( obj [ prop ] , level + 1 ) } ${ indent } ${ prop } ;
205+ } else if ( typeof obj [ prop ] === 'object' ) {
206+ xmlText = `${ xmlText } ${ indent } ${ prop } ${ json2xml ( obj [ prop ] , level + 1 ) } ${ indent } ${ prop } ;
207+ } else {
208+ xmlText = `${ xmlText } ${ indent } ${ prop } ${ obj [ prop ] . toString ( ) } ${ prop } ;
209+ }
210+ }
211+ return xmlText ;
212+ }
213+
172214/* For changing JSON-Schema to a Sample Object, as per the schema (to generate examples based on schema) */
173215export function schemaToSampleObj ( schema , config = { } ) {
174216 let obj = { } ;
@@ -364,6 +406,8 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
364406/* Create Example object */
365407export function generateExample ( examples , example , schema , mimeType , includeReadOnly = true , outputType ) {
366408 const finalExamples = [ ] ;
409+
410+ // First check if examples is provided
367411 if ( examples ) {
368412 for ( const eg in examples ) {
369413 let egContent = '' ;
@@ -420,7 +464,7 @@ export function generateExample(examples, example, schema, mimeType, includeRead
420464 egFormat = 'text' ;
421465 }
422466 finalExamples . push ( {
423- exampleId : '_default ' ,
467+ exampleId : 'Example ' ,
424468 exampleSummary : '' ,
425469 exampleDescription : '' ,
426470 exampleType : mimeType ,
@@ -433,14 +477,14 @@ export function generateExample(examples, example, schema, mimeType, includeRead
433477 if ( schema ) {
434478 if ( schema . example ) { // Note: schema.examples (plurals) is not allowed as per spec
435479 finalExamples . push ( {
436- exampleId : '_default ' ,
480+ exampleId : 'Example ' ,
437481 exampleSummary : '' ,
438482 exampleDescription : '' ,
439483 exampleType : mimeType ,
440484 exampleValue : schema . example ,
441485 exampleFormat : 'text' ,
442486 } ) ;
443- } else if ( mimeType . toLowerCase ( ) . includes ( 'json' ) || mimeType . toLowerCase ( ) . includes ( '*/*' ) ) {
487+ } else if ( mimeType . toLowerCase ( ) . includes ( 'json' ) || mimeType . toLowerCase ( ) . includes ( 'text' ) || mimeType . toLowerCase ( ) . includes ( ' */*') ) {
444488 const egJson = schemaToSampleObj (
445489 schema ,
446490 {
@@ -451,26 +495,35 @@ export function generateExample(examples, example, schema, mimeType, includeRead
451495 ) ;
452496
453497 finalExamples . push ( {
454- exampleId : '_default ' ,
498+ exampleId : 'Example ' ,
455499 exampleSummary : '' ,
456500 exampleDescription : '' ,
457501 exampleType : mimeType ,
458502 exampleFormat : outputType ,
459503 exampleValue : outputType === 'text' ? JSON . stringify ( egJson , null , 2 ) : egJson ,
460504 } ) ;
461505 } else if ( mimeType . toLowerCase ( ) . includes ( 'xml' ) ) {
462- // TODO: in case the mimeType is XML then generate an XML example
506+ const xmlRootStart = ( schema . xml && schema . xml . name ) ? `<${ schema . xml . name } : '<root>' ;
507+ const xmlRootEnd = ( schema . xml && schema . xml . name ) ? `</${ schema . xml . name } : '</root>' ;
508+ const egJson = schemaToSampleObj (
509+ schema ,
510+ {
511+ includeReadOnly,
512+ includeWriteOnly : true ,
513+ deprecated : true ,
514+ } ,
515+ ) ;
463516 finalExamples . push ( {
464- exampleId : '_default ' ,
517+ exampleId : 'Example ' ,
465518 exampleSummary : '' ,
466519 exampleDescription : '' ,
467520 exampleType : mimeType ,
468- exampleValue : '' ,
521+ exampleValue : ` ${ xmlRootStart } ${ json2xml ( egJson ) } \n ${ xmlRootEnd } ` ,
469522 exampleFormat : 'text' ,
470523 } ) ;
471524 } else {
472525 finalExamples . push ( {
473- exampleId : '_default ' ,
526+ exampleId : 'Example ' ,
474527 exampleSummary : '' ,
475528 exampleDescription : '' ,
476529 exampleType : mimeType ,
@@ -481,7 +534,7 @@ export function generateExample(examples, example, schema, mimeType, includeRead
481534 } else {
482535 // No Example or Schema provided (should never reach here)
483536 finalExamples . push ( {
484- exampleId : '_default ' ,
537+ exampleId : 'Example ' ,
485538 exampleSummary : '' ,
486539 exampleDescription : '' ,
487540 exampleType : mimeType ,
@@ -493,7 +546,6 @@ export function generateExample(examples, example, schema, mimeType, includeRead
493546 return finalExamples ;
494547}
495548
496-
497549export function getBaseUrlFromUrl ( url ) {
498550 const pathArray = url . split ( '/' ) ;
499551 return `${ pathArray [ 0 ] } ${ pathArray [ 2 ] } ;
0 commit comments