olin-build / ABE

Amorphous Blob of Events
https://abe.olin.build/
GNU Affero General Public License v3.0
7 stars 1 forks source link

Improved swagger docs #264

Closed osteele closed 6 years ago

osteele commented 6 years ago

Add some descriptions.

Fix model names and references.

App and Label marshal with their models.

Annotate authorizations.

/doc can initate the authorization flow.

Generate a Postman file.

Link to (new) wiki pages.

codecov[bot] commented 6 years ago

Codecov Report

Merging #264 into dev will decrease coverage by 0.03%. The diff coverage is 65.9%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #264      +/-   ##
==========================================
- Coverage   75.89%   75.85%   -0.04%     
==========================================
  Files          51       52       +1     
  Lines        2157     2183      +26     
==========================================
+ Hits         1637     1656      +19     
- Misses        520      527       +7
Impacted Files Coverage Δ
tests/test_events.py 98.94% <ø> (ø) :arrow_up:
abe/sample_data.py 90.36% <ø> (ø) :arrow_up:
abe/auth/access_tokens.py 93.47% <100%> (-0.14%) :arrow_down:
abe/document_models/__init__.py 100% <100%> (ø)
abe/resource_models/subscription_resources.py 40.84% <100%> (+0.84%) :arrow_up:
abe/resource_models/event_resources.py 65.35% <100%> (-0.28%) :arrow_down:
abe/resource_models/user_resources.py 100% <100%> (ø) :arrow_up:
abe/document_models/event_documents.py 100% <100%> (+27.63%) :arrow_up:
tests/test_admin.py 100% <100%> (ø) :arrow_up:
abe/document_models/app_documents.py 100% <100%> (ø) :arrow_up:
... and 9 more

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 75934f7...b5612e4. Read the comment docs.