{"_id":"swagger-changelog","_rev":"212-4c4dff6204e4dec82340db74939e6b1a","name":"swagger-changelog","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"swagger-changelog","version":"1.0.0","keywords":["swagger","swimlane","changelog","diff"],"author":{"name":"Swimlane","email":"info@swimlane.com"},"license":"MIT","_id":"swagger-changelog@1.0.0","maintainers":[{"name":"swimlane","email":"austin@swimlane.com"}],"homepage":"https://github.com/swimlane/swagger-changelog#readme","bugs":{"url":"https://github.com/swimlane/swagger-changelog/issues"},"bin":{"swagger-changelog":"bin/swagger-changelog.js"},"dist":{"shasum":"039a7651c8ce281d4fcc976fe90237cafc6995a5","tarball":"https://registry.npmjs.org/swagger-changelog/-/swagger-changelog-1.0.0.tgz","integrity":"sha512-FfkDh8PaL0EB7tsKhhrzlKVvOzd+xzB4+rvQ9mh3rEohA8tSjLMXvleGV2SFmP8ZjVygEkDPFfRq2YrsV6gfYQ==","signatures":[{"sig":"MEUCIDY2dbaACXl1uFa289WCuZtM5X13/uYl/l8N5Y9mW4snAiEAwnCxVS/42lZmQ5FGqVRZDRKiWBeEtTTvDiBqNPL3PEE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","_from":".","_shasum":"039a7651c8ce281d4fcc976fe90237cafc6995a5","gitHead":"349531d512fca83637209621d553ebc091416e3e","scripts":{"lint":"eslint .","test":"tape src/tests/*.test.js | tap-spec"},"_npmUser":{"name":"swimlane","email":"austin@swimlane.com"},"repository":{"url":"git+https://github.com/swimlane/swagger-changelog.git","type":"git"},"_npmVersion":"4.0.5","description":"API changelog generator based on swagger diffs","directories":{},"_nodeVersion":"7.4.0","dependencies":{"commander":"^2.9.0","swagger-diff":"^0.6.0","damerau-levenshtein":"^1.0.3"},"eslintConfig":{"env":{"es6":true,"node":true},"extends":"swimlane/base"},"devDependencies":{"tape":"^4.6.3","eslint":"^3.14.1","tap-spec":"^4.1.1","eslint-config-swimlane":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/swagger-changelog-1.0.0.tgz_1485474436165_0.38627177849411964","host":"packages-18-east.internal.npmjs.com"}},"1.1.0":{"name":"swagger-changelog","version":"1.1.0","keywords":["swagger","swimlane","changelog","diff"],"author":{"name":"Swimlane","email":"info@swimlane.com"},"license":"MIT","_id":"swagger-changelog@1.1.0","maintainers":[{"name":"shaunburdick","email":"npm@shaunburdick.com"},{"name":"swimlane","email":"austin@swimlane.com"}],"homepage":"https://github.com/swimlane/swagger-changelog#readme","bugs":{"url":"https://github.com/swimlane/swagger-changelog/issues"},"bin":{"swagger-changelog":"bin/swagger-changelog.js"},"dist":{"shasum":"63d3efb64aa7d33be19f5cb2cd3807dac46025d6","tarball":"https://registry.npmjs.org/swagger-changelog/-/swagger-changelog-1.1.0.tgz","integrity":"sha512-l6prNmVeQkRmlbM4LaovC/8d5LMLRh8wIIB0QWfDDBhBfaxPYSDNzPTaFY4KJOibjBJMwA8RcKc31U6j40Mr3g==","signatures":[{"sig":"MEUCIQDsGq6dVdSzSM01n1zup99Webpme+aQuMyzokAOcOV8WAIgFtjdY0HnxRA3tVb4CxL8Co+ijgjEgI6TXCWyUOfeUV8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","_from":".","_shasum":"63d3efb64aa7d33be19f5cb2cd3807dac46025d6","gitHead":"a8c934053d91118915b684700d04e12c27b119e9","scripts":{"lint":"eslint .","test":"tape src/tests/*.test.js | tap-spec"},"_npmUser":{"name":"swimlane","email":"austin@swimlane.com"},"repository":{"url":"git+https://github.com/swimlane/swagger-changelog.git","type":"git"},"_npmVersion":"4.0.5","description":"API changelog generator based on swagger diffs","directories":{},"_nodeVersion":"7.4.0","dependencies":{"commander":"^2.9.0","swagger-diff":"^0.6.0","damerau-levenshtein":"^1.0.3"},"eslintConfig":{"env":{"es6":true,"node":true},"extends":"swimlane/base"},"devDependencies":{"tape":"^4.6.3","eslint":"^3.14.1","tap-spec":"^4.1.1","eslint-config-swimlane":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/swagger-changelog-1.1.0.tgz_1485640359566_0.7655735318548977","host":"packages-18-east.internal.npmjs.com"}}},"time":{"created":"2017-01-26T23:47:16.756Z","modified":"2026-07-14T10:28:15.908Z","1.0.0":"2017-01-26T23:47:16.756Z","1.1.0":"2017-01-28T21:52:40.364Z"},"bugs":{"url":"https://github.com/swimlane/swagger-changelog/issues"},"author":{"name":"Swimlane","email":"info@swimlane.com"},"license":"MIT","homepage":"https://github.com/swimlane/swagger-changelog#readme","keywords":["swagger","swimlane","changelog","diff"],"repository":{"url":"git+https://github.com/swimlane/swagger-changelog.git","type":"git"},"description":"API changelog generator based on swagger diffs","maintainers":[{"email":"hansstoetzer1@gmail.com","name":"hansstoetzer"},{"email":"ben.steele@swimlane.com","name":"bensteele7"},{"email":"brantw@gmail.com","name":"brantw"},{"email":"marjan.georgiev@gmail.com","name":"marjan-georgiev"},{"email":"danstory@gmail.com","name":"danstory"},{"email":"ryan.knauer@swimlane.com","name":"bageldawg"},{"email":"it.admin@swimlane.com","name":"it.admin.swim"},{"email":"roy.araya@swimlane.com","name":"royar95"},{"email":"developers@swimlane.com","name":"swimlane.dev"},{"email":"manideep.laxmishetty@swimlane.com","name":"manideep-swimlane"},{"email":"ian.schultz@swimlane.com","name":"ischultz-swimlane"},{"email":"Jogaj_26@hotmail.com","name":"jogaj_26"},{"email":"nicholas.tausek@gmail.com","name":"nikkuman"},{"email":"sarath.pantula@swimlane.com","name":"sarath.pantula"},{"email":"grandhi.subrahmanyam@swimlane.com","name":"grandhi_subrahmanyam"},{"email":"daniel.abbott@swimlane.com","name":"dabbott-sl"},{"email":"dmytro.skorokhodov@swimlane.com","name":"dmytro_skorokhodov"},{"email":"koushik.kumar@swimlane.com","name":"koushik.kumar"},{"email":"steveblue@gmail.com","name":"steveblue"},{"email":"prasanth.boyina@swimlane.com","name":"prasanthsaiboyina"},{"email":"ashray.gupta@swimlane.com","name":"ashraygupta"},{"email":"surya.pabbineedi@swimlane.com","name":"surya-pabbineedi"},{"email":"anurag.pasupureddi@swimlane.com","name":"anurag-p"},{"email":"anjali.tiwari@swimlane.com","name":"anjali.tiwari"}],"readme":"# Swagger Changelog\n\n[![npm version](https://badge.fury.io/js/swagger-changelog.svg)](https://badge.fury.io/js/swagger-changelog)\n\nGenerate a changelog between two versions of a swagger spec\n\n# Install\n`npm install -g swagger-changelog`\n\n# Usage\n`swagger-changelog [options] <path/to/spec1> <path/to/spec2>`\n\n## Options\n```\n-h, --help          output usage information\n-V, --version       output the version number\n-e, --endpoint <n>  Endpoint Threshold, 0-1.0 (Default 0.85, higher means closer)\n-p, --param <n>     Param Threshold, 0-1.0 (Default 0.75, higher means closer)\n```\n\n## Distance Thresholds\nThe Endpoint and Param thresholds are the minimum value for the Damerau - Levenshtein comparison ratio. It scores from 0-1 how similar the two words are.\n\n## Example\n```\n$ swagger-changelog src/tests/specs/petstore.1.json src/tests/specs/petstore.1.1.json\nChanges: /pet (put) - Method added\nRenamed: Path '/pet/findByStatus' renamed to '/pet/findByStatii'\nRenamed: Path '/pet/findByTags' renamed to '/pet/findByTag'\nRenamed: /pet/{petId} (get) - Param 'petId' renamed to 'petIdz'\n```\n\n# API Usage\n```\nconst changelog = require(swagger-changelog).changelog;\n\nchangelog('path/to/spec1', 'path/to/spec2', config)\n  .then((log) => {\n    console.log(log.paragraph);\n  });\n```\n\n# Credits\n\n`swagger-changelog` is a [Swimlane](https://swimlane.com) open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.\n","readmeFilename":"README.md","users":{"willwm":true}}