Skip to content
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.

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

Standardise the API #3837

Open
1 task done
marksie1988 opened this issue Apr 4, 2024 · 1 comment
Open
1 task done

Standardise the API #3837

marksie1988 opened this issue Apr 4, 2024 · 1 comment

Comments

@marksie1988
Copy link

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

  • I agree to follow Overseerr's Code of Conduct
@marksie1988
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant