{"_id":"@holochain/dna-to-openapi","_rev":"31-7e90cfd561762d70d83d3a9c14fa264d","name":"@holochain/dna-to-openapi","dist-tags":{"latest":"0.2.1"},"versions":{"0.0.3":{"name":"@holochain/dna-to-openapi","version":"0.0.3","license":"Apache-2.0","_id":"@holochain/dna-to-openapi@0.0.3","maintainers":[{"name":"connoropolous","email":"connorturland@gmail.com"},{"name":"neonphog","email":"neonphog@neonphog.com"},{"name":"philipbeadle","email":"philip.beadle@live.com.au"}],"homepage":"https://github.com/holochain/dna-to-openapi#readme","bugs":{"url":"https://github.com/holochain/dna-to-openapi/issues"},"bin":{"dna-to-openapi":"./bin/dna-to-openapi"},"nyc":{"all":true,"lines":80,"include":["./lib/**/*.js"],"branches":80,"per-file":false,"reporter":["lcov","text-summary"],"functions":80,"statements":80,"check-coverage":true},"dist":{"shasum":"482db19b8ba781f59e81064f06af002bd3702ab0","tarball":"https://registry.npmjs.org/@holochain/dna-to-openapi/-/dna-to-openapi-0.0.3.tgz","fileCount":18,"integrity":"sha512-bX7x+w1F9G74QZwfbMzReC9B1N4QVyNf3OmmyclzRr8lcVR3CWDikSVhQlf9/chkf6aPHBdwNfDCgE/xHb5rHg==","signatures":[{"sig":"MEYCIQDjHGUOid2DqsYEY0AOOG/t2///0+hb+BJmV9bezOF7cwIhANAoZkVFp+BGuZksPGHwohLYaQjrJuwF32Yn7By3eZet","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33313,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbFq/ECRA9TVsSAnZWagAAhFMQAIO6WqjiFCo5W/EJNDkU\nTwPXVZ9cJuh8dtWVsO90p5VsL0wTr9fM9GDf5Eg7cnkxKqeN4eZyG+5+WljJ\nkYSgKbATgIi0BjxLNRuk4kYnWlECvcCqqSC1g18+F5i5CXHREaAiqfuaiKMw\nHNxRpCKEpUlxlOGNuvkB/INLKOM18cMte6zbH4jeEGkg62PnwvdjtpVD9DEJ\nShG+Q18bsB4TMnIc/s2A464eu0AIrztGbvQ5OJCrou4Z2ObCuH3X/rkNZc2I\n8jYg3d1t1xWf60Kz5R97CArjdMqv0XxaKqE9ASG9BM4efwg7gr41X0mKazsd\n2APJlKX+XrY7rMG3YODn0Kh4Mo1L9m96R3vWt0i72/OA1z1BMFOE8rJXtIDs\nszWeNGR1s1OvWz0hM24EmhhsjTEsYtn4YRuCRtYV+pW4c/eGbXhB4+nz0QJ6\nTPdjxd32vhKqjRJlYTLC8dGdz9ef9ojHZCYuOb2dNIKyJLdGq2OZZcwBs63l\nkrfuoeB+RZXrgvdWpfOf2tmCDuIyMPGAwMqc3k9q30xl0r9r/oTu6fz2aBmG\n/EYIz58umjhs+8CvCw8A063NkO4h+cv+h2li75XXJk0pYlPxNf2PgFoFYeFt\nLzgZ+INVEp33CzqGBt61LnbHWOGIEAF8xHixPKAIMvcUs9S+5Y2+1S/E9X6Y\nTaEz\r\n=pf7c\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"5ef9f2048d10bffcbd2fb04f61735d3d4a2ea6ce","scripts":{"test":"standard --fix '**/*.js' 'bin/**/*' && nyc ./node_modules/mocha/bin/mocha 'lib/**/*.test.js' 'bin/**/*.test.js'","coverage":"node -e \"require('opn')('coverage/lcov-report/index.html')\"","preversion":"npm test","postversion":"git push --follow-tags"},"_npmUser":{"name":"neonphog","email":"neonphog@neonphog.com"},"standard":{"env":{"mocha":true}},"repository":{"url":"git+https://github.com/holochain/dna-to-openapi.git","type":"git"},"_npmVersion":"6.0.1","description":"given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation","directories":{"lib":"lib"},"_nodeVersion":"8.11.1","dependencies":{"yargs":"^11.0.0","swagger-ui-dist":"3.16.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^12.0.2","opn":"^5.3.0","tmp":"0.0.33","chai":"^4.1.2","mocha":"^5.2.0","standard":"^11.0.1"},"_npmOperationalInternal":{"tmp":"tmp/dna-to-openapi_0.0.3_1528213443162_0.3927584530225765","host":"s3://npm-registry-packages"}},"0.1.0":{"name":"@holochain/dna-to-openapi","version":"0.1.0","keywords":["holo","holochain","openapi","blockchain","api","documentation"],"license":"Apache-2.0","_id":"@holochain/dna-to-openapi@0.1.0","maintainers":[{"name":"connoropolous","email":"connorturland@gmail.com"},{"name":"neonphog","email":"neonphog@neonphog.com"},{"name":"philipbeadle","email":"philip.beadle@live.com.au"}],"homepage":"https://github.com/holochain/dna-to-openapi#readme","bugs":{"url":"https://github.com/holochain/dna-to-openapi/issues"},"bin":{"dna-to-openapi":"./bin/dna-to-openapi"},"nyc":{"all":true,"lines":80,"include":["./lib/**/*.js"],"branches":80,"per-file":false,"reporter":["lcov","text-summary"],"functions":80,"statements":80,"check-coverage":true},"dist":{"shasum":"c33da2708e70bd19a68534672009637c7ec3948b","tarball":"https://registry.npmjs.org/@holochain/dna-to-openapi/-/dna-to-openapi-0.1.0.tgz","fileCount":18,"integrity":"sha512-qBoRegN6GJH4hRYyADnHCMFn5NMU3rA9ke9XNiHMfv84bZ4Ih1UHBbF27NBPKgzVdQnfGUG7YlVAFFagEDJTlg==","signatures":[{"sig":"MEYCIQChXF18UhDHHhUYdK8FKYNHdV9mjBcV4Q2UObBLeC//pAIhALVbU0EzsrKoczV83L7pvJrWshE12VLobhN4elRbsyU4","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":35158,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbFszsCRA9TVsSAnZWagAAKW0P/27Ri7M5xrl/c9xAvl4V\nqOclYCgsnS8s0K5ch2jnlXLs4iQR9/KB2XjnYBa2Iuej9rVCP4EbVxMlgxJF\nlIAwqeKFZJpOlk9C8tsFSLqk2lfiq7JxyBjKV7aeCsgbiKWjVtROH32p3iej\nthrWTQZ/Xd8rIuldoJd3nSIJwe0n0M203PFx5R9qFtyW+ni2yKLC+L+Uzyku\ntLR2ZnNb8HCQbSe4jEtokkSTmzSVhvLbh1ZHeu5R2k+bA9aF+BYy3qIdmJBE\nY7s3MDEypiOtz6UxjwaWwpLtEYOleXyDSzBpioEtpsrHOMeA5MdTtUWhNMoi\nI2N3A+0MSzYgoc+f+2CrJZtsMypRX5iZA2NucT7NcTduGEoUFIned9uWL2Nn\njQAAV3eZmnL2PKgTFjjkbtWUg9wtBiu0k24kKgfo7f+GCde+vriJEAxN27za\nUamQf71k3P8EXhD2LCBPrOOD9wnd6aahnj7/kRrH0jiKkP/xKpZagMy99Bp/\nauWnQYXcOJ0fqE+M2IPCClvjIh/aO+6yEU5F++1PI+XsvpRAWIJDb2KR+zoc\n/Bt/2wpGCvh9oMjeoOhGj5bu1/cKfbvpHy31t3ByCf72TchzcM3jlDhARQCu\nw8H9TNCk1D0649RVG1ISMiD6j97RujXzS1raUM6cDpj1iPM7wRwI6J7M6+Hb\nGXbP\r\n=4t58\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"eceec2a39ec1d70cd65a9cde18647703bb86d146","scripts":{"test":"standard --fix '**/*.js' 'bin/**/*' && nyc ./node_modules/mocha/bin/mocha 'lib/**/*.test.js' 'bin/**/*.test.js'","coverage":"node -e \"require('opn')('coverage/lcov-report/index.html')\"","preversion":"npm test","postversion":"git push --follow-tags"},"_npmUser":{"name":"neonphog","email":"neonphog@neonphog.com"},"standard":{"env":{"mocha":true}},"repository":{"url":"git+https://github.com/holochain/dna-to-openapi.git","type":"git"},"_npmVersion":"6.1.0","description":"given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation","directories":{"lib":"lib"},"_nodeVersion":"8.11.1","dependencies":{"yargs":"^11.0.0","swagger-ui-dist":"3.16.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^12.0.2","opn":"^5.3.0","tmp":"0.0.33","chai":"^4.1.2","mocha":"^5.2.0","standard":"^11.0.1"},"_npmOperationalInternal":{"tmp":"tmp/dna-to-openapi_0.1.0_1528220906989_0.15141381309149127","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@holochain/dna-to-openapi","version":"0.2.0","keywords":["holo","holochain","openapi","blockchain","api","documentation"],"license":"Apache-2.0","_id":"@holochain/dna-to-openapi@0.2.0","maintainers":[{"name":"connoropolous","email":"connorturland@gmail.com"},{"name":"neonphog","email":"neonphog@neonphog.com"},{"name":"philipbeadle","email":"philip.beadle@live.com.au"}],"homepage":"https://github.com/holochain/dna-to-openapi#readme","bugs":{"url":"https://github.com/holochain/dna-to-openapi/issues"},"bin":{"dna-to-openapi":"./bin/dna-to-openapi"},"nyc":{"all":true,"lines":80,"include":["./lib/**/*.js"],"branches":80,"per-file":false,"reporter":["lcov","text-summary"],"functions":80,"statements":80,"check-coverage":true},"dist":{"shasum":"8bca9a36bcb2d6948c283164b796e32aaa5122be","tarball":"https://registry.npmjs.org/@holochain/dna-to-openapi/-/dna-to-openapi-0.2.0.tgz","fileCount":20,"integrity":"sha512-2ApjE3SYEC4/DJ2VzE8oyR4iSSWswuvS1Wg8hNfFJN49Rfddp8pyxRclz/86bV6DA4knBLodTKW3zniDeXLipQ==","signatures":[{"sig":"MEQCIFoNelrf53R1ByTOqn6iIfNB6Jpojz2Dk8aqX//TI6miAiABYqsqCiC7ct9XXQMOd1/RQBSXpnpdOq47sAazqwiQTg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":2150120,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbMVl7CRA9TVsSAnZWagAA1acP/39R9uiFHihIXyzsyF8f\ndNlHkBPOP0SEQiIGoSO3PEZeUaJaQ5uYReicA6ORqvnf+iSTgP65M6QOJ/hU\nHyQtSPSSSKsYjRIhAekI+ZO1yjZjA29ZzPsghWb7QA3LEJfoReZ9gOv6Cpx9\n8o0cH/8qNP+2omtGOsQQ3CsVqYuNNjbaKmvztvKRYeYG5NUJSykrNlRWpoC8\nWWqxhvYv5NIGM6KFi0fSMXj1kl5U66OU6Ba+ndKj2Oz7Z1ZE0p7DqBICqpAf\nbJG2ehHuRm0Vh72I6x9nWmUzxKJGjcg0Wp0qgkTZcEZOcrlRDGq1rr/k+T4B\nO3ImjEYigKxHOgC+Zp4fCN1hPWXM65+7Qj0hNax/PMFGFEaS1bY7a/o43PuJ\n+Z/Z5FQAnFnSiOLXsOChHC1t07livYjL+JVtxqqBrGalezO7xpnuqhnQ79Hf\ntZc8W5JgXWERRAm2Fmgur7em/DlAiBJdg3p6Fp68LQhccNL0PeAUiZa58vtd\n7Sxn+BVO2nVw637VSEtPsJgUrSMGVrsamZZbrgjg4NCyX5n+33+5g3TH1OZy\ngzyUWrfGJ8krfI3Ztl9GAQH9md2P8aQ73wfQQC8bvmFSbZeEWVsu+hzLD1RJ\nyRbYUxPLJmBBv1KJmLTgtPMYIvbIB/+9QxHwF1+7qHH0rBqKRhi4mVJcEykl\n5mq2\r\n=8ucW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"4dedab857724d2ea8dfce7ecf8498d039467fccd","scripts":{"test":"node ./build/gen-resources.js && standard --fix '**/*.js' 'bin/**/*' && nyc ./node_modules/mocha/bin/mocha 'lib/**/*.test.js' 'bin/**/*.test.js'","coverage":"node -e \"require('opn')('coverage/lcov-report/index.html')\"","preversion":"npm test","postversion":"git push --follow-tags"},"_npmUser":{"name":"neonphog","email":"neonphog@neonphog.com"},"standard":{"env":{"mocha":true}},"repository":{"url":"git+https://github.com/holochain/dna-to-openapi.git","type":"git"},"_npmVersion":"6.1.0","description":"given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation","directories":{"lib":"lib"},"_nodeVersion":"8.11.1","dependencies":{"yargs":"^11.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^12.0.2","opn":"^5.3.0","tmp":"0.0.33","chai":"^4.1.2","mocha":"^5.2.0","standard":"^11.0.1","swagger-ui-dist":"3.16.0"},"_npmOperationalInternal":{"tmp":"tmp/dna-to-openapi_0.2.0_1529960827517_0.6424209843334125","host":"s3://npm-registry-packages"}},"0.2.1":{"name":"@holochain/dna-to-openapi","version":"0.2.1","keywords":["holo","holochain","openapi","blockchain","api","documentation"],"license":"Apache-2.0","_id":"@holochain/dna-to-openapi@0.2.1","maintainers":[{"name":"connoropolous","email":"connorturland@gmail.com"},{"name":"neonphog","email":"neonphog@neonphog.com"},{"name":"philipbeadle","email":"philip.beadle@live.com.au"}],"homepage":"https://github.com/holochain/dna-to-openapi#readme","bugs":{"url":"https://github.com/holochain/dna-to-openapi/issues"},"bin":{"dna-to-openapi":"./bin/dna-to-openapi"},"nyc":{"all":true,"lines":80,"include":["./lib/**/*.js"],"branches":80,"per-file":false,"reporter":["lcov","text-summary"],"functions":80,"statements":80,"check-coverage":true},"dist":{"shasum":"cd922788cb2913f1fc55ca42d2ba393440a1daaf","tarball":"https://registry.npmjs.org/@holochain/dna-to-openapi/-/dna-to-openapi-0.2.1.tgz","fileCount":20,"integrity":"sha512-dC4THigYN9laP1EO9EPnu25Mj45dWJ1q2o7CQDQiB2dYI+76Pk3nVL9rUR6GtgxuWYckMAAqG+iGigG5PXvTWQ==","signatures":[{"sig":"MEYCIQDpT41obL3hLoXev7LAqLi2u4Eo2dqW5xuDaw8wZi0MWwIhAPdRoLNWSQse6VqFJEwdJYvqfb6I3H3dkCQa2k18D2wU","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":2140835,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbNUFbCRA9TVsSAnZWagAAoRsP/jqsoFeD1VQmrvkzlY0g\na5PBCws5JQfy2mlAzt3WS4ddvdMe0CL4XHGiQ0JceFxFS7Q30LwAi3T+BGPG\nw2+JTFB5ERMfxoG+dgtQ3IFwwj7p4MxPzYv05YSIoW8tHZea5uthxoVDGQZi\nBxseUUS1saMzg9mA2vOGDF2EVx4AFs89uS3p2ooH1Ra6ZbfGqJms+2zBq9m6\n1ErXYCvGAgXqOfOWN8ZLJwhhCQj/Febv6BD73xYUHzMRYeTFnee2gDFMUtnk\nrUglm7/iHQQNnVkMTBwbeEmuvquCTfQE0aQlX8lRgUyxLqpWcS/EeMZXDkAJ\nq0OCtmvvP/MIxa98CzPgWK85bNDwBgeWXdgF3roPJpFJTjw0xNKdnypu4TiI\nHfM/6QK9mS8niYyJx3UCREO4gjsTq2ibpLMcXPg0/gWcxmaq/eL8TGSGC3iN\nwEIpkRQi31qVaiG1lTG/4PonVqteWoRey38spnngxVoi3dw+6JoiuUrath9k\n4ph/+Kz5tuu1bYNDIKdna1DRxXMXm3FmoHFH5syFitDZCM/YEoC3kqEVL/+S\nIZHg/HaVxkcAnIsWjMb5YmKzP51kt9Zd64zrOdM7O51t5hz7O1ab6/1qHe7s\nVfeGpLVgL6MjC2r7o4H/eHYv4uhZwwB0u7Gii5g6fk17MBZm4fVaSjuJpozb\nkDzF\r\n=LCqC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"77ca320b981e78b06457647075c27c03fdc77e8d","scripts":{"test":"node ./build/gen-resources.js && standard --fix '**/*.js' 'bin/**/*' && nyc ./node_modules/mocha/bin/mocha 'lib/**/*.test.js' 'bin/**/*.test.js'","coverage":"node -e \"require('opn')('coverage/lcov-report/index.html')\"","preversion":"npm test","postversion":"git push --follow-tags"},"_npmUser":{"name":"neonphog","email":"neonphog@neonphog.com"},"standard":{"env":{"mocha":true}},"repository":{"url":"git+https://github.com/holochain/dna-to-openapi.git","type":"git"},"_npmVersion":"5.6.0","description":"given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation","directories":{"lib":"lib"},"_nodeVersion":"8.11.3","dependencies":{"yargs":"^11.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"^12.0.2","opn":"^5.3.0","tmp":"0.0.33","chai":"^4.1.2","mocha":"^5.2.0","standard":"^11.0.1","swagger-ui-dist":"3.17.1"},"_npmOperationalInternal":{"tmp":"tmp/dna-to-openapi_0.2.1_1530216794839_0.019907992000797847","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-06-05T15:44:02.892Z","modified":"2026-06-08T18:52:15.531Z","0.0.3":"2018-06-05T15:44:03.388Z","0.1.0":"2018-06-05T17:48:27.078Z","0.2.0":"2018-06-25T21:07:07.596Z","0.2.1":"2018-06-28T20:13:15.019Z"},"bugs":{"url":"https://github.com/holochain/dna-to-openapi/issues"},"license":"Apache-2.0","homepage":"https://github.com/holochain/dna-to-openapi#readme","keywords":["holo","holochain","openapi","blockchain","api","documentation"],"repository":{"url":"git+https://github.com/holochain/dna-to-openapi.git","type":"git"},"description":"given holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation","maintainers":[{"email":"eric@harris-braun.com","name":"zippy314"},{"email":"joelulahanna@gmail.com","name":"zo-el"},{"email":"jost.schulte@protonmail.com","name":"jost-s"},{"email":"matthme@protonmail.com","name":"matthme"},{"email":"greatdjonfire@hotmail.co.uk","name":"thetasinner"},{"email":"christian.visintin@veeso.dev","name":"veeso"},{"email":"cdunster@proton.me","name":"callum.dunster"},{"email":"matt@buildyourweb.app","name":"mattyg"}],"readme":"# dna-to-openapi\n\ngiven holochain dna, generate a swagger / openapi spec file / static swagger-ui html documentation\n\n## usage\n\n### commandline\n\n`$` `npm install -g @holochain/dna-to-openapi`\n\n`$` `dna-to-openapi -h`\n\n```\nUsage dna-to-openapi [options]\n\nOptions:\n  -p, --path     specify a path (otherwise \".\")\n  -s, --spec     generates an open-api spec file (\"-\" for stdout)\n  -d, --doc      generates a static swagger-ui html doc (\"-\" for stdout)\n  -h, --help     Show help                                             [boolean]\n  -v, --version  Show version number                                   [boolean]\n\nExamples:\n  dna-to-openapi                            lints the given holo app / dna\n  dna-to-openapi --path <path>              to specify a path (otherwise \".\")\n  dna-to-openapi --spec <spec-file.json>    generates an open-api spec\n  dna-to-openapi --doc <api-doc.html>       generates static swagger-ui html doc\n  dna-to-openapi --spec <spec-file.json>    does both\n  --doc <api-doc.html>\n```\n\n### as a library\n\n```javascript\nconst dna = require('@holochain/dna-to-openapi')\n\n// 1 - lint\nconst lintResults = dna.lint(dnaJsonObject, schemasObject)\n\n// if there are errors (lintResults.errors), abort here.\n// generating a spec file with lint errors may not work\nif (lintResults.errors.length > 0) {\n  process.exit(1)\n}\n\n// 2 - generate openapi spec\nconst specJson = dna.convert(dnaJsonObject, schemasObject)\n\n// 3 - generate swagger-ui html\nconst swaggerHtml = dna.genDocs(specJson)\n```\n","readmeFilename":"README.md"}