exframe-api - npm Package Compare versions

Comparing version 0.4.7 to 0.4.8

package.json

 {
   "name": "exframe-api",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "description": "exframe-api",
@@ -48,3 +48,3 @@ "main": "index.js",
   },
-  "gitHead": "d9641658b6e0f058726402b7fe6a859cfd4b11ab"
+  "gitHead": "ef914cbc30e856ef4d8509c6696e56ad1cae7031"
 }

src/Operations.js

@@ -52,4 +52,16 @@ const ParameterList = require('./ParameterList');
   }
+
+  patch(operationOptions, ...middleware) {
+    this.operation('patch', operationOptions, ...middleware);
+
+    return this;
+  }
+
+  delete(operationOptions, ...middleware) {
+    this.operation('delete', operationOptions, ...middleware);
+
+    return this;
+  }
 }
 
 module.exports = Operations;

test/data/output.json

@@ -206,2 +206,112 @@ {
         }
+      },
+      "patch": {
+        "summary": "Patch the resource",
+        "description": "make partial changes in the existing resource data",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "title": "Result",
+                  "properties": {
+                    "result": {
+                      "$ref": "#/components/schemas/resource"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid Parameters",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/error"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/resource"
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete the resource",
+        "description": " delete the resource data",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "title": "Result",
+                  "properties": {
+                    "result": {
+                      "$ref": "#/components/schemas/resource"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid Parameters",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/error"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/resource"
+              }
+            }
+          }
+        }
       }
@@ -208,0 +318,0 @@ }

test/support/routes/resource.js

@@ -107,3 +107,33 @@ 'use strict';
       }
+    )
+    .patch(
+      {
+        summary: 'Patch the resource',
+        description: 'make partial changes in the existing resource data',
+        body: content.json(schema.ref(components.schema('resource'))),
+        configureSchema: ({ responses }) => {
+          addSuccessResponse(responses, schema.ref(components.schema('resource')));
+          addErrorResponse(responses, 404);
+          addErrorResponse(responses, 400);
+        }
+      },
+      (request, response) => {
+        response.json({ message: 'success', result: { value: 1 } });
+      }
+    )
+    .delete(
+      {
+        summary: 'Delete the resource',
+        description: ' delete the resource data',
+        body: content.json(schema.ref(components.schema('resource'))),
+        configureSchema: ({ responses }) => {
+          addSuccessResponse(responses, schema.ref(components.schema('resource')));
+          addErrorResponse(responses, 404);
+          addErrorResponse(responses, 400);
+        }
+      },
+      (request, response) => {
+        response.json({ message: 'success', result: { value: 1 } });
+      }
     );
 };

No alert changes

Improved metrics

Total package byte prevSize

36198

increased by13.55%

Lines of code

1173

increased by14.44%

No dependency changes