|
|
# API Documentation
|
|
|
|
|
|
## Les fichiers
|
|
|
|
|
|
- [Récupérer des fichiers — **GET /api/files**](#récupérer-des-fichiers)
|
|
|
- [Ajouter un fichier — **POST /api/file**](#ajouter-un-fichier)
|
|
|
- [Modifier un fichier — **PUT /api/file?id=`{id}`**](#modifier-un-fichier)
|
|
|
- [Supprimer un fichier — **DELETE /api/file?id=`{id}`**](#supprimer-un-fichier)
|
|
|
|
|
|
---
|
|
|
|
|
|
### Récupérer des fichiers
|
|
|
|
|
|
**GET /api/files**
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **id** : identifiant de l'épisode
|
|
|
- **like** : si renseigné, le chemin recherché sera approximatif
|
|
|
- **path** : chemin du fichier
|
|
|
- **name** : nom du fichier
|
|
|
- **filable** : si vrai, renvoie les éléments *filables* associés
|
|
|
- **limit** : nombre de fichiers maximum
|
|
|
- **first** : si vrai ne renvoie que le premier élément
|
|
|
|
|
|
#### Exemple
|
|
|
|
|
|
Récupérer 1 fichier dans luigi.rez/Movies/1960-1969 avec le filable associé
|
|
|
|
|
|
```
|
|
|
GET /api/files?like=1&path=luigi.rez/Movies/1960-1969&limit=1&filable=1
|
|
|
|
|
|
[
|
|
|
{
|
|
|
"id": 1280,
|
|
|
"path": "ftp://luigi.rez/Movies/1960-1969",
|
|
|
"name": "2001 A Space Odyssey [1968].mkv",
|
|
|
"filable_id": 1026,
|
|
|
"filable_type": "App\\Film",
|
|
|
"languages": [
|
|
|
{
|
|
|
"id": 1,
|
|
|
"value": "N/A",
|
|
|
"pivot": {
|
|
|
"file_id": 1280,
|
|
|
"language_id": 1
|
|
|
}
|
|
|
}
|
|
|
],
|
|
|
"qualities": [
|
|
|
{
|
|
|
"id": 1,
|
|
|
"value": "N/A",
|
|
|
"pivot": {
|
|
|
"file_id": 1280,
|
|
|
"quality_id": 1
|
|
|
}
|
|
|
}
|
|
|
],
|
|
|
"subtitle_languages": [
|
|
|
{
|
|
|
"id": 1,
|
|
|
"value": "N/A",
|
|
|
"pivot": {
|
|
|
"file_id": 1280,
|
|
|
"subtitle_language_id": 1
|
|
|
}
|
|
|
}
|
|
|
],
|
|
|
"filable": {
|
|
|
"id": 1026,
|
|
|
"title": "2001 : L'Odyssée de l'espace",
|
|
|
"title_vo": "2001: A Space Odyssey",
|
|
|
"tmdb_id": "62",
|
|
|
"imdb_id": "tt0062622",
|
|
|
"summary": "A l'aube de l'humanité, des singes anthropoïdes vivent dans un milieu hostile et violent. Quelques-uns d'entre eux découvrent un jour un énigmatique monolithe noir, tombé du ciel, qui semble modifier leur comportement. Soudain inspiré, l'un de ces primates crée le premier outil avec un os et s'en sert pour chasser et se défendre. Des millénaires plus tard, en 2001, le docteur Heywood Floyd se dirige vers la Lune à bord d'un vaisseau spatial. Il est chargé d'une mission confidentielle : il doit enquêter sur un monolithe découvert au cours de fouilles dans le cirque lunaire de Tycho. Selon les premières observations, l'objet émettrait un signal mystérieux...",
|
|
|
"cover_img": "http://image.tmdb.org/t/p/w185/yIAINtrQPfHuzIUI56i93fhK8qP.jpg",
|
|
|
"rating": "7.8",
|
|
|
"runtime": 160,
|
|
|
"release_date": "1968-04-05 00:00:00",
|
|
|
"background_img": "http://image.tmdb.org/t/p/original/pckdZ29bHj11hBsV3SbVVfmCB6C.jpg"
|
|
|
}
|
|
|
}
|
|
|
]
|
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
### Ajouter un fichier
|
|
|
|
|
|
**POST /api/file**
|
|
|
|
|
|
#### Permissions
|
|
|
|
|
|
- Post
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **[\*] path** : chemin du fichier
|
|
|
- **[\*] name** : nom du fichier
|
|
|
- **[\*] type** : type de fichier (entre `Film`et `Episode`)
|
|
|
- **[\*] type_id** : identifiant de l'élément associé
|
|
|
|
|
|
#### Exemple
|
|
|
|
|
|
Ajouter un nouveau fichier pour 2001 : L'Odyssée de l'espace :
|
|
|
|
|
|
```
|
|
|
POST /api/file?path=ftp://luigi.rez/Movies/IMDB+Top+Films&name=2001+A+Space+Odyssey+[1968].mkv&type=Film&type_id=1026
|
|
|
|
|
|
{
|
|
|
"path": "http://rez:rez@luigi.rez/Movies/IMDB Top Films",
|
|
|
"name": "2001 A Space Odyssey [1968].mkv",
|
|
|
"filable_id": 1026,
|
|
|
"filable_type": "App\\Film",
|
|
|
"id": 1368,
|
|
|
"filable": {
|
|
|
"id": 1026,
|
|
|
"title": "2001 : L'Odyssée de l'espace",
|
|
|
"title_vo": "2001: A Space Odyssey",
|
|
|
"tmdb_id": "62",
|
|
|
"imdb_id": "tt0062622",
|
|
|
"summary": "A l'aube de l'humanité, des singes anthropoïdes vivent dans un milieu hostile et violent. Quelques-uns d'entre eux découvrent un jour un énigmatique monolithe noir, tombé du ciel, qui semble modifier leur comportement. Soudain inspiré, l'un de ces primates crée le premier outil avec un os et s'en sert pour chasser et se défendre. Des millénaires plus tard, en 2001, le docteur Heywood Floyd se dirige vers la Lune à bord d'un vaisseau spatial. Il est chargé d'une mission confidentielle : il doit enquêter sur un monolithe découvert au cours de fouilles dans le cirque lunaire de Tycho. Selon les premières observations, l'objet émettrait un signal mystérieux...",
|
|
|
"cover_img": "http://image.tmdb.org/t/p/w185/yIAINtrQPfHuzIUI56i93fhK8qP.jpg",
|
|
|
"rating": "7.8",
|
|
|
"runtime": 160,
|
|
|
"release_date": "1968-04-05 00:00:00",
|
|
|
"background_img": "http://image.tmdb.org/t/p/original/pckdZ29bHj11hBsV3SbVVfmCB6C.jpg"
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
### Ajouter ou enlever une langue au fichier
|
|
|
|
|
|
#### Permission
|
|
|
|
|
|
- moderator
|
|
|
|
|
|
#### Routes
|
|
|
|
|
|
Ajouter une langue
|
|
|
**POST /api/languages/`{file}`/attach?value=`{value}`**
|
|
|
|
|
|
Enlever une langue
|
|
|
**POST /api/languages/`{file}`/detach?value=`{value}`**
|
|
|
|
|
|
Tout enlever
|
|
|
**POST /api/languages/`{file}`/detach-all**
|
|
|
|
|
|
`{value}` doit être une valeur de langue disponible.
|
|
|
|
|
|
---
|
|
|
|
|
|
### Ajouter ou enlever un sous-titre au fichier
|
|
|
|
|
|
#### Permission
|
|
|
|
|
|
- moderator
|
|
|
|
|
|
#### Routes
|
|
|
|
|
|
Ajouter un sous-titre
|
|
|
**POST /api/subtitle-languages/`{file}`/attach?value=`{value}`**
|
|
|
|
|
|
Enlever un sous-titre
|
|
|
**POST /api/subtitle-languages/`{file}`/detach?value=`{value}`**
|
|
|
|
|
|
Tout enlever
|
|
|
**POST /api/subtitle-languages/`{file}`/detach-all**
|
|
|
|
|
|
`{value}` doit être une valeur de sous-titre disponible.
|
|
|
|
|
|
---
|
|
|
|
|
|
### Ajouter ou enlever une qualité au fichier
|
|
|
|
|
|
#### Permission
|
|
|
|
|
|
- moderator
|
|
|
|
|
|
#### Routes
|
|
|
|
|
|
Ajouter une qualité
|
|
|
**POST /api/qualities/`{file}`/attach?value=`{value}`**
|
|
|
|
|
|
Enlever une qualité
|
|
|
**POST /api/qualities/`{file}`/detach?value=`{value}`**
|
|
|
|
|
|
Tout enlever
|
|
|
**POST /api/qualities/`{file}`/detach-all**
|
|
|
|
|
|
`{value}` doit être une valeur de qualité disponible.
|
|
|
|
|
|
---
|
|
|
|
|
|
### Modifier un fichier
|
|
|
|
|
|
**PUT /api/file**
|
|
|
|
|
|
#### Permissions
|
|
|
|
|
|
- Put
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **[\*] id** : identifiant du fichier
|
|
|
- **path** : chemin du fichier
|
|
|
- **name** : nom du fichier
|
|
|
- **filable_id** : identifiant de l'élément associé
|
|
|
- **filable_type** : type de l'élément associé (`App\Film` ou `App\Episode`)
|
|
|
|
|
|
---
|
|
|
|
|
|
### Supprimer un fichier
|
|
|
|
|
|
**DELETE /api/file?id=`{id}`**
|
|
|
|
|
|
#### Permission
|
|
|
|
|
|
- Delete
|
|
|
|
|
|
#### Exemple
|
|
|
|
|
|
Suppression du fichier de 2001 : L'Odyssée de l'espace précédemment ajouté :
|
|
|
|
|
|
```
|
|
|
DELETE /api/file?id=1368
|
|
|
|
|
|
{
|
|
|
"success": true,
|
|
|
"message": "File deleted"
|
|
|
}
|
|
|
``` |
|
|
\ No newline at end of file |