Skip to content

docs(api): clarify total runtime estimates #885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kevincador wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(api): clarify total runtime estimates #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion projects/api/src/contracts/_internal/response/showResponseSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ export const showResponseSchema = z.object({
/**
* Available if requesting extended `full`.
*/
total_runtime: z.number().int().nullish(),
total_runtime: z.number().int().nullish().describe(
'Total runtime in minutes. When exact runtime data is unavailable, this value may include estimated fallback runtimes and should be treated as an approximation.',
),
/**
* Available if requesting extended `full`.
*/
Expand Down
4 changes: 3 additions & 1 deletion projects/api/src/contracts/shows/schema/response/seasonResponseSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ export const seasonResponseSchema = z.object({
/**
* Available if requesting extended `full`.
*/
total_runtime: z.number().int().nullish(),
total_runtime: z.number().int().nullish().describe(
'Total runtime in minutes. When exact runtime data is unavailable, this value may include estimated fallback runtimes and should be treated as an approximation.',
),
/**
* Available if requesting extended `full`.
*/
Expand Down
Loading