From fe9640e86364d76569ceaafbab14381c6ed08356 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Tue, 24 Sep 2024 16:08:48 +0100 Subject: [PATCH] Ratify TMDb Discover values against TMDbAPIs definitions (#2239) --- CHANGELOG | 2 ++ docs/files/builders/tmdb.md | 20 +++++++++++++------- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index f1bbf21c..9a178190 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -10,6 +10,7 @@ Update setuptools requirement to 74.0.0 # Removed Features # New Features +Introducing the [Kometa Blog](https://blog.kometa.wiki) - a new home for all kometa-related news stories, ranging from showcasing our community creations to providing you with important updates. Added [`letterboxd_user_lists`](https://kometa.wiki/en/latest/files/dynamic_types/#letterboxd-user-lists) Dynamic Collection Type # Updates @@ -34,5 +35,6 @@ Fixed #2195 an image on the docs was a dead link Fixes sort order of resolution collections Fixes #2228 ".any" not accepted for a variety of imdb_search parameters Fixes `streaming` defaults adding and removing items randomly +Fixes missing TMDb Discover parameters Adds error information to help with #2201 Various other Minor Fixes diff --git a/docs/files/builders/tmdb.md b/docs/files/builders/tmdb.md index 672b4adb..b0072591 100644 --- a/docs/files/builders/tmdb.md +++ b/docs/files/builders/tmdb.md @@ -468,14 +468,15 @@ and in a specific order. !!!bug - We have noticed inconsistent responses from TMDb when using `popularity.asc` and `popularity.desc` as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity sort options with `tmdb_discover`**. + We have noticed inconsistent responses from TMDb when using `desc`as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity.desc sort options with `tmdb_discover`**. This bug is on TMDb's side and we are awaiting a fix from them. | Movie Parameters | Description | |:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | Specify how many movies you want returned by the query.
**Type:** Integer
**Default:** 100 | -| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.
**Type:** `^[A-Z]{2}$` | +| `language` | ISO-639-1 or ISO-3166-1 value to display translated data for the fields that support it.
**Type:** String
**Default:** en-US | +| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.
**Type:** `^[A-Z]{2}$` | | `sort_by` | Choose from one of the many available sort options.
**Type:** Any [sort options](#sort-options) below
**Default:** `popularity.desc` | | `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification.
**Type:** String | | `certification` | Filter results with a valid certification from the `certification_country` parameter.
**Type:** String | @@ -505,10 +506,12 @@ and in a specific order. | `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.
**Type:** String | | `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value.
**Type:** Integer | | `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value.
**Type:** Integer | +| `with_origin_country` | Specify an ISO 639-1 string to filter and only include movies that have the given origin country.
**Type:** String | | `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | | `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String | +| `without_watch_providers` | A comma or pipe separated list of watch provider ID's to exclude.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String | | `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String
**Values:** [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | +| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | ### Discover Shows Parameters @@ -520,13 +523,15 @@ and in a specific order. !!!bug - We have noticed inconsistent responses from TMDb when using `popularity.asc` and `popularity.desc` as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity sort options with `tmdb_discover`**. + We have noticed inconsistent responses from TMDb when using `desc`as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity.desc sort options with `tmdb_discover`**. This bug is on TMDb's side and we are awaiting a fix from them. | Show Parameters | Description | |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | Specify how many movies you want to be returned by the query.
**Type:** Integer
**Default:** 100 | +| `language` | ISO-639-1 or ISO-3166-1 value to display translated data for the fields that support it.
**Type:** String
**Default:** en-US | +| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.
**Type:** `^[A-Z]{2}$` | | `sort_by` | Choose from one of the many available sort options.
**Type:** Any [sort options](#sort-options) below
**Default:** `popularity.desc` | | `air_date.gte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | | `air_date.lte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | @@ -534,6 +539,7 @@ and in a specific order. | `first_air_date.lte` | Filter and only include TV shows that have a original air date that is less than or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Date: `MM/DD/YYYY` | | `first_air_date_year` | Filter and only include TV shows that have an original air date year that equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Year: `YYYY` | | `include_null_first_air_dates` | Use this filter to include TV shows that don't have an air date while using any of the `first_air_date` filters.
**Type:** Boolean | +| `include_adult` | A filter and include or exclude adult movies.
**Type:** Boolean | | `timezone` | Used in conjunction with the `air_date.gte/lte` filter to calculate the proper UTC offset.
**Type:** String
**Default:** `America/New_York` | | `vote_count.gte` | Filter and only include TV that have a vote count that is greater or equal to the specified value.
**Type:** Integer | | `vote_count.lte` | Filter and only include TV that have a vote count that is less than or equal to the specified value.
**Type:** Integer | @@ -549,9 +555,9 @@ and in a specific order. | `with_runtime.gte` | Filter and only include TV shows with an episode runtime that is greater than or equal to a value.
**Type:** Integer | | `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value.
**Type:** Integer | | `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | -| `with_name_translation` | Specify a language/country string to filter the results by if the item has a type of name translation.
**Type:** String
**Values:** `ar-AE`, `ar-SA`, `bg-BG`, `bn-BD`, `ca-ES`, `ch-GU`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-US`, `eo-EO`, `es-ES`, `es-MX`, `eu-ES`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ka-GE`, `kn-IN`, `ko-KR`, `lt-LT`, `ml-IN`, `nb-NO`, `nl-NL`, `no-NO`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sl-SI`, `sr-RS`, `sv-SE`, `ta-IN`, `te-IN`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-TW` | | `screened_theatrically` | Filter results to include items that have been screened theatrically.
**Type:** Boolean | | `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String | +| `without_watch_providers` | A comma or pipe separated list of watch provider ID's to exclude.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String | | `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String | | `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | | `with_status` | Filter TV shows by their status.
**Type:** String
Can be a comma (`,`) for an AND, or a pipe (` |`) for an OR separated query
**Values:** `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot | @@ -561,9 +567,9 @@ and in a specific order. !!!bug - We have noticed inconsistent responses from TMDb when using `popularity.asc` and `popularity.desc` as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. + We have noticed inconsistent responses from TMDb when using `desc`as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. - **Due to the nature of this bug, we suggest you do not use the popularity sort options with `tmdb_discover` unless you also set a `limit` of 20 or less**. If you do not set a limit, the data that TMDb returns may be inconsistent.** + **Due to the nature of this bug, we suggest you do not use the popularity.desc sort options with `tmdb_discover` unless you also set a `limit` of 20 or less**. If you do not set a limit, the data that TMDb returns may be inconsistent.** This bug is on TMDb's side that we have made them aware of and are currently awaiting a fix.