OpenAPITools / OpenAPITools/openapi-generator

[BUG][MARKDOWN] Model link contains underscores

Open
#6,100 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

Sometimes a link from API to model contains underscores (snake_case), but MD file in model is named in CamelCase. Name is correct in README.md.

### Return type

[**Warning_Clearing_Response**](../\Models/Warning_Clearing_Response.md)
openapi-generator version

4.3.0

OpenAPI declaration file content or url

bug.zip

Command line used for generation
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>4.3.0</version>
<executions>
  <execution>
    <id>markdown</id>

mvn clean compile

Steps to reproduce
Related issues/PRs
Suggest a fix

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

Reproduce the generated Markdown using the attached bug.zip and the Maven plugin configuration from the issue, then compare the model link in the generated file with the correctly named model file and README.md. Trace the Markdown generator entry point that creates model links; done means snake_case links resolve to the CamelCase model filenames.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.