search

alysivji / falcon-apispec

apispec plugin that generates OpenAPI specification (aka Swagger Docs) for Falcon web applications.
MIT License
44 stars 31 forks source link

Add support for Falcon Resource suffixes #19

Closed henryh9n closed 4 years ago

henryh9n commented 4 years ago

Closes #18.

Added support for the Falcon suffixes, using the Flacon's router. There is no need to specify the suffix manually. The methods for the corresponding Resource, as is done for the path, is fetched automatically in path_helper.

Added tests for 100% coverage.

codecov-io commented 4 years ago

Codecov Report

Merging #19 into master will increase coverage by 0.06%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #19      +/-   ##
==========================================
+ Coverage   97.36%   97.43%   +0.06%     
==========================================
  Files           3        3              
  Lines          38       39       +1     
==========================================
+ Hits           37       38       +1     
  Misses          1        1
Impacted Files Coverage Δ
falcon_apispec/falcon_plugin.py 97.22% <100.00%> (+0.07%) :arrow_up:

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 9e48608...520a825. Read the comment docs.

henryh9n commented 4 years ago

@alysivji Any update on this?

alysivji commented 4 years ago

I have 4 hours booked tomorrow to dive into this. It's been a while since I've touched Falcon and I know folks are using this in prod -- want to make sure we don't break anything (especially now there is a v2 of Falcon)

Just taking a quick look at the PR, it does look good. Do you mind updating the README.md with a small section about resource suffixes? No worries if you do not have time, I can add a commit to this branch.