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.

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

Jump to bottom

Added endpoint to retrieve movie data #595

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Added endpoint to retrieve movie data #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0f814c3
Added endpoint to retrieve movie data. Furthermore, I have added HTTP…
JVT038 Feb 28, 2024
0db3762
Centralize authentication process
JVT038 Mar 2, 2024
eca3498
Rename userid to user
JVT038 Mar 2, 2024
ef32ca7
Add method to find user by API token
JVT038 Mar 2, 2024
9ad9a0d
Reorder authentication priority and fix authenticationMethod
JVT038 Mar 2, 2024
396eb33
Fix type
JVT038 Nov 30, 2024
aa9a7e4
Merge branch 'refs/heads/main' into refactor-authentication-api
JVT038 Nov 30, 2024
2bd71c5
Fix breaking error
JVT038 Nov 30, 2024
ddc753d
Merge remote-tracking branch 'origin/main' into add-movie-data-endpoint
JVT038 Dec 1, 2024
a415c20
Merge branch 'refactor-authentication-api' into add-movie-data-endpoint
JVT038 Dec 1, 2024
2a23ddb
Fix variable
JVT038 Dec 1, 2024
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
222 changes: 222 additions & 0 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,6 +985,222 @@
]
}
},
"/movies/{id}": {
"get": {
"tags": [
"Movies"
],
"summary": "Get movie data",
"description": "Get the data of a specific movie based on their Movary ID",
"parameters": [
{
"$ref": "#/components/schemas/id"
}
],
"responses": {
"200": {
"description": "Movie ID is valid and the movie was found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"movie": {
"description": "Movie object",
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"tmdbId": {
"$ref": "#/components/schemas/idNullable"
},
"imdbId": {
"type": "string",
"nullable": true,
"example": "tt12345678"
},
"title": {
"$ref": "#/components/schemas/title"
},
"releaseDate": {
"$ref":"#/components/schemas/releaseDateNullable"
},
"posterPath": {
"$ref": "#/components/schemas/posterPath"
},
"tagline": {
"$ref": "#/components/schemas/movie/properties/tagline"
},
"overview": {
"$ref": "#/components/schemas/overview"
},
"runtime": {
"$ref": "#/components/schemas/movie/properties/runtime"
},
"imdbUrl": {
"type": "string",
"description": "URL of the movie in IMDb",
"nullable": true
},
"imdbRatingAverage": {
"type": "string",
"description": "Average rating of movie on IMDb",
"nullable": true
},
"imdbRatingVoteCount": {
"type": "string",
"description": "Amount of ratings of movie in IMDb",
"nullable": true
},
"tmdbUrl": {
"type": "string",
"description": "The URL of the movie on TMDB",
"nullable": true
},
"tmdbRatingAverage": {
"type": "number",
"description": "Average rating of movie on TMDB",
"nullable": true
},
"tmdbRatingVotecount": {
"type": "string",
"description": "Amount of ratings of movie in TMDB",
"nullable": true
},
"originalLanguage": {
"type": "string",
"description": "Original language of movie",
"nullable": true,
"example": "English"
}
}
},
"movieGenres": {
"type": "array",
"properties": {
"genre": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the genre"
}
}
}
},
"example": [
{
"name": "Genre 1"
},
{
"name": "Genre 2"
}
]
},
"castMembers": {
"type": "array",
"properties": {
"castMember": {
"type": "object",
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "Name of the cast member"
},
"posterPath": {
"$ref": "#/components/schemas/posterPath"
},
"characterName": {
"type": "string",
"description": "Name of the character this cast member played in the movie"
}
}
},
"example": [
{
"id": 1,
"name": "Name 1",
"posterPath": "/path/to/poster1.jpg",
"characterName": "Character name 1"
},
{
"id": 2,
"name": "Name 2",
"posterPath": "/path/to/poster2.jpg",
"characterName": "Character name 2"
}
]
},
"directors": {
"type": "array",
"properties": {
"director": {
"type": "object",
"description": "The director",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"name": {
"type": "string",
"description": "Name of the director"
},
"posterPath": {
"$ref": "#/components/schemas/posterPath"
}
}
}
}
},
"totalPlays": {
"$ref": "#/components/schemas/playsOptional"
},
"watchDates": {
"type": "array",
"properties": {
"date": {
"$ref": "#/components/schemas/dateNullable"
}
}
},
"isOnWatchList": {
"type": "boolean",
"description": "True if on watchlist, false if not, and null if no token has been sent in the request header..",
"nullable": true
},
"countries": {
"type": "object",
"properties": {
"ISOCode": {
"type": "object",
"description": "2-Letter ISO code of country, with as value their full name",
"example": {
"US": "United States"
}
}
},
"example": {
"AF": "Afghanistan",
"AL": "Albania"
}
},
"displayCharacterNames": {
"type": "boolean"
}
}
}
}
}
},
"404": {
"description": "Movie was not found"
}
}
}
},
"/webhook/plex/{uuid}": {
"post": {
"tags": [
Expand Down Expand Up @@ -1396,6 +1612,12 @@
"example": 1,
"nullable": false
},
"posterPath": {
"type": "string",
"description": "The path to the poster",
"nullable": true,
"example": "/storage/images/itemtype/1.jpg"
},
"positionOptional": {
"type": "number",
"example": 1,
Expand Down
3 changes: 2 additions & 1 deletion settings/routes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,8 @@ function addApiRoutes(RouterService $routerService, FastRoute\RouteCollector $ro
$routes->add('DELETE', $routeUserPlayed, [Api\PlayedController::class, 'deleteFromPlayed'], [Api\Middleware\IsAuthorizedToWriteUserData::class]);
$routes->add('PUT', $routeUserPlayed, [Api\PlayedController::class, 'updatePlayed'], [Api\Middleware\IsAuthorizedToWriteUserData::class]);

$routes->add('GET', '/movies/search', [Api\MovieSearchController::class, 'search'], [Api\Middleware\IsAuthenticated::class]);
$routes->add('GET', '/movies/search', [Api\MovieController::class, 'search'], [Api\Middleware\IsAuthenticated::class]);
$routes->add('GET', '/movies/{id:\d}', [Api\MovieController::class, 'getMovie']);

$routes->add('POST', '/webhook/plex/{id:.+}', [Api\PlexController::class, 'handlePlexWebhook']);
$routes->add('POST', '/webhook/jellyfin/{id:.+}', [Api\JellyfinController::class, 'handleJellyfinWebhook']);
Expand Down
Loading
Loading