swagger-api / swagger-api/swagger-ui

highlightSizeThreshold

Open
#3,105 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

P2 type: feature version: 3.x
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

I'm on version 3.0.10 and also noticed in the documentation that this isn't supported yet. What is the plan to support this option?
Highlight.js is killing the browser for responses greater than ~400kb (106kb gzip)

Also, it would be helpful to provide some clarity on what size means. Is it bytes, kilobytes, some length of an array?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how Swagger UI uses Highlight.js and where the undocumented highlightSizeThreshold option is handled. Clarify whether size means bytes, kilobytes, or another measure, then define the supported behavior for responses larger than roughly 400 KB. No file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, performance
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.