Add-onsJSON Schema Documentation Generator
Syncro Soft
Version: 4.1.0
Oxygen Version: 25.0+
End User License Agreement
This add-on is used to generate the documentation for a JSON Schema file. It is automatically installed the first time you invoke the action from the Tools -> Generate Documentation menu or Generate Documentation toolbar button.
What's new in version 4.1.0
- Text content is now wrapped so that it can no longer exceed cell margins.
- Schema definitions are now presented even if they are not referenced.
- Fixed some rendering problems related to diagrams and JSON Pointers.
- Implemented various performance improvements and bug fixes, including some broken links and encoding issues.
What's new in version 4.0.0
-
JSON Schema Draft 2019-09/2020-12
Added support to generate JSON Schema Documentation for Draft 2019-09 and 2020-12 schemas.
-
Presentation and source fixes
Fixed some presentation and documentation source issues.
What's new in version 3.3.0
-
UNICODE characters now allowed
UNICODE characters are now correctly rendered and presented in the generated documentation.
What's new in version 3.2.0
-
Schema Diagram image mapping
When generating JSON Schema documentation, you now have the option to include hyperlinks for the diagrams displayed for each component. The hyperlink will navigate to the definition of that component.
-
Various bug fixes and performance improvements
Fixed some bugs related to data representation. Also improved the performance of the generator and diagram generation.
What's new in version 3.1.0
-
Schema Diagram images for referred files
When generating JSON Schema documentation and the schema references external resources, diagrams are also generated for them.
-
Various bug fixes and performance improvements
Fixed some bugs related to hyperlinks in documentation. Also improved the performance of the generator and diagram generation in terms of speed.
What's new in version 3.0.0
-
Schema Diagram images included in documentation
When generating JSON Schema documentation, you now have the option to include the Diagram images for each component. The images are generated according to the options from Schema Design Properties page.
-
Schema compositors included in documentation
When generating JSON Schema documentation, you can now include the schema compositors "oneOf", "anyOf", "allOf", that are used for combining schemas.
-
Various bug fixes and performance improvements
Fixed some bugs related to "Split by location" option, and schemas references. Also improved the performance of the generator in terms of speed.
What's new in version 2.0.0
-
Specify the Included Components in documentation
The dialog box now includes options for filtering the generated content. You can choose whether or not to show the following components in the generated documentation: Annotations, Constraints, Source, Location, Used By, Properties, Pattern Properties and Enumerations
-
Split Output into multiple files
When generating documentation, there is now an option for splitting the output into multiple files. You can choose between splitting them by component name or by location.
-
Source Code presented with Syntax Highlights
The text-based schema source is now presented with syntax highlights, making it easier to visualize.
-
Show Schema Location
When generating documentation, you now have the option to show the location of the source schema in the generated documentation. The location contains the relative link to the source schema and the JSON Pointer to the location of the definition or property within the file.