Skip to content

docs: remove doe_week from freight pricing timeseries frequency list - #572

Merged
kahoowkh merged 3 commits into
masterfrom
rnd-23204
Aug 20, 2026
Merged

docs: remove doe_week from freight pricing timeseries frequency list#572
kahoowkh merged 3 commits into
masterfrom
rnd-23204

Conversation

@kahoowkh

@kahoowkh kahoowkh commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

RELATED TICKETS

CHANGELOG

  • Remove doe_week from the breakdown_frequency docstring for FreightPricingTimeseries.search; it is not a valid aggregation interval for this endpoint.

TESTS

  • Docstring-only change; no behaviour affected.

COMMENTS

  • n/a

doe_week is not a valid Elasticsearch aggregation interval for the
freight-outlook timeseries endpoint and returns a 500.
Copilot AI lite review requested due to automatic review settings August 12, 2026 11:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the SDK documentation for FreightPricingTimeseries.search to reflect the valid breakdown_frequency options, and bumps the package version for release.

Changes:

  • Remove doe_week from the breakdown_frequency options listed in the FreightPricingTimeseries.search docstring.
  • Update __version__ from 1.0.30a1 to 1.0.31.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
vortexasdk/endpoints/freight_pricing_timeseries.py Docstring update to remove an invalid breakdown_frequency value for this endpoint.
vortexasdk/version.py Bumps the SDK version to 1.0.31.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread vortexasdk/version.py Outdated
@kahoowkh
kahoowkh enabled auto-merge (squash) August 20, 2026 12:50
@kahoowkh
kahoowkh merged commit af861db into master Aug 20, 2026
12 checks passed
@kahoowkh
kahoowkh deleted the rnd-23204 branch August 20, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants