Skip to content

Resolve "Make the html attribute on the blob json call optional"

Tim Zallmann requested to merge 46668-make-the-html-attribute-on-the-blob-json-call-optional into master

What does this MR do?

It adds to the blob JSON endpoint the option html_render=false (default is that it is still included) to exclude rendered HTML output as the native Vue blob viewers don't need that anymore for the Web IDE and that improves performance quite a lot.

For example the endpoint result for /h5bp/html5-boilerplate/blob/master/CHANGELOG.md?format=json&html_render=false was before 14.4KB and now is 1.1KB and is locally already 20% faster per request.

Are there points in the code the reviewer needs to double check?

Why was this MR needed?

Make especially the Web IDE and later other parts that use native Vue Viewers faster.

Does this MR meet the acceptance criteria?

  • API support added
  • Tests added for this feature/bug
  • Conform by the code review guidelines
    • Has been reviewed by a Frontend maintainer
    • Has been reviewed by a Backend maintainer
  • Conform by the merge request performance guides
  • Conform by the style guides
  • If you have multiple commits, please combine them into a few logically organized commits by squashing them
  • Internationalization required/considered
  • End-to-end tests pass (package-and-qa manual pipeline job)

What are the relevant issue numbers?

Closes #46668 (closed)

Edited by Tim Zallmann

Merge request reports