feat: update descriptions#568
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Anywhere Freight Pricing endpoint docstrings to align with revised API documentation and removes the deprecated include_port_costs parameter from the forecast explanation endpoint.
Changes:
- Refreshed multiple Anywhere Freight Pricing endpoint descriptions to clarify returned fields (rates/lumpsums/confidence, tonnage ranges, timeseries semantics).
- Removed
include_port_costsfromAnywhereFreightPricingForecastExplanation.searchand deleted the associated test.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| vortexasdk/endpoints/anywhere_freight_pricing_vessel_classes_details.py | Updates docstring to describe suggested/min/max tonnage fields. |
| vortexasdk/endpoints/anywhere_freight_pricing_top_ports_origin.py | Expands endpoint/search docstrings to describe top-10 logic and cost breakdowns. |
| vortexasdk/endpoints/anywhere_freight_pricing_top_ports_destination.py | Expands endpoint/search docstrings to describe top-10 logic and cost breakdowns. |
| vortexasdk/endpoints/anywhere_freight_pricing_price_timeseries.py | Clarifies historical vs voyage price, cost components, and lumpsum wording. |
| vortexasdk/endpoints/anywhere_freight_pricing_post_price_details.py | Clarifies meaning of rates/lumpsums/confidence in batch price details docs. |
| vortexasdk/endpoints/anywhere_freight_pricing_get_price_details.py | Clarifies meaning of rates/lumpsums/confidence in single-route price details docs. |
| vortexasdk/endpoints/anywhere_freight_pricing_forecast_timeseries.py | Clarifies forecast-only outputs, total cost definition, and lumpsum semantics. |
| vortexasdk/endpoints/anywhere_freight_pricing_forecast_explanation.py | Removes include_port_costs parameter and updates explanatory docstrings. |
| tests/endpoints/test_anywhere_freight_pricing_forecast_explanation.py | Removes the include_port_costs test case. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alexspeddingvortexa
approved these changes
Jun 29, 2026
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
! Do not post related PRs here, unless they are open source !
CHANGELOG
TESTS
COMMENTS