search

sct / overseerr

Request management and media discovery tool for the Plex ecosystem
https://overseerr.dev
MIT License
3.54k stars 412 forks source link

Standardise the API #3837

Open marksie1988 opened 3 months ago

marksie1988 commented 3 months ago

Description

The API has some inconsistancies between the schemas. for example, TV and Movie both use the SpokenLanguages but both have different field names:

class SpokenLanguagesModelTv(BaseModel):
    """
    Data class representing a spoken language.
    """

    englishName: str
    iso_639_1: str
    name: str

class SpokenLanguagesModelMovie(BaseModel):
    """
    Data class representing a spoken language.
    """

    english_name: str
    iso_639_1: str
    name: str

Desired Behavior

standardise schemas where it makes sense, the english name should either be "englishName" or "english_name" allowing the same schema for both TV and Movie for easier use of the API

Additional Context

No response

Code of Conduct

marksie1988 commented 2 months ago

FYI I'm happy to look at implementing this but as it's a change to the API that would be breaking it would be good to get some input.

As I assume if following conventional commit it would cause a move to v2. Just want to know if that is correct for this project.