jsonschema-markdown

Features

• Add support for nullable fields, add null to the type column on these cases. Fixes #19. (700ce08d)

Miscellaneous Tasks

• Update readme. (58acee0a)
• Update depencies (ef668912)

Features

• Add string format support and link to built-in formats documentation. (6b593bc4)

Miscellaneous Tasks

• Update dependencies, drop black dev dependency. (9942f0e3)

0.3.7 (2024/05/07)

Bug Fixes

• Add newline after properties table. (14c60733)
• Use reference in sub-schema titles. (3005c3a0)

Miscellaneous Tasks

• Update dependencies. (7fd491f4)

0.3.6 (2024/04/16)

Features

• Add new option to hide empty columns. (134125e9)

Miscellaneous Tasks

• Update dependencies. (94dc4174)

Testing

• Add multiple test scenarios, add automatic test generation with pre-commit hook. (c164bfaa)

0.3.5 (2024/04/11)

Bug Fixes

• Skip properties table if they don't exist (#16) (e67fc4fc)

0.3.4 (2024/04/04)

Features

• Add support for multipleOf on number properties. (181eba87)

Testing

• Add more tests. (76d0d99c)

Ci

• Publish built and source distributions. (65943d48)

0.3.3 (2024/04/02)

Bug Fixes

• cli: Disable newline on click.echo, markdown content already has a new line at the end. (6e2406af)
• Refactor array-like logic to fix wrong types being set on some use-cases. (ce6cfd59)

Miscellaneous Tasks

• deps-dev: Bump black from 24.2.0 to 24.3.0 (#10) (6e93501f)
• Update dependencies. (5fea1087)

Testing

• Use typing.Union to support 3.9. (e1d8f25f)

Ci

• Add initial tests. (10c59a3b)
• Fix Github Actions multi-line syntax. (91251dc4)

0.3.2 (2024/03/03)

Bug Fixes

• Wrong keyword argument for resolve refs experimental feature. (08413d07)

Miscellaneous Tasks

• Update dependencies. (1797b415)

0.3.1 (2024/02/21)

Bug Fixes

• Not all definitions must have a properties element (#7) (c60d170a)

Documentation

• Update README.md with new usage message. (39dc652c)

Features

• cli: Add support for title override with -t/--title option. (0418a470)

Miscellaneous Tasks

• Add black and ruff on GitHub Actions. (45cbcd23)
• Fix ruff check command. (90560832)

0.3.0 (2024/02/15)

Bug Fixes

• ci: Docker Hub username is not a secret. (03b353e5)
• Remove version and timestamp from footer. (ec648170)
• Fix oneOf, anyOf and allOf labels in table. (aad51fdf)
• Fix number/integer limits calculation. (fd3bfd03)

Documentation

• Add docker instructions. (81db236b)
• Add links to Docker Hub and GitHub Container Registry. (7e17ba8d)
• Typo in Docker Hub link. (158b366b)

Features

• Add string length and format. (a01d4920)
• Add support for examples. (8b332edc)

Miscellaneous Tasks

• Bump versions, bump Python to 3.9. (3c2c2271)
• Update docs on README.md. (2df2f9df)

Testing

• Add basic test script. (5b534c5c)

Bug Fixes

• Dockerfile: Use multi-stage builds to decrease image size. (b8cf5ea9)

Features

• Add Dockerfile to run CLI. (#4) (c7d53140)
• Add support for supplying '-' as a shortcut to read schema from STDIN. (41805154)

Miscellaneous Tasks

• Update dependencies. (ef818ff9)

Ci

• Add docker build and push job. (7fdb2114)

Features

• Add flags for experimental ref resolver and debug messages. (3d070935)

Miscellaneous Tasks

• Update dependencies. (afceabeb)

Refactor

• Recursive schema parser should be easier to read, do not expand $ref, use ref key instead of title for definition links. (48fc0d03)

Bug Fixes

• Add newline if footer is used. (98b9f393)

Bug Fixes

• Only add Definitions section if JSON schema contains definitions. (732818dc)

Features

• Add footer with timestamp and jsonschema-markdown version to generated markdown. Add CLI flag to opt-out. (5af92798)

Bug Fixes

• Strip beginning and end of markdown of spaces and newlines, leave only one newline at the end. (d1b55aa3)

Bug Fixes

• Fix anchor links, GitHub and GitLab render them in lowercase. (0b134283)

Miscellaneous Tasks

• Remove unused files. (02f2af57)
• Add instructions and contributing guide. (004eb80a)

Miscellaneous Tasks

• Add license, repo, classifiers and keywords to pyproject.toml. (c9c03905)

Features

• Add support for more array and object types, add support for integers. (0fa66300)

Bug Fixes

• Handle instances with no properties. (41b60285)

Features

• Add support for nullables. (963578b5)

Miscellaneous Tasks

• Publish to PyPI only on tags. (6be56b09)