Repository navigation
docs(api): document fromStartTime as required on experiments endpoints - #1947
Conversation
Regenerated langfuse/api from the upstream Fern definition: baseline langfuse/langfuse 619dbe3 (last sync, #1866) plus langfuse/langfuse#17603. Split out of the bundled API-spec bot PR #1943. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
|
@claude review |
There was a problem hiding this comment.
Claude Code Review
No review was started: this request came from a bot account. Manual reviews can only be requested by someone with write access to this repository. Ask a maintainer to comment @claude review, or have your automation post the comment from a user account with write access.
Tip: disable this comment in your organization's Code Review settings.
There was a problem hiding this comment.
LGTM, straightforward docstring-only change to generated API client files.
What was reviewed: the full diff in langfuse/api/experiments/client.py and raw_client.py — confirmed all four hunks are docstring text expansions for the already-required from_start_time parameter on get/get_items (sync and async), with no changes to signatures, defaults, types, or logic.
Extended reasoning...
The diff touches only two Fern-generated API client files, adding clarifying docstring text (marking from_start_time as "Required" and explaining the rationale) to four methods; no signatures, types, defaults, or behavior changed, and the parameter was already required before this diff. No security-sensitive surface (auth, crypto, permissions) is touched, the change is small and mechanical, and there is no outstanding reviewer objection in the timeline.
Regenerated from langfuse/langfuse branch docs/experiments-from-start-time-neutral-wording. The fromStartTime docstrings named `toStartTime`, but the Python parameter is `to_start_time`; they now say "an upper bound" instead. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
What does this PR do?
Split out of #1943 (the bot sync from langfuse/langfuse
4e733d0), so that each upstream API definition change can be reviewed and merged on its own. Regeneratedlangfuse/apifrom the last synced spec (langfuse/langfuse619dbe3) with only this upstream change applied, using the same post-processing assdk-api-spec.yml.Upstream: langfuse/langfuse#17603. JS counterpart: langfuse/langfuse-js#990.
Docstrings only: explains why
from_start_timeis required on the experiments endpoints.Breaking changes
None.
from_start_timewas already a required argument onmain, and no signature changes.Type of change
Verification
The 18 errors are all in
tests/unit/test_prompt.py(Langfuse client is not initialized) and reproduce identically on unmodifiedmainlocally, so they are environmental and not caused by this diff.Skipped:
tests/e2eandtests/live_provider, because no Langfuse server or provider credentials were available locally.Generation was checked against the bot output: regenerating langfuse/langfuse
619dbe3(the last synced spec, #1866) with the same steps assdk-api-spec.ymlreproducesmainexactly, and regenerating4e733d0reproduces #1943 byte-for-byte.scripts/patch_generated_score_compat.pyran and is a no-op on this tree.Checklist
code_review.md..env.templateif needed. (n/a)Release info
Bump level: patch (ships in the current 4.x major).
🤖 Generated with Claude Code
🤖 Written by Claude (an AI agent) on behalf of Niklas
The PR appears safe to merge, with a non-blocking correction to the documented upper-bound keyword.
Summary
This PR updates eight parameter docstrings across the regular and raw experiment clients.
from_start_timeis required and clarifies event-time filtering.to_start_timeinstead of the HTTP nametoStartTime.Reviews (1) · Last reviewed commit: "docs(api): document fromStartTime as req..." · Reviewed by Greptile