UNPKG

14.7 kBMarkdownView Raw
1## [4.0.9](https://github.com/adobe/jsonschema2md/compare/v4.0.8...v4.0.9) (2020-01-20)
2
3
4### Bug Fixes
5
6* **markdown:** prevent unescaped objects in markdown AST ([87d709a](https://github.com/adobe/jsonschema2md/commit/87d709a)), closes [#201](https://github.com/adobe/jsonschema2md/issues/201)
7
8## [4.0.8](https://github.com/adobe/jsonschema2md/compare/v4.0.7...v4.0.8) (2020-01-15)
9
10
11### Bug Fixes
12
13* **index.js:** -x flag is not working properly for the suppression case ([d929d9b](https://github.com/adobe/jsonschema2md/commit/d929d9b))
14
15## [4.0.7](https://github.com/adobe/jsonschema2md/compare/v4.0.6...v4.0.7) (2020-01-14)
16
17
18### Bug Fixes
19
20* **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)
21
22## [4.0.6](https://github.com/adobe/jsonschema2md/compare/v4.0.5...v4.0.6) (2020-01-14)
23
24
25### Bug Fixes
26
27* **markdown:** catch error when using `title` as a property name ([b4b8855](https://github.com/adobe/jsonschema2md/commit/b4b8855))
28
29## [4.0.5](https://github.com/adobe/jsonschema2md/compare/v4.0.4...v4.0.5) (2020-01-14)
30
31
32### Bug Fixes
33
34* **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)
35
36## [4.0.4](https://github.com/adobe/jsonschema2md/compare/v4.0.3...v4.0.4) (2020-01-14)
37
38
39### Bug Fixes
40
41* **cli:** do not exit after creating readme.md ([cb7d012](https://github.com/adobe/jsonschema2md/commit/cb7d012))
42* **cli:** make the -n or --no-readme option work again ([3c63c03](https://github.com/adobe/jsonschema2md/commit/3c63c03))
43* **loader:** guard against endless wrapping ([dd1f7f6](https://github.com/adobe/jsonschema2md/commit/dd1f7f6)), closes [#194](https://github.com/adobe/jsonschema2md/issues/194)
44
45## [4.0.3](https://github.com/adobe/jsonschema2md/compare/v4.0.2...v4.0.3) (2020-01-09)
46
47
48### Bug Fixes
49
50* **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)
51
52## [4.0.2](https://github.com/adobe/jsonschema2md/compare/v4.0.1...v4.0.2) (2019-12-20)
53
54
55### Bug Fixes
56
57* **cli:** fix `traverse` function when called from CLI ([f211375](https://github.com/adobe/jsonschema2md/commit/f211375))
58
59## [4.0.1](https://github.com/adobe/jsonschema2md/compare/v4.0.0...v4.0.1) (2019-12-20)
60
61
62### Bug Fixes
63
64* **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)
65* **traversal:** fix endless loop in schema traversal ([af85c59](https://github.com/adobe/jsonschema2md/commit/af85c59)), closes [#185](https://github.com/adobe/jsonschema2md/issues/185)
66
67# [4.0.0](https://github.com/adobe/jsonschema2md/compare/v3.3.1...v4.0.0) (2019-12-16)
68
69
70### Bug Fixes
71
72* **i18n:** use correct file name format ([43a74f4](https://github.com/adobe/jsonschema2md/commit/43a74f4))
73* **markdown:** constraint values can be zero now ([2e057fd](https://github.com/adobe/jsonschema2md/commit/2e057fd))
74* **markdown:** handle null as a constant value ([e652e11](https://github.com/adobe/jsonschema2md/commit/e652e11))
75* **proxy:** remove logging statements ([616a1d9](https://github.com/adobe/jsonschema2md/commit/616a1d9))
76* **schemas:** remove references going nowhere ([2186142](https://github.com/adobe/jsonschema2md/commit/2186142))
77
78
79### Build System
80
81* **dependencies:** remove unused dependencies ([dbc9192](https://github.com/adobe/jsonschema2md/commit/dbc9192))
82
83
84### Code Refactoring
85
86* **cli:** remove bluebird, lodash, simplify arg parsing ([b6b1822](https://github.com/adobe/jsonschema2md/commit/b6b1822))
87
88
89### Continuous Integration
90
91* **test:** require node 10 ([ba4a947](https://github.com/adobe/jsonschema2md/commit/ba4a947))
92
93
94### Documentation
95
96* **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)
97
98
99### Features
100
101* **cli:** generate JSON schema output ([dd18f3b](https://github.com/adobe/jsonschema2md/commit/dd18f3b)), closes [#176](https://github.com/adobe/jsonschema2md/issues/176)
102* **formats:** add support for formats: json-pointer, relative-json-pointer, regex, and uri-template ([689c158](https://github.com/adobe/jsonschema2md/commit/689c158))
103* **i18n:** new internationalization system ([1a664de](https://github.com/adobe/jsonschema2md/commit/1a664de))
104* **i18n:** provide complete en_US translation ([5eb0c89](https://github.com/adobe/jsonschema2md/commit/5eb0c89))
105* **markdown:** add header surpression ([6225b9f](https://github.com/adobe/jsonschema2md/commit/6225b9f))
106* **markdown:** add support for `default` keyword ([72a0fde](https://github.com/adobe/jsonschema2md/commit/72a0fde))
107* **markdown:** add support for comments ([07bb52f](https://github.com/adobe/jsonschema2md/commit/07bb52f))
108* **markdown:** add YAML frontmatter support ([4df92e6](https://github.com/adobe/jsonschema2md/commit/4df92e6))
109* **markdown:** create and write markdown ([e521541](https://github.com/adobe/jsonschema2md/commit/e521541))
110* **markdown:** generate additional detail ([cc07df2](https://github.com/adobe/jsonschema2md/commit/cc07df2))
111* **markdown:** generate header again ([011427c](https://github.com/adobe/jsonschema2md/commit/011427c))
112* **markdown:** generate some property details ([fa34cf1](https://github.com/adobe/jsonschema2md/commit/fa34cf1))
113* **markdown:** generate type details ([c9f19e1](https://github.com/adobe/jsonschema2md/commit/c9f19e1))
114* **markdown:** highlight keyword usage for documentation ([d35e4ed](https://github.com/adobe/jsonschema2md/commit/d35e4ed)), closes [#100](https://github.com/adobe/jsonschema2md/issues/100)
115* **markdown:** list nested schemas in README ([608674b](https://github.com/adobe/jsonschema2md/commit/608674b))
116* **markdown:** list nested schemas in README ([87e8489](https://github.com/adobe/jsonschema2md/commit/87e8489))
117* **markdown:** show examples ([c8e8dfa](https://github.com/adobe/jsonschema2md/commit/c8e8dfa))
118* **markdown:** show extensibility and abstraction in header ([90a9a8e](https://github.com/adobe/jsonschema2md/commit/90a9a8e))
119* **markdown:** show id and status in header ([08e1923](https://github.com/adobe/jsonschema2md/commit/08e1923))
120* **markdown:** show id and status in header ([b6fcf53](https://github.com/adobe/jsonschema2md/commit/b6fcf53))
121* **markdown:** show join types ([12af018](https://github.com/adobe/jsonschema2md/commit/12af018))
122* **markdown:** show some info about properties, switch i18n library ([f8a32df](https://github.com/adobe/jsonschema2md/commit/f8a32df))
123* **markdown:** show type, link, additional and custom properties in header ([eff129a](https://github.com/adobe/jsonschema2md/commit/eff129a))
124* **markdown:** show value constraints ([515969c](https://github.com/adobe/jsonschema2md/commit/515969c))
125* **markdown:** support item arrays and additionalItems ([c9fbcdf](https://github.com/adobe/jsonschema2md/commit/c9fbcdf)), closes [#31](https://github.com/adobe/jsonschema2md/issues/31)
126* **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)
127* **proxy:** generate meta information ([ac65ac6](https://github.com/adobe/jsonschema2md/commit/ac65ac6))
128* **proxy:** generate slugs ([eacbf38](https://github.com/adobe/jsonschema2md/commit/eacbf38))
129* **proxy:** resolve references ([4cea068](https://github.com/adobe/jsonschema2md/commit/4cea068))
130* **readme:** generate readme again ([d6b9e5e](https://github.com/adobe/jsonschema2md/commit/d6b9e5e))
131* **readme:** mention the most common schema version ([fc583d7](https://github.com/adobe/jsonschema2md/commit/fc583d7))
132* **schema:** add full support for "A Vocabulary for the Contents of String-Encoded Data" ([96ca3a6](https://github.com/adobe/jsonschema2md/commit/96ca3a6))
133* **schema:** add support for keyword `$defs` ([70b63c8](https://github.com/adobe/jsonschema2md/commit/70b63c8))
134* **schema:** add support for keyword `deprecated` ([934b856](https://github.com/adobe/jsonschema2md/commit/934b856))
135* **schema:** add support for readOnly and writeOnly schemas and properties ([7452882](https://github.com/adobe/jsonschema2md/commit/7452882))
136
137
138### BREAKING CHANGES
139
140* **changelog:**
141* **i18n:** The file format for the i18n files has changed
142
143You can now specify the language to use using `-l` and `jsonschema2md` will pick up the correct language configuration.
144* **test:** Node 8 is no longer supported
145* **dependencies:** Removes the JSON schema validation feature entirely
146* **cli:** Repaces lodash with ferrum, removed bluebird, changes the meaning of `--schema-out` or `-x` to be no longer relative to output dir
147
148The `--schema-out` or `-x` command line option is no longer relative to the output path (specified with `-o` or `--out`)
149
150---
151
152# Note about Version 4.0
153
154`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.
155
156The JSON Schema validation functionality has been dropped entirely, as it is easier to just use `ajv` for that directly.
157
158---
159
160## [3.3.1](https://github.com/adobe/jsonschema2md/compare/v3.3.0...v3.3.1) (2019-09-18)
161
162
163### Bug Fixes
164
165* **package:** update @adobe/helix-log to version 2.0.0 ([33792f6](https://github.com/adobe/jsonschema2md/commit/33792f6))
166
167# [3.3.0](https://github.com/adobe/jsonschema2md/compare/v3.2.0...v3.3.0) (2019-08-26)
168
169
170### Features
171
172* 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)
173
174# [3.2.0](https://github.com/adobe/jsonschema2md/compare/v3.1.2...v3.2.0) (2019-08-20)
175
176
177### Features
178
179* 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)
180
181## [3.1.2](https://github.com/adobe/jsonschema2md/compare/v3.1.1...v3.1.2) (2019-08-07)
182
183
184### Bug Fixes
185
186* always output POSIX paths ([3c1c42c](https://github.com/adobe/jsonschema2md/commit/3c1c42c))
187* fix error logging from submodules ([dc634b2](https://github.com/adobe/jsonschema2md/commit/dc634b2))
188
189## [3.1.1](https://github.com/adobe/jsonschema2md/compare/v3.1.0...v3.1.1) (2019-07-31)
190
191
192### Bug Fixes
193
194* **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)
195* **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)
196
197# [3.1.0](https://github.com/adobe/jsonschema2md/compare/v3.0.1...v3.1.0) (2019-07-30)
198
199
200### Features
201
202* **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)
203
204## [3.0.1](https://github.com/adobe/jsonschema2md/compare/v3.0.0...v3.0.1) (2019-07-29)
205
206
207### Bug Fixes
208
209* **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)
210
211# [3.0.0](https://github.com/adobe/jsonschema2md/compare/v2.1.2...v3.0.0) (2019-07-24)
212
213
214### Bug Fixes
215
216* **cli:** fix breaking changes to readdirp API ([5150f3f](https://github.com/adobe/jsonschema2md/commit/5150f3f))
217* **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)
218
219
220### Build System
221
222* **package:** require minimum node version: 8 ([a9ec935](https://github.com/adobe/jsonschema2md/commit/a9ec935))
223
224
225### BREAKING CHANGES
226
227* **package:** Node 7 and lower are no longer supported, Node 8 is now the minimum version
228
229## [2.1.2](https://github.com/adobe/jsonschema2md/compare/v2.1.1...v2.1.2) (2019-07-19)
230
231
232### Bug Fixes
233
234* 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)
235
236## [2.1.1](https://github.com/adobe/jsonschema2md/compare/v2.1.0...v2.1.1) (2019-05-29)
237
238
239### Bug Fixes
240
241* **package:** update async to version 3.0.1 ([4ffa21e](https://github.com/adobe/jsonschema2md/commit/4ffa21e))
242
243# [2.1.0](https://github.com/adobe/jsonschema2md/compare/v2.0.0...v2.1.0) (2019-04-30)
244
245
246### Features
247
248* Apply prettier to generated markdown files for improved formatting ([0e8bde4](https://github.com/adobe/jsonschema2md/commit/0e8bde4))
249
250# [2.0.0](https://github.com/adobe/jsonschema2md/compare/v1.0.0...v2.0.0) (2019-03-26)
251
252
253### Bug Fixes
254
255* **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)
256
257
258### BREAKING CHANGES
259
260* **release:** Major version bump
261
262# 1.0.0 (2019-03-18)
263
264
265### Bug Fixes
266
267* **ci:** use node8 for releases ([9c2a186](https://github.com/adobe/jsonschema2md/commit/9c2a186))