OpenAPITools / OpenAPITools/openapi-generator

[BUG] Missing footnote for `*`

Open
#6,703 4 comments 0 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

In gernerated docs, there is a * next to some fields.

The explanation of the * is always missing.

Screenshot 2020-06-17 at 19 01 45

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

No source file or test is named. Start by reproducing the generated documentation that shows fields marked with *, then trace where the marker and its explanation are rendered. Done means generated documentation consistently includes the explanation for every * marker and a regression check covers the output.

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.