Skip to content

Clean long strings before exporting to specification #562

@MrKrisKrisu

Description

@MrKrisKrisu
  • L5-Swagger Version: 8.5.1
  • PHP Version: 8.3

Description:

In my spec I have a lot of long strings and descriptions that go over multiple lines to make it more structured. The fact that multi-line comments start with a * makes it look strange in the finished OpenAPI specification.

I would like double spaces and * at the beginning of a line to be ignored before it is rendered.

Steps To Reproduce:

Example of a long description:

https://github.com/Traewelling/traewelling/blob/b6c313a19aa705c5a26e0858a8592615b9506e1f/app/Http/Controllers/API/v1/StatusTagController.php#L237-L251

Results - there are many * random in the text.
Traewelling/traewelling@b6c313a#diff-6528bc20d3aa7a292ad6698508df2ec69b2941bd0aa39c40a791a27fd6f1c162R2696

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions