-
Notifications
You must be signed in to change notification settings - Fork 1
fix(api): use request objects in all api clients #97
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR refactors the Navitia API client to consistently use request objects across all API methods and updates documentation from NumPy style to Google style docstrings.
Key changes:
- Standardize API methods to use request objects instead of individual parameters
- Update all docstrings from NumPy style to Google style
- Remove default values from request parameters in several methods (breaking change)
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
traffic_report_apis.py |
Moved request parameter to first position, removed default value; updated docstrings to Google style |
terminus_schedules_apis.py |
Updated docstrings to Google style; no API signature changes |
stop_schedules_apis.py |
Updated docstrings to Google style; no API signature changes |
route_schedules_apis.py |
Updated docstrings to Google style; no API signature changes |
public_transport_objects_apis.py |
Updated docstrings to Google style; no API signature changes |
places_nearby_apis.py |
Major refactor: replaced individual parameters with PlacesNearbyRequest object; updated docstrings |
place_apis.py |
Updated docstrings to Google style; no API signature changes |
line_report_apis.py |
Moved request parameter to first position, removed default value; updated docstrings |
journeys_apis.py |
Major refactor: replaced 30+ individual parameters with JourneyRequest object; updated docstrings |
isochrone_apis.py |
Updated docstrings to Google style; no API signature changes |
inverted_geocoding_apis.py |
Updated docstrings to Google style; no API signature changes |
freefloatings_nearby_apis.py |
Removed default values from request parameters; updated docstrings |
equipment_report_apis.py |
Removed default values from request parameters; updated docstrings |
departure_apis.py |
Updated docstrings to Google style; no API signature changes |
datasets_apis.py |
Updated docstrings to Google style; no API signature changes |
coverage_apis.py |
Updated docstrings to Google style; no API signature changes |
contributors_apis.py |
Updated docstrings to Google style; no API signature changes |
arrival_apis.py |
Updated docstrings to Google style; no API signature changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Changelog * Fix APIs missing usage of request objects * Update documentation * Fix tests
7dfec40 to
5b4a77f
Compare
Changelog