mirror of
https://github.com/Sonarr/Sonarr.git
synced 2024-11-25 12:12:58 +01:00
Parse endpoint docs
parent
396b811219
commit
3426280700
@ -47,6 +47,7 @@ Where:
|
||||
- [[Images]]
|
||||
- [[Wanted Missing]]
|
||||
- [[Queue]]
|
||||
- [[Parse]]
|
||||
- [[Profile]]
|
||||
- [[Release]]
|
||||
- [[Release/Push|Release-Push]]
|
||||
|
58
API/Parse.md
Normal file
58
API/Parse.md
Normal file
@ -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": []
|
||||
}
|
||||
```
|
@ -52,6 +52,7 @@
|
||||
* [[Images]]
|
||||
* [[Wanted Missing]]
|
||||
* [[Queue]]
|
||||
* [[Parse]]
|
||||
* [[Profile]]
|
||||
* [[Release]]
|
||||
* [[Release/Push|Release-Push]]
|
||||
|
Loading…
Reference in New Issue
Block a user