Merge pull request #503 from postmanlabs/fix/valuePropInExample

Fix/value prop in example

Author: VShingala

lib/schemaUtils.js

@@ -1409,10 +1409,6 @@ module.exports = {
         }
       }
       bodyData = bodyObj.example;
-      // return example value if present else example is returned
-      if (bodyData.hasOwnProperty('value')) {
-        bodyData = bodyData.value;
-      }
     }
     else if (!_.isEmpty(bodyObj.examples) && (resolveTo === 'example' || !bodyObj.schema)) {
       // take one of the examples as the body and not all

test/data/valid_openapi/deepObjectLengthProperty.yaml

@@ -7,7 +7,6 @@ paths:
     get:
       operationId: someRequest
       parameters:
-        - $ref: '#/components/parameters/DeepObjectNestedList'
         - $ref: '#/components/parameters/DeepObjectLengthParameter'
       responses:
         '200':

test/data/valid_openapi/petstoreParamExample.yaml

@@ -0,0 +1,70 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: object
+            properties:
+              value:
+                type:
+                  - integer
+          example:
+            value: 1
+        - name: user
+          in: query
+          required: true
+          style: deepObject
+          schema:
+            type:
+              - object
+            properties:
+              id:
+                type:
+                  - integer
+              value:
+                type:
+                  - string
+          example:
+            id: 1
+            value: Vani
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"

test/data/valid_openapi/valuePropInExample.yaml

@@ -0,0 +1,132 @@
+openapi: 3.0.0
+info:
+  version: '1.1.1'
+  title: 'ExampleYaml'
+  license:
+    name: MIT
+servers:
+  - url: 'localhost:3000'
+paths:
+  /user:
+    get:
+      summary: 'Sample endpoint: Returns details about a particular user'
+      operationId: listUser
+      tags:
+        - user
+      parameters:
+        - name: id
+          in: query
+          description: ID of the user
+          required: true
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: 'Sample response: Details about a user by ID'
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+              example:
+                id: "5789-6378-6372-6372"
+                name: Vani
+                tag: true
+                value: QA
+                lastmodifieddate: "2022-03-30T07:01:46"
+                lastmodifiedBy: VM
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+  /pet:
+    get:
+      summary: 'Sample endpoint: Returns details about a particular pet'
+      operationId: listPet
+      tags:
+        - pet
+      parameters:
+        - name: id
+          in: query
+          description: ID of the pet
+          required: true
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: 'Sample response: Details about a pet by ID'
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                    format: int64
+                  value:
+                    type: string
+              example:
+                id: "5789-6378-6372-6372"
+                value: QA
+        default:
+          description: Unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  schemas:
+    User:
+      type: object
+      required:
+        - id
+        - name
+        - tag
+        - value
+        - lastmodifieddate
+        - lastmodifiedBy
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+        value:
+          type: string
+        lastmodifieddate:
+          type: integer
+          format: int64
+        lastmodifiedBy:
+          type: string
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+  securitySchemes:
+    BasicAuth:
+      type: http
+      scheme: basic
+security:
+  - BasicAuth: []

test/unit/base.test.js

@@ -46,7 +46,9 @@ describe('CONVERT FUNCTION TESTS ', function() {
       rootUrlServerWithVariables = path.join(__dirname, VALID_OPENAPI_PATH + '/root_url_server_with_variables.json'),
       parameterExamples = path.join(__dirname, VALID_OPENAPI_PATH + '/parameteres_with_examples.yaml'),
       issue10229 = path.join(__dirname, VALID_OPENAPI_PATH, '/issue#10229.json'),
-      deepObjectLengthProperty = path.join(__dirname, VALID_OPENAPI_PATH, '/deepObjectLengthProperty.yaml');
+      deepObjectLengthProperty = path.join(__dirname, VALID_OPENAPI_PATH, '/deepObjectLengthProperty.yaml'),
+      valuePropInExample = path.join(__dirname, VALID_OPENAPI_PATH, '/valuePropInExample.yaml'),
+      petstoreParamExample = path.join(__dirname, VALID_OPENAPI_PATH, '/petstoreParamExample.yaml');
 
 
     it('Should add collection level auth with type as `bearer`' +
@@ -467,7 +469,7 @@ describe('CONVERT FUNCTION TESTS ', function() {
             expect(rootRequest.body.raw).to
               .equal('{\n  "a": "<string>",\n  "b": "<string>"\n}');
             expect(exampleRequest.body.raw).to
-              .equal('{\n  "a": "example-b",\n  "b": "example-c"\n}');
+              .equal('{\n  "value": {\n    "a": "example-b",\n    "b": "example-c"\n  }\n}');
             done();
           });
       });
@@ -1109,6 +1111,34 @@ describe('CONVERT FUNCTION TESTS ', function() {
           done();
         });
     });
