updated annotations

README.md

@@ -84,7 +84,7 @@ Revalidate: This script is a combination of the generate and lint steps. Useful
 npm run revalidate
 ```
 
-generatePostman: creates the postman collection from the OpenAPI Document 
+generatePostman: creates the postman collection from the OpenAPI Document
 
 ```bash
 npm run generatePostman

spec/petStore.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "",
+    "title": "PetStore",
     "version": "1.0.0-rev1",
     "description": "This is the API for the Pet Store.",
     "license": {
@@ -540,10 +540,12 @@
       },
       "delete": {
         "operationId": "DeletePet",
+        "description": "Remove a pet when its adopted",
         "parameters": [
           {
             "name": "id",
             "in": "path",
+            "description": "id of the pet to update",
             "required": true,
             "schema": {
               "type": "number",
@@ -552,8 +554,16 @@
           }
         ],
         "responses": {
-          "200": {
-            "description": "Ok",
+          "204": {
+            "description": "No Content",
+            "headers": {
+              "CommonResponseHeader": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommonResponseHeader"
+                },
+                "description": "Common Headers Returned"
+              }
+            },
             "content": {
               "application/json": {
                 "schema": {

src/controllers/PetController.ts

@@ -88,7 +88,12 @@ export class PetController extends Controller {
     return updatedPet;
   }
 
+  /**
+   * Remove a pet when its adopted
+   * @param id id of the pet to update
+   */
   @Delete('{id}')
+  @SuccessResponse<CommonResponseHeader>('204', 'No Content')
   public async deletePet(@Path() id: number): Promise<Pet | null> {
     const deletedPet = deletePetById(id);
     if (deletedPet === null) {

src/routes/routes.ts

@@ -232,7 +232,7 @@ export function RegisterRoutes(app: Router) {
         const controller = new PetController();
 
         const promise = controller.deletePet.apply(controller, validatedArgs as any);
-        promiseHandler(controller, promise, response, undefined, next);
+        promiseHandler(controller, promise, response, 204, next);
       } catch (err) {
         return next(err);
       }