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.

Sign up for GitHub

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

Jump to bottom

📝🍎🚫💰 Update Swagger API documentation to explain non-revenue service representation and prediction 'uncertainty' #700

Merged
merged 8 commits into from
Dec 22, 2023
Merged

📝🍎🚫💰 Update Swagger API documentation to explain non-revenue service representation and prediction 'uncertainty' #700

merged 8 commits into from
Dec 22, 2023

Conversation

bfauble
Copy link
Contributor

@bfauble bfauble commented Nov 8, 2023 •
edited
Loading

Summary of changes

Asana Ticket: 📝🍎🚫💰 Update Swagger API documentation to explain non-revenue service representation and prediction 'uncertainty'

  • added Prediction docs for arrival/departure uncertainty values
  • added revenue filter docs for Trip, Prediction, and Vehicle.

Expected Merge Dec 7

@bfauble bfauble mentioned this pull request Nov 8, 2023
Merged
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 8, 2023

Coverage of commit 709fed5

Summary coverage rate:
  lines......: 89.1% (4129 of 4633 lines)
  functions..: 70.9% (2231 of 3145 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.0%     75|95.5%    22|    -      0
  apps/api_web/lib/api_web/controllers/trip_controller.ex               |89.1%     55| 100%    19|    -      0
  apps/api_web/lib/api_web/controllers/vehicle_controller.ex            |89.1%     46| 100%    17|    -      0
  apps/api_web/lib/api_web/swagger_helpers.ex                           |99.0%     97| 100%    35|    -      0

Download coverage report

@fsaid90 fsaid90 added the do not merge Do not merge label Nov 15, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 5, 2023

Coverage of commit 1e0a0a1

Summary coverage rate:
  lines......: 89.2% (4136 of 4638 lines)
  functions..: 71.0% (2237 of 3150 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.0%     75|95.5%    22|    -      0
  apps/api_web/lib/api_web/controllers/trip_controller.ex               |89.1%     55| 100%    19|    -      0
  apps/api_web/lib/api_web/controllers/vehicle_controller.ex            |89.1%     46| 100%    17|    -      0
  apps/api_web/lib/api_web/swagger_helpers.ex                           |99.0%     97| 100%    35|    -      0

Download coverage report

shantigonzales
shantigonzales requested changes Dec 12, 2023
View reviewed changes
Copy link

@shantigonzales shantigonzales left a comment

Choose a reason for hiding this comment

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

Reviewing now, seems like our name change hasn't made it in, but other than that it's looking good to me!

@bfauble
Copy link
Contributor Author

bfauble commented Dec 13, 2023

Reviewing now, seems like our name change hasn't made it in, but other than that it's looking good to me!

The revenue filter docs are actually present in the revenue filter PR and I'll just use the content from that PR (once approved) for the documentation instead of worrying about keeping both updated.

See here:
https://github.com/mbta/api/pull/705/files#diff-32846444ae6d90ad532e250f071854ca3e3e1f45563aa8233413ac7372f0766fR267
https://github.com/mbta/api/pull/705/files#diff-d32e9e2dce0bb28951c0393a8de3410ecfa8fbab4f434a53679ff1360ffd66e9R36
https://github.com/mbta/api/pull/705/files#diff-4f637e90e4aed0158a2bed5d16fbf471a7a36a5b993ce75474216a573de837feR64
https://github.com/mbta/api/pull/705/files#diff-9fc3e7da88f7aa8792f3a57394d3a4807b8d2239ffdb77fd25857ca8fdb829a3R90

@github-actions GitHub Actions
Copy link

Coverage of commit cb0d72e

Summary coverage rate:
  lines......: 89.2% (4135 of 4638 lines)
  functions..: 71.0% (2237 of 3150 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.0%     75|95.5%    22|    -      0
  apps/api_web/lib/api_web/controllers/trip_controller.ex               |89.1%     55| 100%    19|    -      0
  apps/api_web/lib/api_web/controllers/vehicle_controller.ex            |89.1%     46| 100%    17|    -      0
  apps/api_web/lib/api_web/swagger_helpers.ex                           |99.0%     97| 100%    35|    -      0

Download coverage report

@fsaid90 fsaid90 requested a review from Whoops December 21, 2023 17:02
@github-actions GitHub Actions
Copy link

Coverage of commit ca1aa82

Summary coverage rate:
  lines......: 89.2% (4167 of 4674 lines)
  functions..: 71.1% (2250 of 3164 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.2%     78|95.7%    23|    -      0

Download coverage report

@github-actions GitHub Actions
Copy link

Coverage of commit 27de3a5

Summary coverage rate:
  lines......: 89.2% (4177 of 4684 lines)
  functions..: 71.1% (2253 of 3171 functions)
  branches...: no data found

Files changed coverage rate:
                                                                        |Lines       |Functions  |Branches    
  Filename                                                              |Rate     Num|Rate    Num|Rate     Num
  ============================================================================================================
  apps/api_web/lib/api_web/controllers/prediction_controller.ex         |96.2%     78|95.7%    23|    -      0

Download coverage report

@bfauble bfauble merged commit 9a30df8 into master Dec 22, 2023
6 checks passed
@bfauble bfauble deleted the bf-non-rev-docs branch December 22, 2023 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shantigonzales shantigonzales shantigonzales approved these changes

@Whoops Whoops Whoops approved these changes

@fsaid90 fsaid90 Awaiting requested review from fsaid90

Assignees
No one assigned
Labels
do not merge Do not merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bfauble @Whoops @shantigonzales @fsaid90