City-of-Helsinki / maritime-maas

MIT License
0 stars 3 forks source link

MAAS-82 | Add generated API documentation #56

Closed charn closed 3 years ago

charn commented 3 years ago

Adds OpenAPI 3.0 schema and also Swagger and ReDoc.

codecov-commenter commented 3 years ago

Codecov Report

Merging #56 (b10a613) into main (2b6942c) will increase coverage by 0.19%. The diff coverage is 97.05%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
+ Coverage   88.14%   88.33%   +0.19%     
==========================================
  Files          45       45              
  Lines        1400     1432      +32     
  Branches      105      110       +5     
==========================================
+ Hits         1234     1265      +31     
- Misses        136      137       +1     
  Partials       30       30              
Impacted Files Coverage Δ
gtfs/api/shapes.py 97.14% <90.00%> (-2.86%) :arrow_down:
bookings/api.py 100.00% <100.00%> (ø)
gtfs/api/routes.py 100.00% <100.00%> (ø)
gtfs/api/stops.py 98.71% <100.00%> (+0.12%) :arrow_up:
maritime_maas/settings.py 83.92% <100.00%> (+0.59%) :arrow_up:
maritime_maas/urls.py 92.59% <100.00%> (+0.28%) :arrow_up:
mock_ticket_api/api.py 84.61% <100.00%> (+2.00%) :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 2b6942c...b10a613. Read the comment docs.

pjlampil commented 3 years ago

Otherwise looks good but I'd remove the bookings_retrieve because it's left out from the spec.

pjlampil commented 3 years ago

Ah. The PR is still open and it will probably disappear on merge. Nevermind.

pjlampil commented 3 years ago

Authentication section is a bit misleading, if it can be fixed easily, it would be great. Also should we hide the mock-endpoints? Otherwise LGTM 👍

charn commented 3 years ago

I'll merge this now and I'll see if those few changes can be implemented easily.