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

Swagger UI is not being generated #175

Closed
isabelcosta opened this issue Jan 3, 2019 · 3 comments · Fixed by #176
Closed

Swagger UI is not being generated #175

isabelcosta opened this issue Jan 3, 2019 · 3 comments · Fixed by #176
Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Bug Bug or Bug fixes.

Comments

@isabelcosta
Copy link
Member

isabelcosta commented Jan 3, 2019

Describe the bug

After the latest merge #158 the Swagger UI is not being generated.

The API is working, and it can be tested using other tools and the Android client, but this is bad for who wants to test the backend API without additional tools (like Postman).

To Reproduce
Steps to reproduce the behavior:

  1. Go to http://systers-mentorship-dev.eu-central-1.elasticbeanstalk.com/
  2. You won't see the Swagger UI generated

Expected behavior

Swagger UI should appear.

Screenshots

This is what is showing up:

what is showing up

This should show up:
swagger ui example

Additional context

The problem was introduced here: #158
I'm looking at this but any help would be appreciated.

The problem is with the usage of flask restplus. See the docs here: https://flask-restplus.readthedocs.io/en/stable/

@isabelcosta isabelcosta added Category: Coding Changes to code base or refactored code that doesn't fix a bug. Priority: HIGH Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Bug Bug or Bug fixes. labels Jan 3, 2019
@isabelcosta
Copy link
Member Author

I'm thinking this could be related with the use of field.Nested:
image

Investigating ...

@isabelcosta
Copy link
Member Author

By commenting on this line of code Swagger UI will be generated.

As you can see below:

image

@isabelcosta
Copy link
Member Author

It's fixed, by adding this missing description :D

image

isabelcosta added a commit that referenced this issue Jan 5, 2019
Fixed missing description in /home API response Swagger docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Coding Changes to code base or refactored code that doesn't fix a bug. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Bug Bug or Bug fixes.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant