Merge pull request #768 from postmanlabs/feature/multi-example-support

Added support for multiple examples to be generated as request examples.
postmanlabs · Sep 28, 2023 · c406183 · c406183
2 parents d764b53 + bece53a
commit c406183
Show file tree

Hide file tree

Showing 8 changed files with 814 additions and 134 deletions.
diff --git a/libV2/schemaUtils.js b/libV2/schemaUtils.js
diff --git a/test/data/valid_openapi/custom_headers.json b/test/data/valid_openapi/custom_headers.json
@@ -16,12 +16,6 @@
 									"type": "integer",
 									"format": "int32"
 								}
-							},
-							"application/vnd.retailer.v3+json": {
-								"schema": {
-									"type": "integer",
-									"format": "int32"
-								}
 							}
 						}
 					}
@@ -34,4 +28,4 @@
 			"url": "https://api.com"
 		}
 	]
-}
+}
diff --git a/test/data/valid_openapi/multiExampleMatchingRequestResponse.yaml b/test/data/valid_openapi/multiExampleMatchingRequestResponse.yaml
@@ -0,0 +1,69 @@
+openapi: 3.0.0
+info:
+  title: None
+  version: 1.0.0
+  description: None
+paths:
+  /v1:
+    post:
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: "#/components/schemas/World"
+            examples:
+              valid-request:
+                value:
+                  includedFields:
+                    - user
+                    - height
+                    - weight
+              missing-required-parameter:
+                value:
+                  includedFields:
+                    - user
+      responses:
+        200:
+          description: None
+          content:
+            'application/json':
+              schema:
+                $ref: "#/components/schemas/Request"
+              examples:
+                valid-request:
+                  summary: Complete request
+                  value:
+                    {
+                      "user": 1,
+                      "height": 168,
+                      "weight": 44
+                    }
+                missing-required-parameter:
+                  summary: Request with only required params
+                  value:
+                    {
+                      "user": 1
+                    }
+components:
+  schemas:
+    World:
+      type: object
+      properties:
+        includedFields:
+          type: array
+    Request:
+      type: object
+      required:
+        - user
+        - height
+        - weight
+      properties:
+        user:
+          type: integer
+          description: None
+        height:
+          type: integer
+          description: None
+        weight:
+          type: integer
+          description: None
diff --git a/test/data/valid_openapi/multiExampleRequest.yaml b/test/data/valid_openapi/multiExampleRequest.yaml
@@ -0,0 +1,50 @@
+openapi: 3.0.0
+info:
+  title: None
+  version: 1.0.0
+  description: None
+paths:
+  /v1/:
+    post:
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: "#/components/schemas/Request"
+            examples:
+              valid-request:
+                value:
+                  {
+                    "user": 1,
+                    "height": 168,
+                    "weight": 44
+                  }
+              missing-required-parameter:
+                value:
+                  {
+                    "user": 1
+                  }
+      responses:
+        200:
+          description: None
+          content:
+            'application/json':
+              example: { hello: 'world' }
+components:
+  schemas:
+    Request:
+      type: object
+      required:
+        - user
+        - height
+        - weight
+      properties:
+        user:
+          type: integer
+          description: None
+        height:
+          type: integer
+          description: None
+        weight:
+          type: integer
+          description: None
diff --git a/test/data/valid_openapi/multiExampleRequestResponse.yaml b/test/data/valid_openapi/multiExampleRequestResponse.yaml
@@ -0,0 +1,70 @@
+openapi: 3.0.0
+info:
+  title: None
+  version: 1.0.0
+  description: None
+paths:
+  /v1:
+    post:
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: "#/components/schemas/World"
+            examples:
+              valid-request:
+                value:
+                  includedFields:
+                    - user
+                    - height
+                    - weight
+              missing-required-parameter:
+                value:
+                  includedFields:
+                    - user
+      responses:
+        200:
+          description: None
+          content:
+            'application/json':
+              schema:
+                $ref: "#/components/schemas/Request"
+              examples:
+                not-matching-key:
+                  summary: Request with only required params
+                  value:
+                    {
+                      "user": 1
+                    }
+                not-matching-key-2:
+                  summary: Complete request
+                  value:
+                    {
+                      "user": 1,
+                      "height": 168,
+                      "weight": 44
+                    }
+
+components:
+  schemas:
+    World:
+      type: object
+      properties:
+        includedFields:
+          type: array
+    Request:
+      type: object
+      required:
+        - user
+        - height
+        - weight
+      properties:
+        user:
+          type: integer
+          description: None
+        height:
+          type: integer
+          description: None
+        weight:
+          type: integer
+          description: None
diff --git a/test/data/valid_openapi/multiExampleResponse.yaml b/test/data/valid_openapi/multiExampleResponse.yaml
@@ -0,0 +1,60 @@
+openapi: 3.0.0
+info:
+  title: None
+  version: 1.0.0
+  description: None
+paths:
+  /v1:
+    post:
+      requestBody:
+        content:
+          'application/json':
+            schema:
+              $ref: "#/components/schemas/World"
+            examples:
+              hello-world:
+                value:
+                  hello: world
+      responses:
+        200:
+          description: None
+          content:
+            'application/json':
+              schema:
+                $ref: "#/components/schemas/Request"
+              examples:
+                valid-request:
+                  value:
+                    {
+                      "user": 1,
+                      "height": 168,
+                      "weight": 44
+                    }
+                missing-required-parameter:
+                  value:
+                    {
+                      "user": 1
+                    }
+components:
+  schemas:
+    World:
+      type: object
+      properties:
+        hello:
+          type: string
+    Request:
+      type: object
+      required:
+        - user
+        - height
+        - weight
+      properties:
+        user:
+          type: integer
+          description: None
+        height:
+          type: integer
+          description: None
+        weight:
+          type: integer
+          description: None
diff --git a/test/unit/base.test.js b/test/unit/base.test.js
@@ -371,7 +371,7 @@ describe('CONVERT FUNCTION TESTS ', function() {
       Converter.convert({ type: 'string', data: openapi }, { schemaFaker: true }, (err, conversionResult) => {
         expect(err).to.be.null;
         expect(conversionResult.output[0].data.item[0].response[0].header[0].value)
-          .to.equal('application/vnd.retailer.v3+json');
+          .to.equal('application/vnd.retailer.v3+xml');
         done();
       });
     });