Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description for Fields using Enums not used in swagger documentation #56

Open
PetFeld-ed opened this issue Jan 28, 2022 · 0 comments
Open
Labels
bug Something isn't working

Comments

@PetFeld-ed
Copy link

When the info->description property is defined for a field of a DTO and the field is of type Enum<T> (or any specification like ::AsString) then the description is not shown in the generated swagger documentation.

This example

  DTO_FIELD_INFO(color) {
    info->description = "Color the object is displayed with";
  }
  DTO_FIELD(Enum<Color>::AsString , color);

results in this swagger documentation:

Color_String string
  Enum:[ red, green, blue ]

The expected output would be something like this:

Color the object is displayed with
Color_String string
  Enum:[ red, green, blue ]
@bamkrs bamkrs added the bug Something isn't working label Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants