Skip to content

Added specs-url-scheme option for Api. #238

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

Merged
merged 7 commits into from
Apr 27, 2021

Conversation

DustinMoriarty
Copy link
Contributor

  • Support explicitly setting the scheme for specs_url for the swagger.json file for cases where the URL scheme does not resolve correctly such as when deploying on AWS ECS behind an elastic load balancer. Behavior is unchanged for cases where the keyword argument is left as None. See Need to Explicitly set Swagger specs_url Scheme When Deployed on Behind AWS Elastic Load Balancer. #237
  • Added tests for the new behavior as well as to confirm the old behavior has not changed.
  • Added docstrings.
  • Formatted with black. This will effect the diff for a few other modules such as flask_restx/reqparse.py, flask_restx/model.py. flask_restx/inputs.py and some other locations in api.py.
  • Added .python-version and .idea to .gitignore.

@codecov
Copy link

codecov bot commented Oct 9, 2020

Codecov Report

Merging #238 (0e8cd95) into master (b0ea3be) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #238   +/-   ##
=======================================
  Coverage   96.87%   96.88%           
=======================================
  Files          20       20           
  Lines        2724     2727    +3     
=======================================
+ Hits         2639     2642    +3     
  Misses         85       85           
Impacted Files Coverage Δ
flask_restx/api.py 96.71% <100.00%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0ea3be...0e8cd95. Read the comment docs.

@DustinMoriarty
Copy link
Contributor Author

@mas15 OR @j5awry : Can this be merged? Thank you.

@mas15
Copy link

mas15 commented Mar 27, 2021

@DustinMoriarty Hi, I cannot do that since I am not a maintainer. This project is abandoned and I would not expect this to be merged

@DustinMoriarty
Copy link
Contributor Author

To bad. Thanks for letting me know.

@DustinMoriarty
Copy link
Contributor Author

@j5awry : I updated this to get it up to date with the upstream. I do need maintainer approval to get it through the workflow checks and merge if you think this is something you would like to do.

Copy link
Contributor

@j5awry j5awry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution, and for taking the time to update this after we moved ahead! LGTM

@j5awry j5awry merged commit 66471c5 into python-restx:master Apr 27, 2021
@DustinMoriarty DustinMoriarty deleted the feature/specs-url-scheme branch April 28, 2021 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants