Skip to content

[BUG] Generator options documentation has broken formatting #6074

@gjbianco

Description

@gjbianco

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

The Markdown formatting is broken in a lot of the generator options' documentation. It looks like the way legacyDiscriminatorBehavior was added broke the table of options.

For example, the typescript-axios generator: https://openapi-generator.tech/docs/generators/typescript-axios/

It also shows up incorrectly even in the GFM preview of the Markdown file: https://github.com/spacether/openapi-generator/blob/f8c95d8865e0a4a7a2e3dc1b20a3c909f0205ca6/docs/generators/typescript-axios.md

openapi-generator version

Latest code available on master

OpenAPI declaration file content or url

N/A

Command line used for generation

N/A

Steps to reproduce
  1. Visit either https://openapi-generator.tech/docs/generators/typescript-axios/ or https://github.com/spacether/openapi-generator/blob/f8c95d8865e0a4a7a2e3dc1b20a3c909f0205ca6/docs/generators/typescript-axios.md (amongst others).
  2. Look at the options after legacyDiscriminatorBehavior.
Related issues/PRs

This appears to have been introduced as part of #4906

Suggest a fix

The author tried to nest a list inside the table, which it appears (most?) flavors of Markdown do not support. At the very least, it doesn't work the way it is written in GFM as well as whichever flavor is used by the online documentation tooling.

The fix should either involve changing the syntax to fix the bulleted list or removing the list from the table (perhaps use a footnote to add the list at the bottom?).

I am unfamiliar with how options such as those get added to the many different Markdown docs in this project. i.e. was this a manual process or is there a tool that can add common options to several generators at once?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions