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

Issue with generic types in API docs generation #85

Open
landonreed opened this issue Oct 9, 2020 · 1 comment
Open

Issue with generic types in API docs generation #85

landonreed opened this issue Oct 9, 2020 · 1 comment
Labels
bug Something isn't working

Comments

@landonreed
Copy link
Contributor

spark-swagger does not handle bounded types well (see manusant/spark-swagger#14). As a result, the ResponseList type in the swagger output shows the data field as a string type. This might be resolvable by making some changes to spark-swagger (manusant/spark-swagger#15 is a work in progress) or there may be some changes made to the post-processing of the swagger output. More discussion on this was had here (reproduced in the screenshot below).

image

@landonreed landonreed added the bug Something isn't working label Oct 9, 2020
@manusant
Copy link

Hi thanks for trying-out the library and providing feedback and contributions.
In order to propper get response for typed collections, since we are dealing with an ambiguous type, the library provides a special method for this under MethodDescriptor called withResponseAsCollection.

I´m planning some improvements but you can go with this approach

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