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

Improve on the Swagger doc #512

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Improve on the Swagger doc #512

merged 2 commits into from
Jan 25, 2024

Conversation

ateska
Copy link
Contributor

@ateska ateska commented Nov 2, 2023

  • change in build_swagger_documentation so that it propagates a host into the list of servers; it is more sane way of how to call "self" from Swagger, removing that relative URL
  • improved way of how swagger is loaded to web server (thru index.html)
  • added "shortcut" param "api" to asab.web.create_web_server() that enables swagger doc just by stating api=True

@ateska ateska added enhancement New feature or request good first issue Good for newcomers labels Nov 2, 2023
@mejroslav
Copy link
Contributor

@ateska Can you summarize what this is about and if there are gonna be some TODOs?

@ateska
Copy link
Contributor Author

ateska commented Dec 5, 2023

Summarised.

@ateska
Copy link
Contributor Author

ateska commented Dec 5, 2023

Flake8 is broken, no other TODOs on the list.
Maybe re-alignment with the recent Swagger changes will be needed.

@ateska
Copy link
Contributor Author

ateska commented Dec 5, 2023

Flake8 is working now but the unit test in Python 3.9 is failing.

@mejroslav
Copy link
Contributor

Flake8 is working now but the unit test in Python 3.9 is failing.

That is probably ok. The unit test was designed to expect a different output from this function. I disabled it in master.

@mejroslav mejroslav self-assigned this Dec 15, 2023
@mejroslav
Copy link
Contributor

OK, I am taking this one.

@mejroslav mejroslav merged commit 0791afa into master Jan 25, 2024
4 of 8 checks passed
@mejroslav mejroslav deleted the feature/swagger-2311 branch January 25, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants