Skip to content

feat(sync): document lifetime_stats and only_rewatching on progress endpoint #786

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

Merged
StefanFriptu merged 1 commit into from
May 12, 2026
+16 −1
Merged

feat(sync): document lifetime_stats and only_rewatching on progress endpoint #786

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
8 changes: 8 additions & 0 deletions projects/api/src/contracts/_internal/request/lifetimeStatsQuerySchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { z } from '../z.ts';

export const lifetimeStatsQuerySchema = z.object({
lifetime_stats: z.boolean().optional().openapi({
description:
'When true, `progress.completed` and `progress.stats` reflect lifetime totals across all watches of the show. When false (default), they reflect the current watching session — i.e. counters reset by `/shows/:id/progress/watched/reset`.',
}),
});
9 changes: 8 additions & 1 deletion projects/api/src/contracts/sync/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { authMetadata, builder } from '../_internal/builder.ts';
import { bulkMediaRequestSchema } from '../_internal/request/bulkMediaRequestSchema.ts';
import { extendedQuerySchemaFactory } from '../_internal/request/extendedQuerySchemaFactory.ts';
import { lifetimeStatsQuerySchema } from '../_internal/request/lifetimeStatsQuerySchema.ts';
import { listRequestSchema } from '../_internal/request/listRequestSchema.ts';
import { pageQuerySchema } from '../_internal/request/pageQuerySchema.ts';
import { sortQuerySchema } from '../_internal/request/sortQuerySchema.ts';
Expand Down Expand Up @@ -44,7 +45,8 @@ const progress = builder.router({
query: extendedQuerySchemaFactory<['full', 'images']>()
.merge(pageQuerySchema)
.merge(sortQuerySchema)
.merge(statsQuerySchema),
.merge(statsQuerySchema)
.merge(lifetimeStatsQuerySchema),
responses: {
200: upNextResponseSchema.array(),
},
Expand Down Expand Up @@ -85,9 +87,14 @@ const progress = builder.router({
query: extendedQuerySchemaFactory<['full', 'images']>()
.merge(pageQuerySchema)
.merge(sortQuerySchema)
.merge(lifetimeStatsQuerySchema)
.merge(z.object({
hide_completed: z.boolean().optional(),
hide_not_completed: z.boolean().optional(),
only_rewatching: z.boolean().optional().openapi({
description:
'When true, restrict the list to shows the user is currently rewatching (i.e. those with an active `progress.reset_at`).',
}),
})),
responses: {
200: upNextResponseSchema.array(),
Expand Down
Loading