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

docs: add API datasources #5

Merged
merged 1 commit into from
Oct 24, 2022
Merged
Changes from all commits
Commits
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
55 changes: 52 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,46 +48,95 @@ This app uses the API of the [The Movie Database](https://www.themoviedb.org/?la

## Requirements

### Functional Requirements
### Functional Requirements + possible API Datasources

* The user must be able to search for movies and series by its title.
* API: /search/multi for searching movies, tv show and people (responds: title, image path, genres, ...)
* API: /search/tv for search tv shows (responds: title, image path, genres, ...)
* API: /search/movie for search movies (responds: title, image path, genres, ...)
* The user must be able to filter his search results for the movies and series by the release year, the region and the genres.
* API: /search/multi can't filter for the year and for the genres
* API: /search/tv can't filter for the genres and the region
* API: /search/movie can't filter for the genres
* API: /discover/movie has all required filters but can't take the title for search
* API: /discover/tv has all required filters but can't take the title for search
* The user must be able to view the following details of a movie:
* Title
* API: part of search result
* Year
* API: part of search result
* Genres
* API: /movie/{id}
* User Rating / IMDB Rating
* API: part of search result (TMDB reviews)
* API: /movie/{id}/external_ids -> query IMDB (for IMDB reviews)
* Length of the Movie
* API: /movie/{id}
* Description of the Plot
* API: /movie/{id}
* Release Date
* API: part of search result
* Budget
* API: /movie/{id}
* Revenue
* API: /movie/{id}
* Director, Writer, ...
* API: /movie/{id}?append_to_response=credits or /movie/{id]/credits
* The Platforms on which the movie is available in your current country
* API: /movie/{id}/watch/providers
* Cast
* API: same as Director, Writer, ...
* Poster / Thumbnail
* API: part of search result + query image.tmdb.org
* The user must be able to view the following details of a series:
* Title
* API: part of search result
* Year
* API: part of search result
* Genres
* API: /tv/{id}
* User Rating / IMDB Rating
* API: part of search result (TMDB reviews)
* API: /tv/{id}/external_ids -> query IMDB (for IMDB reviews)
* Length of a typical episode
* API: /tv/{id} average of first and last episode or calculate average of all episodes and seasons
* Description of the Plot
* API: /tv/{id}
* Release Date
* API: /tv/{id}
* Director, Writer, Creators, ...
* API: /tv/{id}?append_to_response=credits or /tv/{id]/credits
* The Platforms on which the movie is available in your current country
* Seasons inlcuding their release year, their number of episodes and the description
* API: /tv/{id}/watch/providers
* Seasons including their release year, their number of episodes and the description
* API: /tv/{id} (for all seasons except the description)
* API: /tv/{id}/season/ (for the description of one season)
* Cast
* API: same as Director, Writer, ...
* Poster / Thumbnail
* API: part of search result + query image.tmdb.org
* The user must be able to search for actors by their names.
* API: /search/multi for searching movies, tv show and people
* API: /search/person
* The user must be able to filter his search results for the actors by TODO
* API: /discover can filter for people but not for one specific title
* API: /person/{id}/movie_credits can be a datasource for movies in which the person was
* API: /person/{id}/tv_credits can be a datasource for tv shows in which the person was
* The user must be able to view the following details for an actor:
* Movies and series in which the actor had screen time
* API: /person/{id}/movie_credits
* API: /person/{id}/tv_credits
* Name
* API: part of search result
* Biography
* API: /person/{id}
* Profile Picture
* API: part of search result + query image.tmdb.org
* The user must be able to add a movie or a series to his own watchlist.
* API: POST /list + POST /list/{id}(add_item)
* The user must be able to view the movies or series in his watchlist.
* API: /list/{id}
* The user must be able to remove movies or series from his watchlist.
* API: POST /list/{id}/remove_item

© 2018 – 2019 [Patrick](https://github.com/patdujmo), [Daniel](https://github.com/linxside), [Ansgar](https://github.com/AnsgarLichter)
© 2018 – 2022 [Patrick](https://github.com/patdujmo), [Daniel](https://github.com/linxside), [Ansgar](https://github.com/AnsgarLichter)