Skip to content

Commit 591aa7a

Browse files
committed
comments about params type splitting for developer clarity
1 parent b67f5f7 commit 591aa7a

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

src/runloop_api_client/types/benchmark_start_run_params.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
__all__ = ["BenchmarkStartRunParams"]
1212

1313

14+
# Split into separate params so that OO SDK start_run params can omit the benchmark_id
15+
# Neither of these params are exposed to the user, only the derived SDKBenchmarkStartRunParams
1416
class BenchmarkSelfStartRunParams(TypedDict, total=False):
1517
metadata: Optional[Dict[str, str]]
1618
"""User defined metadata to attach to the benchmark run for organization."""

src/runloop_api_client/types/benchmarks/run_list_params.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
__all__ = ["RunListParams"]
88

99

10+
# Split into separate params so that OO SDK list_runs params can omit the benchmark_id
11+
# Neither of these params are exposed to the user, only the derived SDKBenchmarkListRunsParams
1012
class RunSelfListParams(TypedDict, total=False):
1113
limit: int
1214
"""The limit of items to return. Default is 20. Max is 5000."""

0 commit comments

Comments
 (0)