OpenAPITools / OpenAPITools/openapi-generator

[BUG] [MARKDOWN] EscapeUnsafeCharacters Warning in Default-Generator

Open
#5,003 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

In the current Markdown-Generator, a Warning is written that says the following:
[main] WARN o.o.codegen.DefaultCodegen - escapeUnsafeCharacters should be overridden in the code generator with proper logic to escape unsafe characters
I think that is something that is legacy from the creation of the default Markdown-Generator. Make this Warning sense if I just use the Generator and not implemented it by myself?

openapi-generator version

openapi-generator-cli-4.2.3-SNAPSHOT

Suggest a fix

Remove the warning of the default-generator "markdown"

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 at the DefaultCodegen warning mentioned in the issue and trace how the default Markdown generator reaches it. Confirm the warning is emitted when using the Markdown generator without custom implementation, then verify that normal Markdown generation completes without this warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.