Skip to content

fix(api)!: move translations language filter to an optional query param #901

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
seferturan merged 1 commit into from
Aug 11, 2026
Merged

fix(api)!: move translations language filter to an optional query param #901

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
6 changes: 0 additions & 6 deletions projects/api/src/contracts/_internal/request/languageParamsSchema.ts
View file
Open in desktop

This file was deleted.

8 changes: 8 additions & 0 deletions projects/api/src/contracts/_internal/request/translationsLanguageQuerySchema.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';

/** Zod schema for the translations language query parameters. */
export const translationsLanguageQuerySchema = z.object({
language: z.string().nullish().openapi({
description: 'Filter translations to a 2 character language code',
}),
});
9 changes: 5 additions & 4 deletions projects/api/src/contracts/movies/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { extendedRatingsQuerySchema } from '../_internal/request/extendedRatings
import { extendedWatchNowQuerySchema } from '../_internal/request/extendedWatchNowQuerySchema.ts';
import { idParamsSchema } from '../_internal/request/idParamsSchema.ts';
import { ignoreQuerySchema } from '../_internal/request/ignoreQuerySchema.ts';
import { languageParamsSchema } from '../_internal/request/languageParamsSchema.ts';
import { translationsLanguageQuerySchema } from '../_internal/request/translationsLanguageQuerySchema.ts';
import { limitlessQuerySchema } from '../_internal/request/limitlessQuerySchema.ts';
import { linksQuerySchema } from '../_internal/request/linksQuerySchema.ts';
import { mediaFilterParamsSchema } from '../_internal/request/mediaFilterParamsSchema.ts';
Expand Down Expand Up @@ -141,10 +141,11 @@ Use \`?extended=all\` to include ratings from TMDB, IMDb, Metascore, Rotten Toma
translations: {
summary: 'Get all movie translations',
description:
'Returns all translations for a movie, including language, country, and translated values for title, tagline and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`).',
path: '/translations/:language',
'Returns all translations for a movie, including language, country, and translated values for title, tagline and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`). Use the optional `language` query param to filter to a single language.',
path: '/translations',
method: 'GET',
pathParams: idParamsSchema.merge(languageParamsSchema),
pathParams: idParamsSchema,
query: translationsLanguageQuerySchema,
responses: {
200: translationResponseSchema,
},
Expand Down
25 changes: 13 additions & 12 deletions projects/api/src/contracts/shows/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { extendedRatingsQuerySchema } from '../_internal/request/extendedRatings
import { extendedWatchNowQuerySchema } from '../_internal/request/extendedWatchNowQuerySchema.ts';
import { idParamsSchema } from '../_internal/request/idParamsSchema.ts';
import { ignoreQuerySchema } from '../_internal/request/ignoreQuerySchema.ts';
import { languageParamsSchema } from '../_internal/request/languageParamsSchema.ts';
import { translationsLanguageQuerySchema } from '../_internal/request/translationsLanguageQuerySchema.ts';
import { limitlessQuerySchema } from '../_internal/request/limitlessQuerySchema.ts';
import { linksQuerySchema } from '../_internal/request/linksQuerySchema.ts';
import { mediaFilterParamsSchema } from '../_internal/request/mediaFilterParamsSchema.ts';
Expand Down Expand Up @@ -90,13 +90,13 @@ Returns a single episode's details. All date and times are in UTC and were calcu
translations: {
summary: 'Get all episode translations',
description:
'Returns all translations for an episode, including language, country, and translated values for title and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`).',
path: '/translations/:language',
'Returns all translations for an episode, including language, country, and translated values for title and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`). Use the optional `language` query param to filter to a single language.',
path: '/translations',
method: 'GET',
pathParams: idParamsSchema
.merge(seasonParamsSchema)
.merge(episodeParamsSchema)
.merge(languageParamsSchema),
.merge(episodeParamsSchema),
query: translationsLanguageQuerySchema,
responses: {
200: episodeTranslationResponseSchema,
},
Expand Down Expand Up @@ -397,10 +397,11 @@ By default, the \`last_episode\` and \`next_episode\` are calculated using the l
translations: {
summary: 'Get all show translations',
description:
'Returns all translations for a show, including language, country, and translated values for title, tagline and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`).',
path: '/translations/:language',
'Returns all translations for a show, including language, country, and translated values for title, tagline and overview. The `country` field can be used together with `language` to identify regional variants (for example `fr`/`fr` vs `fr`/`ca`). Use the optional `language` query param to filter to a single language.',
path: '/translations',
method: 'GET',
pathParams: idParamsSchema.merge(languageParamsSchema),
pathParams: idParamsSchema,
query: translationsLanguageQuerySchema,
responses: {
200: translationResponseSchema,
},
Expand Down Expand Up @@ -581,12 +582,12 @@ If you'd like to included translated episode titles and overviews in the respons
translations: {
summary: 'Get all season translations',
description:
'Returns all translations for a season, including language, country, and translated title and overview values.',
path: '/translations/:language',
'Returns all translations for a season, including language, country, and translated title and overview values. Use the optional `language` query param to filter to a single language.',
path: '/translations',
method: 'GET',
pathParams: idParamsSchema
.merge(seasonParamsSchema)
.merge(languageParamsSchema),
.merge(seasonParamsSchema),
query: translationsLanguageQuerySchema,
responses: {
200: translationResponseSchema,
},
Expand Down
Loading