merge default response even if there is no declared example

Author: ngraef

src/metadata/methodGenerator.ts

@@ -179,14 +179,12 @@ export class MethodGenerator {
 
         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);
+        if (index >= 0) {
+            if (defaultResponse.examples && !responses[index].examples) {
+                responses[index].examples = defaultResponse.examples;
             }
+        } else {
+            responses.push(defaultResponse);
         }
         return responses;
     }

test/data/apis.ts

@@ -101,13 +101,28 @@ export class PromiseService extends BaseService {
      * Esta eh a da classe
      * @param test Esta eh a description do param teste
      */
+    @swagger.Response<string>(401, 'Unauthorized')
     @GET
     test( @QueryParam('testParam')test?: string ): Promise<Person> {
         return new Promise<Person>((resolve, reject) => {
             resolve({name: 'OK'});
         });
     }
 
+    @swagger.Response<Person>(200, 'All Good')
+    @swagger.Response<string>(401, 'Unauthorized')
+    @swagger.Example<Person>({ name: 'Test Person' })
+    @GET
+    @Path(':id')
+    testGetSingle( @PathParam('id') id: string ): Promise<Person> {
+        return new Promise<Person>((resolve, reject) => {
+            resolve({ name: 'OK' });
+        });
+    }
+
+    @swagger.Response<Person>(201, 'Person Created', { name: 'Test Person' })
+    @swagger.Response<string>(401, 'Unauthorized')
+    @swagger.Example<Person>({ name: 'Example Person' }) // NOTE: this is here to test that it doesn't overwrite the example in the @Response above
     @POST
     testPost( obj: Person ): Promise<Return.NewResource<Person>> {
         return new Promise<Return.NewResource<Person>>((resolve, reject) => {

test/unit/definitions.spec.ts

@@ -57,6 +57,37 @@ describe('Definition generation', () => {
       expect(expression.evaluate(spec)).to.eq('Joe');
     });
 
+    it('should include default response if a non-conflicting response is declared with a decorator', () => {
+      let expression = jsonata('paths."/promise".get.responses');
+      expect(Object.keys(expression.evaluate(spec)).length).to.eq(2);
+      expression = jsonata('paths."/promise".get.responses."200".description');
+      expect(expression.evaluate(spec)).to.eq('Ok');
+      expression = jsonata('paths."/promise".get.responses."401".description');
+      expect(expression.evaluate(spec)).to.eq('Unauthorized');
+    });
+
+    it('should not include default response if it conflicts with a declared response', () => {
+      let expression = jsonata('paths."/promise".post.responses');
+      expect(Object.keys(expression.evaluate(spec)).length).to.eq(2);
+      expression = jsonata('paths."/promise".post.responses."201".description');
+      expect(expression.evaluate(spec)).to.eq('Person Created');
+      expression = jsonata('paths."/promise".post.responses."201".examples."application/json".name');
+      expect(expression.evaluate(spec)).to.eq('Test Person');
+      expression = jsonata('paths."/promise".post.responses."401".description');
+      expect(expression.evaluate(spec)).to.eq('Unauthorized');
+    });
+
+    it('should update a declared response with the declared default response example if response annotation doesn\'t specify one', () => {
+      let expression = jsonata('paths."/promise/{id}".get.responses');
+      expect(Object.keys(expression.evaluate(spec)).length).to.eq(2);
+      expression = jsonata('paths."/promise/{id}".get.responses."200".description');
+      expect(expression.evaluate(spec)).to.eq('All Good');
+      expression = jsonata('paths."/promise/{id}".get.responses."200".examples."application/json".name');
+      expect(expression.evaluate(spec)).to.eq('Test Person');
+      expression = jsonata('paths."/promise/{id}".get.responses."401".description');
+      expect(expression.evaluate(spec)).to.eq('Unauthorized');
+    });
+
     it('should generate a definition with a referenced type', () => {
       const expression = jsonata('definitions.Person.properties.address."$ref"');
       expect(expression.evaluate(spec)).to.eq('#/definitions/Address');