OpenAPITools / OpenAPITools/openapi-generator

[BUG] [MARKDOWN] Generated Links from nested objects not match with generated Folders

Open
#4,997 3 comments 1 reaction 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

If an OpenAPI-Specificationhas nested objects for example responses or other objects, the generated model-folder isn't reachable via a link in the model.mustache field.

openapi-generator version

Markdown-Generator version 4.2.3-SNAPSHOT

Suggest a fix

Not generation the module name like "object_nested1_nested2" instead use ObjectNested1Nested2 that it matches the generated folder.

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 with the Markdown generator's model.mustache template and inspect how nested model names are converted into links. Compare the generated link with the generated model-folder name for nested response or object schemas; done means the link resolves to the generated folder using the requested CamelCase name.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.