OpenAPITools / OpenAPITools/openapi-generator

[BUG] [ASCIIDOC] Description of classes is not processed with asciidoc generator

Open
#14,737 2 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

We have some classes with tag annotations.

@Tag(name = "Service Name", description = "Description Text.")

We receive a generated yaml file with this information.

openapi: 3.0.1
...
tags:
- name: Service Name
  description: Description Text.
...

We use this file with the "asciidoc" Generator. Now we missing the "description" information in the output (the name is displayed).

The part of the template (index.mustache) looks like this:

== Endpoints

[.{{baseName}}]
=== {{baseName}}

{{{description}}}

{{#operation}}

...

{{{description}}} has no output.

== Endpoints

[.ServiceName]
=== ServiceName

[.methodname]
==== methodname

...

Tested with openapi-generator.version: 6.2.1 and 6.3.0

Are there any clues as to what we are doing wrong or is it a bug?

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 Asciidoc generator's index.mustache template and compare how the generated YAML represents tag names and descriptions. Reproduce the issue with the shown @Tag annotation and OpenAPI document, then verify that the generated Asciidoc includes the tag description while preserving the existing name 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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.