OpenAPITools / OpenAPITools/openapi-generator

The `asciidoc` generator generates duplicated documentation for the same operation id

Open
#19,659 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Hello,
I am using the latest version 7.8.0 of the openapi generator (via the maven plugin) to generate just the API documentation starting from an OpenAPI spec. I am using the asciidoc generator.
Following, the OpenAPI spec I am using:

https://github.com/strimzi/strimzi-kafka-bridge/blob/main/src/main/resources/openapi.json

Is there any specific reason why the generator ends by duplicating the documentation for these following operation ids ?

send
seek
seekToBeginning
seekToEnd
sendToPartition

Thanks,
Paolo

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 reproducing the report with the linked Strimzi openapi.json and the asciidoc generator through the Maven plugin. Inspect the generated documentation for the send, seek, seekToBeginning, seekToEnd, and sendToPartition operation IDs, then trace where those operations are rendered. Done means the duplicate entries are explained and the relevant generator behavior is corrected or documented.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.