OpenAPITools / OpenAPITools/openapi-generator

[BUG] [JAVA][ASCIIDOC] Bug with converting enums to asciidoc

Open
#12,266 2 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

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Enums inside of my json will only show up as an empty title inside of Asciidoc files generated with the Maven Plugin, with $refs to them also not linking up to them.

openapi-generator version

5.4.0

OpenAPI declaration file content or url

As an example, an enum like this:

      "Priority": {
        "type": "string",
        "enum": [
          "LOW",
          "NORMAL",
          "HIGH",
          "VERY HIGH"
        ]
      }

would end up being created like this:
grafik

Is this a known issue or am I doing something wrong?

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 Maven Plugin's Asciidoc generation path and reproduce the issue using the JSON enum declaration shown in the report. Compare the generated enum title and references with the expected named section and working links; the fix is complete when enum names and $ref links render correctly in the generated Asciidoc.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.