+
+    it('Should convert value property in example' +
+    valuePropInExample, function(done) {
+      var openapi = fs.readFileSync(valuePropInExample, 'utf8');
+      Converter.convert({ type: 'string', data: openapi },
+        { schemaFaker: true, requestParametersResolution: 'Example' }, (err, conversionResult) => {
+          expect(err).to.be.null;
+          expect(conversionResult.result).to.equal(true);
+          expect(conversionResult.output[0].data.item[0].response[0]
+            .body).to.include('"value": "QA"');
+          expect(conversionResult.output[0].data.item[1].response[0]
+            .body).to.include('"value": "QA"');
+          done();
+        });
+    });
+
+    it('Should convert example in parameters' +
+    petstoreParamExample, function(done) {
+      var openapi = fs.readFileSync(petstoreParamExample, 'utf8');
+      Converter.convert({ type: 'string', data: openapi },
+        { schemaFaker: true, requestParametersResolution: 'Example' }, (err, conversionResult) => {
+          expect(err).to.be.null;
+          expect(conversionResult.result).to.equal(true);
+          expect(conversionResult.output[0].data.item[0].request.url.variable[0].value).to.equal('value,1');
+          expect(conversionResult.output[0].data.item[0].request.url.query[1].key).to.equal('user[value]');
+          done();
+        });
+    });
   });
 
   describe('requestNameSource option', function() {

test/unit/util.test.js

@@ -690,14 +690,23 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
     });
 
     it('should work for example', function() {
+      var bodyWithExample = {
+          example: 'This is a sample value'
+        },
+        retValExample = SchemaUtils.convertToPmBodyData(bodyWithExample, 'application/json');
+
+      expect(retValExample).to.equal('This is a sample value');
+    });
+
+    it('should work for example with value property', function() {
       var bodyWithExample = {
           example: {
             value: 'This is a sample value'
           }
         },
         retValExample = SchemaUtils.convertToPmBodyData(bodyWithExample, 'application/json');
 
-      expect(retValExample).to.equal('This is a sample value');
+      expect(retValExample.value).to.equal('This is a sample value');
     });
 
     it('should work for examples', function() {
@@ -1678,10 +1687,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
               description: 'body description',
               content: {
                 'text/plain': {
-                  example: {
-                    summary: 'A list containing two items',
-                    value: 'text/plain description'
-                  }
+                  example: 'text/plain description'
                 }
               }
             },
@@ -1690,7 +1696,8 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
             exampleParametersResolution: 'example'
           });
           resultBody = result.body.raw;
-          expect(resultBody).to.equal('"text/plain description"');
+          expect(resultBody)
+            .to.equal('"text/plain description"');
           expect(result.contentHeader).to.deep.include(
             { key: 'Content-Type', value: 'text/plain' });
           done();
@@ -1701,10 +1708,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
               description: 'body description',
               content: {
                 'text/html': {
-                  example: {
-                    summary: 'A list containing two items',
-                    value: '<html><body><ul><li>item 1</li><li>item 2</li></ul></body></html>'
-                  }
+                  example: '<html><body><ul><li>item 1</li><li>item 2</li></ul></body></html>'
                 }
               }
             },
@@ -1857,10 +1861,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
             description: 'body description',
             content: {
               'text/plain': {
-                example: {
-                  summary: 'A list containing two items',
-                  value: 'text/plain description'
-                }
+                example: 'text/plain description'
               }
             }
           },
@@ -1877,10 +1878,7 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
             description: 'body description',
             content: {
               'text/html': {
-                example: {
-                  summary: 'A list containing two items',
-                  value: '<html><body><ul><li>item 1</li><li>item 2</li></ul></body></html>'
-                }
+                example: '<html><body><ul><li>item 1</li><li>item 2</li></ul></body></html>'
               }
             }
           },