OpenAPITools / OpenAPITools/openapi-generator

[BUG][MARKDOWN] Missing model name in link from API

Open
#6,098 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

In some cases, the model name is missing in a link from API. Model is generated correctly. Check the entityID (../\Models/.md):

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **levels** | [**List**](../\Models/WarningLevel.md)|  | [optional] [default to null]
 **entityId** | [**EntityId**](../\Models/.md)|  | [optional] [default to null]```

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

Start by downloading bug.zip and reproducing the generated Markdown through the openapi-generator Maven plugin using the configuration shown. Inspect the generated entityId link and compare it with the expected model reference; done means the link includes the missing model name.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.