Some other utilities for swagger

.vscode/launch.json

@@ -0,0 +1,52 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Filter",
+            "program": "${workspaceFolder}/bin/swagger-json-filter-vsCode-Test",
+            "args": [ 
+                "filter",
+                "--include-paths",
+                "\"^(\/api\/members\/{memberGuid}\/cmrs\/.*|\/api\/members\/{memberGuid}\/careplans\/({carePlanId}\/problems|{goalID}\/intervention|{problemID}\/goalscareplans).*|\/api\/members\/{memberGuid}\/(medications|allergies|profile\/address|profile\/phone|profile\/email)|\/api\/members\/{memberGuid}\/careproviders.*)$\""
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Remove Definition",
+            "program": "${workspaceFolder}/bin/swagger-json-filter-vsCode-Test",
+            "args": [ 
+                "remove-definition",
+                "--definition-name",
+                "System.ValueTuple`2[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Remove Model Property",
+            "program": "${workspaceFolder}/bin/swagger-json-filter-vsCode-Test",
+            "args": [ 
+                "remove-definition-property",
+                "--definition-name",
+                "AssureCare.MedCompass.Web.Models.Members.Cmr.CmrCommunicationsModel",
+                "--property-name",
+                "RenderedMemberDocuments"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Help",
+            "program": "${workspaceFolder}/bin/swagger-json-filter-vsCode-Test",
+            "args": [ 
+                "--help"
+            ]
+        }
+    ]
+}

bin/swagger-json-filter

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const swaggerJsonFilter = require('../src/index');
+const swaggerUtil = require('../src/index');
 
 const stdin = process.openStdin();
 let inputJson = '';
@@ -8,7 +8,7 @@ stdin.on('data', function (chunk) {
 });
 
 stdin.on('end', function () {
-    const output = swaggerJsonFilter(inputJson, getProgram());
+    const output = swaggerUtil.filterSwagger(inputJson, getProgram());
     console.log(output);
 });
 

bin/swagger-json-remove-definition

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+const swaggerUtil = require('../src/index');
+
+const stdin = process.openStdin();
+let inputJson = '';
+stdin.on('data', function (chunk) {
+    inputJson += chunk;
+});
+
+stdin.on('end', function () {
+    const output = swaggerUtil.removeDefinition(inputJson, getProgram());
+    console.log(output);
+});
+
+function getProgram() {
+    let program = require('commander');
+    program.option('-d, --definition-name <definition-name>', 'Name of definition to remove.')
+        .parse(process.argv);
+    return program;
+}

bin/swagger-json-remove-path

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+const swaggerUtil = require('../src/index');
+
+const stdin = process.openStdin();
+let inputJson = '';
+stdin.on('data', function (chunk) {
+    inputJson += chunk;
+});
+
+stdin.on('end', function () {
+    const output = swaggerUtil.removePath(inputJson, getProgram());
+    console.log(output);
+});
+
+function getProgram() {
+    let program = require('commander');
+    program.option('-p, --path-name <path-name>', 'Name of path to remove.')
+        .parse(process.argv);
+    return program;
+}

bin/swagger-json-remove-property

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+const swaggerUtil = require('../src/index');
+
+const stdin = process.openStdin();
+let inputJson = '';
+stdin.on('data', function (chunk) {
+    inputJson += chunk;
+});
+
+stdin.on('end', function () {
+    const output = swaggerUtil.removeDefinitionProperty(inputJson, getProgram());
+    console.log(output);
+});
+
+function getProgram() {
+    let program = require('commander');
+    program
+        .option('-d, --definition-name <definition-name>', 'Name of definition to remove.')
+        .option('-p, --property-name <property-name>', 'Name of property to remove.')
+        .parse(process.argv);
+    return program;
+}

package.json

@@ -3,7 +3,12 @@
   "version": "0.0.1",
   "description": "Node.js command-line tool for filtering swagger documentation (swagger.json)",
   "main": "src/index.js",
-  "bin": "bin/swagger-json-filter",
+  "bin": {
+    "swagger-json-filter": "bin/swagger-json-filter",
+    "swagger-json-remove-definition": "bin/swagger-json-remove-definition",
+    "swagger-json-remove-path": "bin/swagger-json-remove-path",
+    "swagger-json-remove-property": "bin/swagger-json-remove-property"
+  },
   "directories": {
     "test": "test"
   },

src/index.js

@@ -1,9 +1,9 @@
 const flatten = require('flat');
 
-module.exports = function (inputJson, options) {
+var filterSwagger = function (inputJsonStr, options) {
     const pathRegex = new RegExp(options.includePaths);
     const definitionRegex = new RegExp(options.includeDefinitions);
-    inputJson = JSON.parse(inputJson);
+    inputJson = JSON.parse(inputJsonStr);
 
     let definitionsMap = {};
     for (const defLocalizationName in inputJson) {
@@ -25,6 +25,59 @@ module.exports = function (inputJson, options) {
     return filterJson(inputJson, whiteList);
 };
 
+var removePath = function(inputJsonStr, options)
+{
+    var inputJson = JSON.parse(inputJsonStr);
+    const pathRegex = new RegExp(options.pathName);
+
+    var pathNames = Object.keys(inputJson.paths);
+
+    for (var i = 0; i < pathNames.length; i++)
+    {
+        var pathName= pathNames[i];
+        if(pathRegex.test(pathName))
+        {
+            delete inputJson.paths[pathName];
+        }
+    }
+
+    return JSON.stringify(inputJson);
+}
+
+var removeDefinition = function(inputJsonStr, options)
+{
+    var inputJson = JSON.parse(inputJsonStr);
+    var definitionRegex = new RegExp(options.definitionName);
+    var definitionNames = Object.keys(inputJson.definitions);
+
+    for (var i = 0; i < definitionNames.length; i++)
+    {
+        var definitionName = definitionNames[i];
+        if(definitionRegex.test(definitionName))
+        {
+            delete inputJson.definitions[definitionName];
+        }
+    }
+
+    return JSON.stringify(inputJson);
+}
+
+var removeDefinitionProperty = function(inputJsonStr, options)
+{
+    var inputJson = JSON.parse(inputJsonStr);
+    var definitionName = options.definitionName;
+    var propertyName = options.propertyName;
+
+    if(definitionName in inputJson.definitions)
+    {
+        if(propertyName in inputJson.definitions[definitionName].properties)
+        {
+            delete inputJson.definitions[definitionName].properties[propertyName];
+        }
+    }
+    return JSON.stringify(inputJson);
+}
+
 function removeUnwantedKeys(objectToFilter, keyRegex) {
     for (const key in objectToFilter) {
         if (!keyRegex.test(key)) {
@@ -97,3 +150,9 @@ function filterJson(inputJson, definitionsMap) {
     return JSON.stringify(inputJson);
 }
 
+module.exports = {
+    filterSwagger,
+    removeDefinition,    
+    removeDefinitionProperty,
+    removePath
+}