diff --git a/API/API.md b/API/API.md index 320aaf7..277b054 100644 --- a/API/API.md +++ b/API/API.md @@ -47,6 +47,7 @@ Where: - [[Images]] - [[Wanted Missing]] - [[Queue]] +- [[Parse]] - [[Profile]] - [[Release]] - [[Release/Push|Release-Push]] diff --git a/API/Parse.md b/API/Parse.md new file mode 100644 index 0000000..549c8e0 --- /dev/null +++ b/API/Parse.md @@ -0,0 +1,58 @@ +**Endpoint: "/parse"** + +## GET ## + +##### Summary ##### +Returns the result of parsing a title or path. `series` and `episodes` will be returned only if the parsing matches to a specific series and one or more episodes. `series` and `episodes` will be formatted the same as [[Series]] and [[Episode]] responses. + +##### Parameters ###### + +Required: + +`title (string)` + +or + +`path (string)` + +##### Response ##### +```JSON + +{ + "title": "Series.Title.S01E01.720p.HDTV-Sonarr", + "parsedEpisodeInfo": { + "releaseTitle": "Series.Title.S01E01.720p.HDTV-Sonarr", + "seriesTitle": "Series Title", + "seriesTitleInfo": { + "title": "Series Title", + "titleWithoutYear": "Series Title", + "year": 0 + }, + "quality": { + "quality": { + "id": 4, + "name": "HDTV-720p" + }, + "revision": { + "version": 1, + "real": 0 + } + }, + "seasonNumber": 1, + "episodeNumbers": [ + 1 + ], + "absoluteEpisodeNumbers": [], + "language": "english", + "fullSeason": false, + "special": false, + "releaseGroup": "Sonarr", + "releaseHash": "", + "isDaily": false, + "isAbsoluteNumbering": false, + "isPossibleSpecialEpisode": false + }, + "series": {}, + "episodes": [] +} +``` diff --git a/_Sidebar.md b/_Sidebar.md index b705da3..10f4cca 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -52,6 +52,7 @@ * [[Images]] * [[Wanted Missing]] * [[Queue]] +* [[Parse]] * [[Profile]] * [[Release]] * [[Release/Push|Release-Push]]