UNPKG

@adobe/jsonschema2md

Version:

Validate and document complex JSON Schemas the easy way.

756 lines (377 loc) 39.5 kB
## [8.0.11](https://github.com/adobe/jsonschema2md/compare/v8.0.10...v8.0.11) (2026-03-23) ### Bug Fixes * **deps:** update external fixes ([#716](https://github.com/adobe/jsonschema2md/issues/716)) ([bb4188b](https://github.com/adobe/jsonschema2md/commit/bb4188b0630f2618d94a5c6a2a97246224b0de0a)) ## [8.0.10](https://github.com/adobe/jsonschema2md/compare/v8.0.9...v8.0.10) (2026-01-05) ### Bug Fixes * **deps:** update dependency fs-extra to v11.3.3 ([#698](https://github.com/adobe/jsonschema2md/issues/698)) ([f569857](https://github.com/adobe/jsonschema2md/commit/f569857b9a01013e8df996f72591d37460691a80)) ## [8.0.9](https://github.com/adobe/jsonschema2md/compare/v8.0.8...v8.0.9) (2025-12-15) ### Bug Fixes * **deps:** update dependency readdirp to v5 ([9f135d9](https://github.com/adobe/jsonschema2md/commit/9f135d9681896f6718fee41224501a2aa0feeb95)) ## [8.0.8](https://github.com/adobe/jsonschema2md/compare/v8.0.7...v8.0.8) (2025-11-15) ### Bug Fixes * **deps:** update dependency js-yaml to v4.1.1 [security] ([#686](https://github.com/adobe/jsonschema2md/issues/686)) ([595cb73](https://github.com/adobe/jsonschema2md/commit/595cb730223777ae895356d45a7c24a38ecebad6)) ## [8.0.7](https://github.com/adobe/jsonschema2md/compare/v8.0.6...v8.0.7) (2025-10-17) ### Bug Fixes * add missing GitHub Actions permissions for semantic-release ([#675](https://github.com/adobe/jsonschema2md/issues/675)) ([73f181f](https://github.com/adobe/jsonschema2md/commit/73f181fa9b48c758201ee19e9d0bc6102d10006d)) * update semantic-release to v25 and node to 24.x for OIDC ([8cf947b](https://github.com/adobe/jsonschema2md/commit/8cf947b4db571192eb5d7ce23d7d118edc7d8708)) ## [8.0.6](https://github.com/adobe/jsonschema2md/compare/v8.0.5...v8.0.6) (2025-09-30) ### Bug Fixes * **deps:** update external fixes ([#669](https://github.com/adobe/jsonschema2md/issues/669)) ([0d5265c](https://github.com/adobe/jsonschema2md/commit/0d5265c91ad8f76295f46e6164ede5d34a222128)) ## [8.0.5](https://github.com/adobe/jsonschema2md/compare/v8.0.4...v8.0.5) (2025-08-11) ### Bug Fixes * **deps:** update external fixes ([#658](https://github.com/adobe/jsonschema2md/issues/658)) ([7298762](https://github.com/adobe/jsonschema2md/commit/729876286dc368d5b0a4ee7e315946362c03e45c)) ## [8.0.4](https://github.com/adobe/jsonschema2md/compare/v8.0.3...v8.0.4) (2025-07-23) ### Bug Fixes * **markdownBuilder:** boolean defaults didn't render when the default was false ([#656](https://github.com/adobe/jsonschema2md/issues/656)) ([fb87124](https://github.com/adobe/jsonschema2md/commit/fb87124fb384e36678bb09e0c13b857f3b9a4aa9)) ## [8.0.3](https://github.com/adobe/jsonschema2md/compare/v8.0.2...v8.0.3) (2025-06-18) ### Bug Fixes * **deps:** update external fixes ([#625](https://github.com/adobe/jsonschema2md/issues/625)) ([2f05d79](https://github.com/adobe/jsonschema2md/commit/2f05d7908e2a014e7e1d5fcf0e598b181fb5361c)) * **deps:** update external fixes ([#628](https://github.com/adobe/jsonschema2md/issues/628)) ([40d6a3e](https://github.com/adobe/jsonschema2md/commit/40d6a3e364891dbc01aaef646d163cf272b4adc5)) * **deps:** update external major (major) ([#604](https://github.com/adobe/jsonschema2md/issues/604)) ([8d7af7c](https://github.com/adobe/jsonschema2md/commit/8d7af7cce0f97767e914c2d0849e1f2eb79d8547)) * release ([d18c15c](https://github.com/adobe/jsonschema2md/commit/d18c15c5a3868a8a6d3b74fd2acc8c80e624536c)) * release ([9e0a69e](https://github.com/adobe/jsonschema2md/commit/9e0a69e4031857a522d1fc95741b9b015ca13fd6)) * release ([5f6b431](https://github.com/adobe/jsonschema2md/commit/5f6b431482b44e44661837c2ce33d4e92875906a)) * release ([1b002a8](https://github.com/adobe/jsonschema2md/commit/1b002a820e2efb0edd0c47377cc54dec06cbea68)) ## [8.0.2](https://github.com/adobe/jsonschema2md/compare/v8.0.1...v8.0.2) (2024-04-09) ### Bug Fixes * remove helix-log dependency ([#579](https://github.com/adobe/jsonschema2md/issues/579)) ([9fbfdf9](https://github.com/adobe/jsonschema2md/commit/9fbfdf9726c512c4338c47bafef02347f1761372)) ## [8.0.1](https://github.com/adobe/jsonschema2md/compare/v8.0.0...v8.0.1) (2024-03-25) ### Bug Fixes * **deps:** update external dependencies ([51be972](https://github.com/adobe/jsonschema2md/commit/51be972b9be85852e9a1ee2f9b7e5b7a86351375)) # [8.0.0](https://github.com/adobe/jsonschema2md/compare/v7.1.6...v8.0.0) (2024-03-25) ### Build System * require node 18 ([3b74f4f](https://github.com/adobe/jsonschema2md/commit/3b74f4f31fc16d28c9a4a8f317cdd1beb2242d7e)) ### BREAKING CHANGES * requires node 18 ## [7.1.6](https://github.com/adobe/jsonschema2md/compare/v7.1.5...v7.1.6) (2024-03-25) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v6.0.1 ([b54415a](https://github.com/adobe/jsonschema2md/commit/b54415a0ae4a66a8ec5da9d433403cf46b0cf351)) * **deps:** update external fixes ([f515169](https://github.com/adobe/jsonschema2md/commit/f5151691a394c139f07ecaf8ec465e71dba49631)) * **deps:** update external fixes ([e23d8f0](https://github.com/adobe/jsonschema2md/commit/e23d8f01666fedc12442fa2f9bab660c5aa58d8a)) * **deps:** update external major ([#516](https://github.com/adobe/jsonschema2md/issues/516)) ([d7d72e6](https://github.com/adobe/jsonschema2md/commit/d7d72e61e2b65f0a790b8945d756082bf2fd3bcf)) ## [7.1.5](https://github.com/adobe/jsonschema2md/compare/v7.1.4...v7.1.5) (2022-12-12) ### Bug Fixes * fix typo in 'any of the following' text ([d7039b9](https://github.com/adobe/jsonschema2md/commit/d7039b9a7a636262c3c6ef86b34d0924329f49f5)) ## [7.1.4](https://github.com/adobe/jsonschema2md/compare/v7.1.3...v7.1.4) (2022-11-29) ### Bug Fixes * **deps:** update dependency fs-extra to v11 ([291515e](https://github.com/adobe/jsonschema2md/commit/291515edde6791c1502359a30a336671cbcbe608)) ## [7.1.3](https://github.com/adobe/jsonschema2md/compare/v7.1.2...v7.1.3) (2022-11-14) ### Bug Fixes * **markdown-builder:** guard against `enum` being not an array ([aa46ac4](https://github.com/adobe/jsonschema2md/commit/aa46ac4b4ed5d2c1641bec41b78ec04e1f83944b)), closes [#458](https://github.com/adobe/jsonschema2md/issues/458) ## [7.1.2](https://github.com/adobe/jsonschema2md/compare/v7.1.1...v7.1.2) (2022-10-06) ### Bug Fixes * **schemaproxy.js:** reuse previously proxied subschemas to fix max call stack size exceeded error ([1388449](https://github.com/adobe/jsonschema2md/commit/13884491df4c9ecc694f3881e40c1861f7acfdf8)), closes [/github.com/adobe/jsonschema2md/issues/252#issuecomment-806067867](https://github.com//github.com/adobe/jsonschema2md/issues/252/issues/issuecomment-806067867) [#252](https://github.com/adobe/jsonschema2md/issues/252) ## [7.1.1](https://github.com/adobe/jsonschema2md/compare/v7.1.0...v7.1.1) (2022-05-19) ### Bug Fixes * **i18n:** align Dutch locale name with standard pattern ([d940cd4](https://github.com/adobe/jsonschema2md/commit/d940cd4114a04f16e3a41db99b095b40e58e4813)), closes [#426](https://github.com/adobe/jsonschema2md/issues/426) * **i18n:** dutch locale available as command line option ([e8c9304](https://github.com/adobe/jsonschema2md/commit/e8c93048191394e53d2ab823f2b4489e843fbc40)), closes [#426](https://github.com/adobe/jsonschema2md/issues/426) * **i18n:** support Dutch locale as command line option ([0c0fbbd](https://github.com/adobe/jsonschema2md/commit/0c0fbbdf1e668441e330d9f065a43580e3325be1)) # [7.1.0](https://github.com/adobe/jsonschema2md/compare/v7.0.1...v7.1.0) (2022-05-19) ### Features * **i18n:** add Dutch translation ([0556392](https://github.com/adobe/jsonschema2md/commit/05563924bb5d63d8ff45315f39642d3e4170d172)), closes [#425](https://github.com/adobe/jsonschema2md/issues/425) ## [7.0.1](https://github.com/adobe/jsonschema2md/compare/v7.0.0...v7.0.1) (2022-05-19) ### Bug Fixes * **deps:** update dependency fs-extra to v10.1.0 ([#417](https://github.com/adobe/jsonschema2md/issues/417)) ([ba2e2e5](https://github.com/adobe/jsonschema2md/commit/ba2e2e58529c269bad63c11ec8f9500a3a997779)) * **package:** bump minimum node version to 14 ([f26283e](https://github.com/adobe/jsonschema2md/commit/f26283e682c0e6f3af4f9dff2ecfea5ca158cc3e)) # [7.0.0](https://github.com/adobe/jsonschema2md/compare/v6.1.4...v7.0.0) (2022-02-14) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v6 ([#363](https://github.com/adobe/jsonschema2md/issues/363)) ([6298ed2](https://github.com/adobe/jsonschema2md/commit/6298ed2808d4797429d907159c762ac79d19627b)) * **index:** remove reference to single input file ([7324427](https://github.com/adobe/jsonschema2md/commit/732442777d067e6a9091a6af50e21fcfca9fbd47)), closes [#386](https://github.com/adobe/jsonschema2md/issues/386) * **symbols:** tweak exports ([d31ab23](https://github.com/adobe/jsonschema2md/commit/d31ab239385cbe51eede6ff794fdfa58d7109717)) * **tests:** use fileToURLPath for dirname ([352d032](https://github.com/adobe/jsonschema2md/commit/352d032dccbc16e094359ae7e0d6d44e8ffd7863)) ### Code Refactoring * use esm ([a628755](https://github.com/adobe/jsonschema2md/commit/a6287553800fbe98396af193ebf0a56ca3cabde0)) ### Features * **api:** change shape of input and output data ([797090f](https://github.com/adobe/jsonschema2md/commit/797090fce370296ddb7c3c3fe3605330fcde02ff)) * **api:** create typescript declaration for api ([92426f9](https://github.com/adobe/jsonschema2md/commit/92426f9038c5b9e04fc6ea33fd34fbea7de6a29b)) ### BREAKING CHANGES * `jsonschema2md` now uses ECMAScript Modules (`import`/`export`) instead of CommonJS Modules (`require`/`exports`). This was driven by the desire to stay up to date with dependencies that switched to ESM. ## [6.1.4](https://github.com/adobe/jsonschema2md/compare/v6.1.3...v6.1.4) (2021-09-20) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5.0.5 ([#349](https://github.com/adobe/jsonschema2md/issues/349)) ([fbe1d49](https://github.com/adobe/jsonschema2md/commit/fbe1d4947f4df3030bbedf8da1577d41d24673e7)) ## [6.1.3](https://github.com/adobe/jsonschema2md/compare/v6.1.2...v6.1.3) (2021-09-02) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5.0.4 ([ba86b48](https://github.com/adobe/jsonschema2md/commit/ba86b48e51fec6d10ca08100417bedbd7a1758f9)) ## [6.1.2](https://github.com/adobe/jsonschema2md/compare/v6.1.1...v6.1.2) (2021-09-02) ### Bug Fixes * **readmebuilder:** reference twice for objects ([0bc9e68](https://github.com/adobe/jsonschema2md/commit/0bc9e686d3de4a60d06eacb36413568745758c63)) ## [6.1.1](https://github.com/adobe/jsonschema2md/compare/v6.1.0...v6.1.1) (2021-08-12) ### Bug Fixes * **markdownbuilder:** guard against empty definitions object ([f1b90c2](https://github.com/adobe/jsonschema2md/commit/f1b90c268bc97d22a65252c30c9b8a652cbe7246)), closes [#334](https://github.com/adobe/jsonschema2md/issues/334) # [6.1.0](https://github.com/adobe/jsonschema2md/compare/v6.0.3...v6.1.0) (2021-07-08) ### Bug Fixes * **i18n:** avoid passing non-string parameters to i18n engine ([abec736](https://github.com/adobe/jsonschema2md/commit/abec73689c490d147d7874d9cf593af901f49b5c)) ### Features * expose nodejs api ([cd7dd63](https://github.com/adobe/jsonschema2md/commit/cd7dd63de2eef0a13859aec9c4b1ca6d5045d229)) ## [6.0.3](https://github.com/adobe/jsonschema2md/compare/v6.0.2...v6.0.3) (2021-05-04) ### Bug Fixes * **deps:** update external major ([#305](https://github.com/adobe/jsonschema2md/issues/305)) ([5408a41](https://github.com/adobe/jsonschema2md/commit/5408a4182383b2d817e7d282e1c5d4c446a01d6c)) * **yargs:** revert to 16.2.0 ([0638340](https://github.com/adobe/jsonschema2md/commit/0638340ceb23eb6f741cb4312b2ebb35d09ecff4)) ## [6.0.2](https://github.com/adobe/jsonschema2md/compare/v6.0.1...v6.0.2) (2021-04-17) ### Bug Fixes * **deps:** update external fixes ([32bcef6](https://github.com/adobe/jsonschema2md/commit/32bcef6ce11448373e0e7d7c06b0ad541b42828b)) ## [6.0.1](https://github.com/adobe/jsonschema2md/compare/v6.0.0...v6.0.1) (2021-04-12) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5.0.3 ([#299](https://github.com/adobe/jsonschema2md/issues/299)) ([b3bc372](https://github.com/adobe/jsonschema2md/commit/b3bc372f6a4d7e1a8266e3409124194724fc5b78)) # [6.0.0](https://github.com/adobe/jsonschema2md/compare/v5.0.7...v6.0.0) (2021-04-04) ### Bug Fixes * **lib/traverseschema.js:** filter out skippable keywords based on parent's type ([0f75837](https://github.com/adobe/jsonschema2md/commit/0f7583706f61faf4e933359d73664890779fcd80)), closes [#282](https://github.com/adobe/jsonschema2md/issues/282) ### BREAKING CHANGES * **lib/traverseschema.js:** If schema contained 'properties', 'required' or 'examples' as a part of JSON schema (i.e. it was described as 'properties' within an object of 'object' type), these will be included into output. ## [5.0.7](https://github.com/adobe/jsonschema2md/compare/v5.0.6...v5.0.7) (2021-04-02) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5.0.2 ([040a495](https://github.com/adobe/jsonschema2md/commit/040a495ed085f8150682b8129d71a3dacbe3f31a)) ## [5.0.6](https://github.com/adobe/jsonschema2md/compare/v5.0.5...v5.0.6) (2021-04-02) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5.0.1 ([0017876](https://github.com/adobe/jsonschema2md/commit/0017876e77a6dedfb226ef01bbf03fd3d043c72a)) ## [5.0.5](https://github.com/adobe/jsonschema2md/compare/v5.0.4...v5.0.5) (2021-03-20) ### Bug Fixes * **deps:** update dependency readdirp to v3.6.0 ([47a37dc](https://github.com/adobe/jsonschema2md/commit/47a37dc96c93517262cb4e518bdfc87ce585edd6)) ## [5.0.4](https://github.com/adobe/jsonschema2md/compare/v5.0.3...v5.0.4) (2021-03-06) ### Bug Fixes * **deps:** update external fixes ([d409140](https://github.com/adobe/jsonschema2md/commit/d4091408c019f40c5f40e2d46dd85aba7b6fc112)) ## [5.0.3](https://github.com/adobe/jsonschema2md/compare/v5.0.2...v5.0.3) (2021-02-25) ### Bug Fixes * **deps:** update dependency @adobe/helix-log to v5 ([#285](https://github.com/adobe/jsonschema2md/issues/285)) ([ca21fe4](https://github.com/adobe/jsonschema2md/commit/ca21fe4d77665231aa493ab4f924e8c802e9efcf)) ## [5.0.2](https://github.com/adobe/jsonschema2md/compare/v5.0.1...v5.0.2) (2021-01-30) ### Bug Fixes * **lib/markdownBuilder.js:** use simpletitle for makeproperties ([d2100c6](https://github.com/adobe/jsonschema2md/commit/d2100c61ccc76307f839179a11931ca99d2e79bd)) ## [5.0.1](https://github.com/adobe/jsonschema2md/compare/v5.0.0...v5.0.1) (2021-01-25) ### Bug Fixes * **deps:** update external fixes ([48ed197](https://github.com/adobe/jsonschema2md/commit/48ed1979814b78d0a0e9c8e888e7ca7df711079f)) # [5.0.0](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v5.0.0) (2021-01-21) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092)) * **deps:** update dependency js-yaml to v4 ([2dbca6f](https://github.com/adobe/jsonschema2md/commit/2dbca6ff7d29935449d237ce9e7bdbe1cb676778)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) * **traverseschema.js:** skip generating files for certain keywords in the schema ([fc50969](https://github.com/adobe/jsonschema2md/commit/fc50969426fd2ed0b55752f6c58d9246a22e309c)) ### BREAKING CHANGES * **traverseschema.js:** The extranious files, if they have some other value, will not be generated and there is no mechanism to continue to g ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2021-01-21) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092)) * **deps:** update dependency js-yaml to v4 ([2dbca6f](https://github.com/adobe/jsonschema2md/commit/2dbca6ff7d29935449d237ce9e7bdbe1cb676778)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2021-01-02) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-19) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **deps:** update dependency @adobe/helix-log to v4.5.3 ([19f7ab4](https://github.com/adobe/jsonschema2md/commit/19f7ab42a3ca827f3627859ee675f77d80f7a092)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-15) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.2](https://github.com/adobe/jsonschema2md/compare/v4.2.1...v4.2.2) (2020-12-14) ### Bug Fixes * **deps:** bump semantic-release versions ([44cc702](https://github.com/adobe/jsonschema2md/commit/44cc70297ee393ead5c170b1daab7ea724cc5a2c)) * **deps:** npm audit fix ([24a577e](https://github.com/adobe/jsonschema2md/commit/24a577ef7caa35523182710f17c7dfa9e2ccced3)) * **schemaproxy.js:** fix resolving $refs that are file references ([c6adf01](https://github.com/adobe/jsonschema2md/commit/c6adf012c5d17bfb5507a6345dc3153a7d588894)), closes [#92](https://github.com/adobe/jsonschema2md/issues/92) ## [4.2.1](https://github.com/adobe/jsonschema2md/compare/v4.2.0...v4.2.1) (2020-10-21) ### Bug Fixes * **lib/markdownbuilder.js:** propTable property anchor link generated with github-slugger ([9883b8f](https://github.com/adobe/jsonschema2md/commit/9883b8f)) # [4.2.0](https://github.com/adobe/jsonschema2md/compare/v4.1.6...v4.2.0) (2020-09-01) ### Features * **markdownbuilder:** create an option to skip any property in markdown [#243](https://github.com/adobe/jsonschema2md/issues/243) ([56b7a2f](https://github.com/adobe/jsonschema2md/commit/56b7a2f)) ## [4.1.6](https://github.com/adobe/jsonschema2md/compare/v4.1.5...v4.1.6) (2020-07-31) ### Bug Fixes * **markdown:** correcly show type of nullable types in header ([53c1a0b](https://github.com/adobe/jsonschema2md/commit/53c1a0b)), closes [#237](https://github.com/adobe/jsonschema2md/issues/237) ## [4.1.5](https://github.com/adobe/jsonschema2md/compare/v4.1.4...v4.1.5) (2020-06-22) ### Bug Fixes * **deps:** npm audit fix ([2be8a58](https://github.com/adobe/jsonschema2md/commit/2be8a58)) * **markdown:** avoid ambiguities around property names ([a4543c4](https://github.com/adobe/jsonschema2md/commit/a4543c4)), closes [#232](https://github.com/adobe/jsonschema2md/issues/232) ## [4.1.4](https://github.com/adobe/jsonschema2md/compare/v4.1.3...v4.1.4) (2020-06-22) ### Bug Fixes * definition object defintions based on proplist structure ([2fb9fc5](https://github.com/adobe/jsonschema2md/commit/2fb9fc5)), closes [#228](https://github.com/adobe/jsonschema2md/issues/228) ## [4.1.3](https://github.com/adobe/jsonschema2md/compare/v4.1.2...v4.1.3) (2020-06-04) ### Bug Fixes * moved definitions to bottom of output file ([1b27fff](https://github.com/adobe/jsonschema2md/commit/1b27fff)), closes [#226](https://github.com/adobe/jsonschema2md/issues/226) ## [4.1.2](https://github.com/adobe/jsonschema2md/compare/v4.1.1...v4.1.2) (2020-04-23) ### Bug Fixes * **lib/index.js:** made -h/--header a boolean arg ([5ba2719](https://github.com/adobe/jsonschema2md/commit/5ba2719)), closes [#209](https://github.com/adobe/jsonschema2md/issues/209) ## [4.1.1](https://github.com/adobe/jsonschema2md/compare/v4.1.0...v4.1.1) (2020-04-14) ### Bug Fixes * **deps:** npm audit fix ([b13ab35](https://github.com/adobe/jsonschema2md/commit/b13ab35)) * **enum:** fix doc generation for enums that contain arrays ([667a106](https://github.com/adobe/jsonschema2md/commit/667a106)), closes [#219](https://github.com/adobe/jsonschema2md/issues/219) # [4.1.0](https://github.com/adobe/jsonschema2md/compare/v4.0.13...v4.1.0) (2020-03-05) ### Features * **examples:** enable examples to be formatted in YAML using command line option `-f yaml` ([01119ba](https://github.com/adobe/jsonschema2md/commit/01119ba)) ## [4.0.13](https://github.com/adobe/jsonschema2md/compare/v4.0.12...v4.0.13) (2020-01-31) ### Bug Fixes * **i18n:** update German translations ([8cf38e4](https://github.com/adobe/jsonschema2md/commit/8cf38e4)) ## [4.0.12](https://github.com/adobe/jsonschema2md/compare/v4.0.11...v4.0.12) (2020-01-30) ### Bug Fixes * dont use backslash for URLs on windows ([5149522](https://github.com/adobe/jsonschema2md/commit/5149522)), closes [#211](https://github.com/adobe/jsonschema2md/issues/211) ## [4.0.11](https://github.com/adobe/jsonschema2md/compare/v4.0.10...v4.0.11) (2020-01-26) ### Bug Fixes * **package:** fix & clean up dependencies ([890e86d](https://github.com/adobe/jsonschema2md/commit/890e86d)), closes [#210](https://github.com/adobe/jsonschema2md/issues/210) ## [4.0.10](https://github.com/adobe/jsonschema2md/compare/v4.0.9...v4.0.10) (2020-01-21) ### Bug Fixes * **deps:** pin es2015-i18n-tag version ([c531b50](https://github.com/adobe/jsonschema2md/commit/c531b50)), closes [#207](https://github.com/adobe/jsonschema2md/issues/207) ## [4.0.9](https://github.com/adobe/jsonschema2md/compare/v4.0.8...v4.0.9) (2020-01-20) ### Bug Fixes * **markdown:** prevent unescaped objects in markdown AST ([87d709a](https://github.com/adobe/jsonschema2md/commit/87d709a)), closes [#201](https://github.com/adobe/jsonschema2md/issues/201) ## [4.0.8](https://github.com/adobe/jsonschema2md/compare/v4.0.7...v4.0.8) (2020-01-15) ### Bug Fixes * **index.js:** -x flag is not working properly for the suppression case ([d929d9b](https://github.com/adobe/jsonschema2md/commit/d929d9b)) ## [4.0.7](https://github.com/adobe/jsonschema2md/compare/v4.0.6...v4.0.7) (2020-01-14) ### Bug Fixes * **markdown:** increase robustness when using format as a property name ([cda0bec](https://github.com/adobe/jsonschema2md/commit/cda0bec)), closes [#198](https://github.com/adobe/jsonschema2md/issues/198) ## [4.0.6](https://github.com/adobe/jsonschema2md/compare/v4.0.5...v4.0.6) (2020-01-14) ### Bug Fixes * **markdown:** catch error when using `title` as a property name ([b4b8855](https://github.com/adobe/jsonschema2md/commit/b4b8855)) ## [4.0.5](https://github.com/adobe/jsonschema2md/compare/v4.0.4...v4.0.5) (2020-01-14) ### Bug Fixes * **slugger:** fix slugger crash due to title property ([4f0ab31](https://github.com/adobe/jsonschema2md/commit/4f0ab31)), closes [#196](https://github.com/adobe/jsonschema2md/issues/196) ## [4.0.4](https://github.com/adobe/jsonschema2md/compare/v4.0.3...v4.0.4) (2020-01-14) ### Bug Fixes * **cli:** do not exit after creating readme.md ([cb7d012](https://github.com/adobe/jsonschema2md/commit/cb7d012)) * **cli:** make the -n or --no-readme option work again ([3c63c03](https://github.com/adobe/jsonschema2md/commit/3c63c03)) * **loader:** guard against endless wrapping ([dd1f7f6](https://github.com/adobe/jsonschema2md/commit/dd1f7f6)), closes [#194](https://github.com/adobe/jsonschema2md/issues/194) ## [4.0.3](https://github.com/adobe/jsonschema2md/compare/v4.0.2...v4.0.3) (2020-01-09) ### Bug Fixes * **schema:** do not recurse endlessly when writing cyclic schemas ([297f0d5](https://github.com/adobe/jsonschema2md/commit/297f0d5)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185) ## [4.0.2](https://github.com/adobe/jsonschema2md/compare/v4.0.1...v4.0.2) (2019-12-20) ### Bug Fixes * **cli:** fix `traverse` function when called from CLI ([f211375](https://github.com/adobe/jsonschema2md/commit/f211375)) ## [4.0.1](https://github.com/adobe/jsonschema2md/compare/v4.0.0...v4.0.1) (2019-12-20) ### Bug Fixes * **titles:** more robust handling of title generation for untitled schemas ([c546a28](https://github.com/adobe/jsonschema2md/commit/c546a28)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185) * **traversal:** fix endless loop in schema traversal ([af85c59](https://github.com/adobe/jsonschema2md/commit/af85c59)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185) # [4.0.0](https://github.com/adobe/jsonschema2md/compare/v3.3.1...v4.0.0) (2019-12-16) ### Bug Fixes * **i18n:** use correct file name format ([43a74f4](https://github.com/adobe/jsonschema2md/commit/43a74f4)) * **markdown:** constraint values can be zero now ([2e057fd](https://github.com/adobe/jsonschema2md/commit/2e057fd)) * **markdown:** handle null as a constant value ([e652e11](https://github.com/adobe/jsonschema2md/commit/e652e11)) * **proxy:** remove logging statements ([616a1d9](https://github.com/adobe/jsonschema2md/commit/616a1d9)) * **schemas:** remove references going nowhere ([2186142](https://github.com/adobe/jsonschema2md/commit/2186142)) ### Build System * **dependencies:** remove unused dependencies ([dbc9192](https://github.com/adobe/jsonschema2md/commit/dbc9192)) ### Code Refactoring * **cli:** remove bluebird, lodash, simplify arg parsing ([b6b1822](https://github.com/adobe/jsonschema2md/commit/b6b1822)) ### Continuous Integration * **test:** require node 10 ([ba4a947](https://github.com/adobe/jsonschema2md/commit/ba4a947)) ### Documentation * **changelog:** mention changes for v4 ([4dfe90c](https://github.com/adobe/jsonschema2md/commit/4dfe90c)), closes [#126](https://github.com/adobe/jsonschema2md/issues/126) [#174](https://github.com/adobe/jsonschema2md/issues/174) [#72](https://github.com/adobe/jsonschema2md/issues/72) [#73](https://github.com/adobe/jsonschema2md/issues/73) [#94](https://github.com/adobe/jsonschema2md/issues/94) [#52](https://github.com/adobe/jsonschema2md/issues/52) [#20](https://github.com/adobe/jsonschema2md/issues/20) [#125](https://github.com/adobe/jsonschema2md/issues/125) [#177](https://github.com/adobe/jsonschema2md/issues/177) [#34](https://github.com/adobe/jsonschema2md/issues/34) [#123](https://github.com/adobe/jsonschema2md/issues/123) ### Features * **cli:** generate JSON schema output ([dd18f3b](https://github.com/adobe/jsonschema2md/commit/dd18f3b)), closes [#176](https://github.com/adobe/jsonschema2md/issues/176) * **formats:** add support for formats: json-pointer, relative-json-pointer, regex, and uri-template ([689c158](https://github.com/adobe/jsonschema2md/commit/689c158)) * **i18n:** new internationalization system ([1a664de](https://github.com/adobe/jsonschema2md/commit/1a664de)) * **i18n:** provide complete en_US translation ([5eb0c89](https://github.com/adobe/jsonschema2md/commit/5eb0c89)) * **markdown:** add header surpression ([6225b9f](https://github.com/adobe/jsonschema2md/commit/6225b9f)) * **markdown:** add support for `default` keyword ([72a0fde](https://github.com/adobe/jsonschema2md/commit/72a0fde)) * **markdown:** add support for comments ([07bb52f](https://github.com/adobe/jsonschema2md/commit/07bb52f)) * **markdown:** add YAML frontmatter support ([4df92e6](https://github.com/adobe/jsonschema2md/commit/4df92e6)) * **markdown:** create and write markdown ([e521541](https://github.com/adobe/jsonschema2md/commit/e521541)) * **markdown:** generate additional detail ([cc07df2](https://github.com/adobe/jsonschema2md/commit/cc07df2)) * **markdown:** generate header again ([011427c](https://github.com/adobe/jsonschema2md/commit/011427c)) * **markdown:** generate some property details ([fa34cf1](https://github.com/adobe/jsonschema2md/commit/fa34cf1)) * **markdown:** generate type details ([c9f19e1](https://github.com/adobe/jsonschema2md/commit/c9f19e1)) * **markdown:** highlight keyword usage for documentation ([d35e4ed](https://github.com/adobe/jsonschema2md/commit/d35e4ed)), closes [#100](https://github.com/adobe/jsonschema2md/issues/100) * **markdown:** list nested schemas in README ([608674b](https://github.com/adobe/jsonschema2md/commit/608674b)) * **markdown:** list nested schemas in README ([87e8489](https://github.com/adobe/jsonschema2md/commit/87e8489)) * **markdown:** show examples ([c8e8dfa](https://github.com/adobe/jsonschema2md/commit/c8e8dfa)) * **markdown:** show extensibility and abstraction in header ([90a9a8e](https://github.com/adobe/jsonschema2md/commit/90a9a8e)) * **markdown:** show id and status in header ([08e1923](https://github.com/adobe/jsonschema2md/commit/08e1923)) * **markdown:** show id and status in header ([b6fcf53](https://github.com/adobe/jsonschema2md/commit/b6fcf53)) * **markdown:** show join types ([12af018](https://github.com/adobe/jsonschema2md/commit/12af018)) * **markdown:** show some info about properties, switch i18n library ([f8a32df](https://github.com/adobe/jsonschema2md/commit/f8a32df)) * **markdown:** show type, link, additional and custom properties in header ([eff129a](https://github.com/adobe/jsonschema2md/commit/eff129a)) * **markdown:** show value constraints ([515969c](https://github.com/adobe/jsonschema2md/commit/515969c)) * **markdown:** support item arrays and additionalItems ([c9fbcdf](https://github.com/adobe/jsonschema2md/commit/c9fbcdf)), closes [#31](https://github.com/adobe/jsonschema2md/issues/31) * **markdown:** support patternProperties and additionalProperties ([1386ee3](https://github.com/adobe/jsonschema2md/commit/1386ee3)), closes [#95](https://github.com/adobe/jsonschema2md/issues/95) [#180](https://github.com/adobe/jsonschema2md/issues/180) * **proxy:** generate meta information ([ac65ac6](https://github.com/adobe/jsonschema2md/commit/ac65ac6)) * **proxy:** generate slugs ([eacbf38](https://github.com/adobe/jsonschema2md/commit/eacbf38)) * **proxy:** resolve references ([4cea068](https://github.com/adobe/jsonschema2md/commit/4cea068)) * **readme:** generate readme again ([d6b9e5e](https://github.com/adobe/jsonschema2md/commit/d6b9e5e)) * **readme:** mention the most common schema version ([fc583d7](https://github.com/adobe/jsonschema2md/commit/fc583d7)) * **schema:** add full support for "A Vocabulary for the Contents of String-Encoded Data" ([96ca3a6](https://github.com/adobe/jsonschema2md/commit/96ca3a6)) * **schema:** add support for keyword `$defs` ([70b63c8](https://github.com/adobe/jsonschema2md/commit/70b63c8)) * **schema:** add support for keyword `deprecated` ([934b856](https://github.com/adobe/jsonschema2md/commit/934b856)) * **schema:** add support for readOnly and writeOnly schemas and properties ([7452882](https://github.com/adobe/jsonschema2md/commit/7452882)) ### BREAKING CHANGES * **changelog:** * **i18n:** The file format for the i18n files has changed You can now specify the language to use using `-l` and `jsonschema2md` will pick up the correct language configuration. * **test:** Node 8 is no longer supported * **dependencies:** Removes the JSON schema validation feature entirely * **cli:** Repaces lodash with ferrum, removed bluebird, changes the meaning of `--schema-out` or `-x` to be no longer relative to output dir The `--schema-out` or `-x` command line option is no longer relative to the output path (specified with `-o` or `--out`) --- # Note about Version 4.0 `jsonschema2md` v4.0.0 has been a major rewrite that changes output format, command line parameters, i18n templates in order to increase the [coverage of the JSON Schema specification](schemasupport.md) and to make the project more maintainable. The JSON Schema validation functionality has been dropped entirely, as it is easier to just use `ajv` for that directly. --- ## [3.3.1](https://github.com/adobe/jsonschema2md/compare/v3.3.0...v3.3.1) (2019-09-18) ### Bug Fixes * **package:** update @adobe/helix-log to version 2.0.0 ([33792f6](https://github.com/adobe/jsonschema2md/commit/33792f6)) # [3.3.0](https://github.com/adobe/jsonschema2md/compare/v3.2.0...v3.3.0) (2019-08-26) ### Features * allow display of custom attributes in the property description ([0634309](https://github.com/adobe/jsonschema2md/commit/0634309)), closes [#151](https://github.com/adobe/jsonschema2md/issues/151) # [3.2.0](https://github.com/adobe/jsonschema2md/compare/v3.1.2...v3.2.0) (2019-08-20) ### Features * disable header.ejs using console args ([104452f](https://github.com/adobe/jsonschema2md/commit/104452f)), closes [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) [#153](https://github.com/adobe/jsonschema2md/issues/153) ## [3.1.2](https://github.com/adobe/jsonschema2md/compare/v3.1.1...v3.1.2) (2019-08-07) ### Bug Fixes * always output POSIX paths ([3c1c42c](https://github.com/adobe/jsonschema2md/commit/3c1c42c)) * fix error logging from submodules ([dc634b2](https://github.com/adobe/jsonschema2md/commit/dc634b2)) ## [3.1.1](https://github.com/adobe/jsonschema2md/compare/v3.1.0...v3.1.1) (2019-07-31) ### Bug Fixes * **i18n init:** moved the i18n init part to the cli.js ([5e37d2d](https://github.com/adobe/jsonschema2md/commit/5e37d2d)), closes [#157](https://github.com/adobe/jsonschema2md/issues/157) * **markdownwriter.js:** use path function to resolve the path ([5fe7db2](https://github.com/adobe/jsonschema2md/commit/5fe7db2)), closes [#157](https://github.com/adobe/jsonschema2md/issues/157) # [3.1.0](https://github.com/adobe/jsonschema2md/compare/v3.0.1...v3.1.0) (2019-07-30) ### Features * **i18n:** enable localization of all strings, provide en as default language ([daa58a2](https://github.com/adobe/jsonschema2md/commit/daa58a2)), closes [#143](https://github.com/adobe/jsonschema2md/issues/143) ## [3.0.1](https://github.com/adobe/jsonschema2md/compare/v3.0.0...v3.0.1) (2019-07-29) ### Bug Fixes * **schema.js:** fix $ref not being resolved when nested deeper than once within an object ([6eb73c3](https://github.com/adobe/jsonschema2md/commit/6eb73c3)), closes [#155](https://github.com/adobe/jsonschema2md/issues/155) # [3.0.0](https://github.com/adobe/jsonschema2md/compare/v2.1.2...v3.0.0) (2019-07-24) ### Bug Fixes * **cli:** fix breaking changes to readdirp API ([5150f3f](https://github.com/adobe/jsonschema2md/commit/5150f3f)) * **package:** update readdirp to version 3.1.1 ([05cd51e](https://github.com/adobe/jsonschema2md/commit/05cd51e)), closes [#127](https://github.com/adobe/jsonschema2md/issues/127) ### Build System * **package:** require minimum node version: 8 ([a9ec935](https://github.com/adobe/jsonschema2md/commit/a9ec935)) ### BREAKING CHANGES * **package:** Node 7 and lower are no longer supported, Node 8 is now the minimum version ## [2.1.2](https://github.com/adobe/jsonschema2md/compare/v2.1.1...v2.1.2) (2019-07-19) ### Bug Fixes * Fix `$ref` within nested objects not generating correct markdown ([b8c9a49](https://github.com/adobe/jsonschema2md/commit/b8c9a49)), closes [#136](https://github.com/adobe/jsonschema2md/issues/136) ## [2.1.1](https://github.com/adobe/jsonschema2md/compare/v2.1.0...v2.1.1) (2019-05-29) ### Bug Fixes * **package:** update async to version 3.0.1 ([4ffa21e](https://github.com/adobe/jsonschema2md/commit/4ffa21e)) # [2.1.0](https://github.com/adobe/jsonschema2md/compare/v2.0.0...v2.1.0) (2019-04-30) ### Features * Apply prettier to generated markdown files for improved formatting ([0e8bde4](https://github.com/adobe/jsonschema2md/commit/0e8bde4)) # [2.0.0](https://github.com/adobe/jsonschema2md/compare/v1.0.0...v2.0.0) (2019-03-26) ### Bug Fixes * **release:** Fix release process ([6bf5a10](https://github.com/adobe/jsonschema2md/commit/6bf5a10)), closes [#109](https://github.com/adobe/jsonschema2md/issues/109) [#90](https://github.com/adobe/jsonschema2md/issues/90) ### BREAKING CHANGES * **release:** Major version bump # 1.0.0 (2019-03-18) ### Bug Fixes * **ci:** use node8 for releases ([9c2a186](https://github.com/adobe/jsonschema2md/commit/9c2a186))