delete-description

src/rules/index.js

@@ -33,6 +33,7 @@ export default {
     'add-optional-param': require('./smooth/add-optional-param.js'),
     'add-path': require('./smooth/add-path.js'),
     'add-response': require('./smooth/add-response.js'),
+    'delete-description': require('./smooth/delete-description.js'),
     'delete-object-property': require('./smooth/delete-object-property.js'),
     'delete-param': require('./smooth/delete-param.js'),
     'edit-description': require('./smooth/edit-description.js'),

src/rules/smooth/delete-description.js

@@ -0,0 +1,12 @@
+export default function deleteDescription({ kind, path, lhs, rhs }) {
+  const match = kind === 'D' && path.length >= 2 && path[path.length - 1] === 'description';
+  if (match) {
+    const p = `/${path.slice(0, -1).join('/')}/`;
+    return {
+      message: `${p} - Description deleted: ${lhs}`,
+      descriptionPath: p,
+      description: lhs,
+    };
+  }
+  return false;
+}

test/rules/smooth/delete-description/0-new.json

@@ -0,0 +1,8 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Test API"
+  },
+  "paths": {}
+}

test/rules/smooth/delete-description/0-old.json

@@ -0,0 +1,9 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Test API",
+    "description": "That description"
+  },
+  "paths": {}
+}

test/rules/smooth/delete-description/0-output.json

@@ -0,0 +1,12 @@
+{
+  "breaks": [],
+  "smooths": [
+    {
+      "ruleId": "delete-description",
+      "message": "/info/ - Description deleted: That description",
+      "description": "That description",
+      "descriptionPath": "/info/"
+    }
+  ],
+  "unmatchDiffs": []
+}

test/rules/smooth/delete-description/1-new.json

@@ -0,0 +1,11 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Test API"
+  },
+  "paths": {},
+  "definitions": {
+    "AModel": {}
+  }
+}

test/rules/smooth/delete-description/1-old.json

@@ -0,0 +1,13 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Test API"
+  },
+  "paths": {},
+  "definitions": {
+    "AModel": {
+      "description": "The Model A"
+    }
+  }
+}

test/rules/smooth/delete-description/1-output.json

@@ -0,0 +1,12 @@
+{
+  "breaks": [],
+  "smooths": [
+    {
+      "ruleId": "delete-description",
+      "description": "The Model A",
+      "message": "/definitions/AModel/ - Description deleted: The Model A",
+      "descriptionPath": "/definitions/AModel/"
+    }
+  ],
+  "unmatchDiffs": []
+}