Fix Examples

Author: thiagobustamante

src/metadata/methodGenerator.ts

@@ -6,7 +6,6 @@ import { getJSDocDescription, getJSDocTag, isExistJSDocTag } from '../utils/jsDo
 import { getDecorators } from '../utils/decoratorUtils';
 import { normalizePath } from '../utils/pathUtils';
 import * as pathUtil from 'path';
-// import * as _ from 'lodash';
 
 export class MethodGenerator {
     private method: string;
@@ -32,10 +31,7 @@ export class MethodGenerator {
 
         const identifier = this.node.name as ts.Identifier;
         const type = resolveType(this.node.type, this.genericTypeMap);
-        const responses = this.getMethodResponses();
-        if (0 === responses.length) {
-          responses.push(this.getMethodSuccessResponse(type));
-        }
+        const responses = this.mergeResponses(this.getMethodResponses(), this.getMethodSuccessResponse(type));
 
         return {
             consumes: this.getDecoratorValues('Accept'),
@@ -176,6 +172,25 @@ export class MethodGenerator {
         return this.getExamplesValue(argument);
     }
 
+    private mergeResponses(responses: Array<ResponseType>, defaultResponse: ResponseType) {
+        if (!responses || !responses.length) {
+            return [defaultResponse];
+        }
+
+        const index = responses.findIndex((resp) => resp.status === defaultResponse.status);
+
+        if (defaultResponse.examples) {
+            if (index >= 0) {
+                if (!responses[index].examples) {
+                    responses[index].examples =  defaultResponse.examples;
+                }
+            } else {
+                responses.push(defaultResponse);
+            }
+        }
+        return responses;
+    }
+
     private supportsPathMethod(method: string) {
         return ['GET', 'POST', 'PATCH', 'DELETE', 'PUT', 'OPTIONS', 'HEAD'].some(m => m === method);
     }

test/data/apis.ts

@@ -40,6 +40,7 @@ export class MyService {
     @swagger.Example<Person>({
         name: 'Joe'
     })
+    @swagger.Response<Person>(200, 'The success test.')
     test2(
         @QueryParam('testRequired')test: string,
         @QueryParam('testDefault')test2: string = 'value',

test/unit/definitions.spec.ts

@@ -25,13 +25,13 @@ describe('Definition generation', () => {
 
     it('should generate examples for object parameter', () => {
       expect(spec.paths).to.have.property('/mypath/secondpath');
-      const expression = jsonata('paths."/mypath/secondpath".get.responses.200.examples."application/json".name');
+      const expression = jsonata('paths."/mypath/secondpath".get.responses."200".examples."application/json".name');
       expect(expression.evaluate(spec)).to.eq('Joe');
     });
 
     it('should generate examples for array paraemter', () => {
       expect(spec.paths).to.have.property('/mypath');
-      const expression = jsonata('paths."/mypath".post.responses.204.examples."application/json"[0].name');
+      const expression = jsonata('paths."/mypath".post.responses."204".examples."application/json"[0].name');
       expect(expression.evaluate(spec)).to.eq('Joe');
     });
 
@@ -45,10 +45,16 @@ describe('Definition generation', () => {
     });
 
     it('should support multiple response decorators', () => {
-      let expression = jsonata('paths."/mypath".get.responses.400.description');
+      let expression = jsonata('paths."/mypath".get.responses."400".description');
       expect(expression.evaluate(spec)).to.eq('The request format was incorrect.');
-      expression = jsonata('paths."/mypath".get.responses.500.description');
+      expression = jsonata('paths."/mypath".get.responses."500".description');
       expect(expression.evaluate(spec)).to.eq('There was an unexpected error.');
+      expression = jsonata('paths."/mypath/secondpath".get.responses."200".description');
+      expect(expression.evaluate(spec)).to.eq('The success test.');
+      expression = jsonata('paths."/mypath/secondpath".get.responses."200".schema."$ref"');
+      expect(expression.evaluate(spec)).to.eq('#/definitions/Person');
+      expression = jsonata('paths."/mypath/secondpath".get.responses."200".examples."application/json"[0].name');
+      expect(expression.evaluate(spec)).to.eq('Joe');
     });
 
     it('should generate a definition with a referenced type', () => {