feat: update python#567
Closed
Jack-Burge55 wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Vessel Availability endpoints (and accompanying tests/docs examples) to pass filter_days_to_arrival as a single {"min": ..., "max": ...} dict instead of a one-element list of dicts.
Changes:
- Update
filter_days_to_arrivaltype hints and request payload construction across vessel availability endpoints. - Update test and documentation notebooks to use the dict form for
filter_days_to_arrival. - Minor notebook metadata/output normalization (e.g., execution counts).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| vortexasdk/endpoints/vessel_availability_timeseries.py | Switch filter_days_to_arrival from list-wrapping to direct dict payload. |
| vortexasdk/endpoints/vessel_availability_search.py | Align filter_days_to_arrival typing and payload with dict-form filter. |
| vortexasdk/endpoints/vessel_availability_breakdown.py | Align filter_days_to_arrival typing and payload with dict-form filter. |
| tests/endpoints/test_availability_breakdown.py | Update test call site to pass dict-form filter_days_to_arrival. |
| docs/examples/academy_use_cases/Freight & Voyages/Vessel availability freight rate causality.ipynb | Update example usage to dict-form filter_days_to_arrival. |
| docs/examples/academy_use_cases/Freight & Voyages/Fleet distribution per location.ipynb | Update example usage to dict-form filter_days_to_arrival and normalize notebook metadata/output text. |
| docs/examples/academy_use_cases/Freight & Voyages/Case Study of Voyages data.ipynb | Update example usage to dict-form filter_days_to_arrival and normalize notebook metadata/output text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
212
to
216
| "filter_region": filter_region, | ||
| "filter_port": filter_port, | ||
| "use_reference_port": use_reference_port, | ||
| "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), | ||
| "filter_days_to_arrival": filter_days_to_arrival, | ||
| "filter_vessel_dwt_min": filter_vessel_dwt_min, |
Comment on lines
219
to
223
| "filter_region": filter_region, | ||
| "filter_port": filter_port, | ||
| "use_reference_port": use_reference_port, | ||
| "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), | ||
| "filter_days_to_arrival": filter_days_to_arrival, | ||
| "filter_vessel_dwt_min": filter_vessel_dwt_min, |
Comment on lines
226
to
230
| "filter_region": filter_region, | ||
| "filter_port": filter_port, | ||
| "use_reference_port": use_reference_port, | ||
| "filter_days_to_arrival": convert_to_list(filter_days_to_arrival), | ||
| "filter_days_to_arrival": filter_days_to_arrival, | ||
| "filter_vessel_dwt_min": filter_vessel_dwt_min, |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RELATED TICKETS
https://vortexa.atlassian.net/browse/RND-21212
https://vortexa.atlassian.net/browse/RND-21211
! Do not post related PRs here, unless they are open source !
CHANGELOG
TESTS
COMMENTS