swagger-api / swagger-api/swagger-ui
Parameter "useUnsafeMarkdown" deprecated : And in the future ?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
- OS: Windows 11
- Browser: firefox
- Version: 108.x
- Method of installation: [e.g. npm, dist assets]
- Swagger-UI version: [e.g. 3.10.0]
- Swagger/OpenAPI version: OpenAPI 3.0.3
Content & configuration
-> useless
Swagger/OpenAPI definition:
-> useless
Swagger-UI configuration options:
swaggerUi.setup(swaggerDocument, {
customCssUrl: './styles/swagger_custom.css',
swaggerOptions: {
useUnsafeMarkdown: true,
showExtensions: true,
},
})
Screenshots
useless
How can we help?
Hello,
i have a question on the use of "style, class and data-* attributes untouched on all HTML Elements declared inside markdown strings".
I can use currently the "useUnsafeMarkdown" parameter to do that.
How could i continue to use this functionality in the future, knowing "This parameter is Deprecated and will be removed in 4.0.0. " ?
Thx in advance for your response.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Swagger UI configuration entry point, especially swaggerUi.setup and the swaggerOptions.useUnsafeMarkdown setting. Review how this deprecated option currently preserves style, class, and data-* attributes in markdown, then establish and document the supported future approach or migration guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100