fix(schema-example): add support for examples object [TDX-7760] (#816)

Author: vaibhavrajsingh2001

src/utils/schema-example.spec.ts

@@ -13,14 +13,38 @@ describe('extractSampleForParam', () => {
     expect(extractSampleForParam({ example: 'xxx' }, 'key')).toEqual('xxx')
   })
 
+  it('should extract value from example object with value field', () => {
+    expect(extractSampleForParam({ example: { value: 'xxx' } }, 'key')).toEqual('xxx')
+  })
+
+  it('should extract numeric value from example object with value field', () => {
+    expect(extractSampleForParam({ example: { value: 42 } }, 'key')).toEqual(42)
+  })
+
   it('should return example from schema', () => {
     expect(extractSampleForParam({ schema: { examples: ['xxx'] } }, 'key')).toEqual('xxx')
   })
 
+  it('should extract value from schema examples object with value field', () => {
+    expect(extractSampleForParam({ schema: { examples: [{ value: 'xxx' }] } }, 'key')).toEqual('xxx')
+  })
+
+  it('should return schema example if present', () => {
+    expect(extractSampleForParam({ schema: { example: 'xxx' } }, 'key')).toEqual('xxx')
+  })
+
+  it('should extract value from schema example object with value field', () => {
+    expect(extractSampleForParam({ schema: { example: { value: 99 } } }, 'key')).toEqual(99)
+  })
+
   it('should handle examples array', () => {
     expect(extractSampleForParam({ examples: ['xxx'] }, 'key')).toEqual('xxx')
   })
 
+  it('should extract value from examples array object with value field', () => {
+    expect(extractSampleForParam({ examples: [{ value: 'xxx' }] }, 'key')).toEqual('xxx')
+  })
+
   it('should return first element of enum', () => {
     expect(extractSampleForParam({ enum: ['a', 'b'] }, 'key')).toEqual('a')
   })

src/utils/schema-example.ts

@@ -1,6 +1,14 @@
 import { MAX_NESTED_LEVELS } from '@/constants'
 import { resolveSchemaObjectFields, resolveSchemaType } from './schema-model'
 
+/**
+ * util to extract example value from a given example, as example can be a primitive value or an object with value field
+ *
+ * @param example The example to extract value from
+ * @returns The extracted example value
+ */
+const extractExampleValue = (example: any): any => typeof example === 'object' && example?.value ? example.value : example
+
 /**
  * Returning sample value for single parameter
  *
@@ -15,25 +23,32 @@ export const extractSampleForParam = (paramData: Record<string, any> | undefined
 
   let exampleValue = paramData.example
   if (exampleValue !== undefined) {
+    exampleValue = extractExampleValue(exampleValue)
     return exampleValue
   }
 
   if (paramData.schema?.examples) {
     exampleValue = paramData.schema?.examples[0]
+    exampleValue = extractExampleValue(exampleValue)
     if (exampleValue !== undefined) {
       return exampleValue
     }
   }
 
   if (paramData.schema?.example) {
     exampleValue = paramData.schema?.example
+    exampleValue = extractExampleValue(exampleValue)
     if (exampleValue !== undefined) {
       return exampleValue
     }
   }
 
   if (paramData.examples) {
     exampleValue = paramData.examples[0]
+    exampleValue = extractExampleValue(exampleValue)
+    if (exampleValue !== undefined) {
+      return exampleValue
+    }
     if (exampleValue !== undefined) {
       return exampleValue
     }