Skip to content

HtmlRender reports far less informations than MarkdownRender #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matthieugeerebaert opened this issue Feb 5, 2021 · 2 comments
Open

Comments

@matthieugeerebaert
Copy link

Markdown output got all changes, but Html is missing new optional properties / descriptions

@MarkJBenson
Copy link

MarkJBenson commented Feb 28, 2022

I am also encountering this issue.

The HTML output appears to be the same as the console output.

I was thinking that maybe the --info flag would output the additional information on the console and maybe also include that extra output in the HTML but the --info flag doesn't appear to do anything.

This was with 2.0.1 (jar and docker image)

@MajorDallas
Copy link

And another bump on this.

Actually, the md and html outputs are mostly similar, I think. HTML is definitely missing information, as evidenced by the 57KB difference in size of the output files.

Specifically, the html file will tell me that that an endpoint's schema has changed but not how. In my case today, the maxLength property on a string field was the only non-description difference between two versions--a breaking change, certainly, but I had to dig into both json files myself to figure that out. The md file also did not tell me that this was the difference, but it at least told me the name of the field where the properties have changed.

I don't know if the json output will tell me this information--the file size was over 10,000x that of the html and md files. No joke: the same diff produced a 113KB html file and a 1.1GB json file 🤯 I've had some difficulty doing anything with it to see what data it contains, but if it's that large it probably has all the information that I was hoping to see in the html file (and then some... and some more).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants