Add-onsOpenAPI Documentation Generator
Syncro Soft
Version: 3.0.0
Oxygen Version: 26.0+
End User License Agreement
This add-on is used for generating documentation for OpenAPI (https://spec.openapis.org/oas/v3.0.3) components in HTML format, including annotations and cross references. The documentation displays information about the servers, paths, components and tags defined in the OpenAPI documents and it is presented in a visual diagram style with various sections, hyperlinks, and filtering options.
What's new in version 3.0.0
- An option was added to transform the OpenAPI content into PDF output.
What's new in version 2.2.0
- An option was added to transform the OpenAPI content into DITA output.
- The examples element is now rendered when transforming to HTML output.
- A detailed warning message is now displayed when the transformation’s target file has unsaved changes.
What's new in version 2.1.0
- The OpenAPI Documentation action is now properly aligned in the Generate Documentation menu on macOS distributions.
- You now have the option to include hyperlinks for the diagrams displayed for each JSON schema component. The hyperlink navigates you to the definition of that component.
- Links from the Source code section are now functional.
- Implemented various layout and rendering improvements.
What's new in version 2.0.0
- Added support to generate documentation for OpenAPI documents in YAML format.
- Added support for 3.1 OpenAPI elements.
- Redesigned the interface with a more user-friendly design.
- The output HTML is now validated based on the W3C validator.
- External JSON Schema are now present in documentation.
If there is a JSON schema that is referenced externally by the OpenAPI file, the schema body will be present in the documentation.
What's new in version 1.1.1
- Added internationalization for some labels and messages.
What's new in version 1.1.0
-
Schema Diagram image mapping
When generating OpenAPI 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.