|
|
# API Documentation
|
|
|
|
|
|
## Les sous-titres
|
|
|
|
|
|
- [Récupérer des sous-titres — **GET /api/subtitles**](#récupérer-des-sous-titres)
|
|
|
- [Ajouter un sous-titre — **POST /api/subtitle**](#ajouter-un-sous-titre)
|
|
|
- [Modifier un sous-titre — **PUT /api/subtitle?id=`{id}`**](#modifier-un-sous-titre)
|
|
|
- [Supprimer un sous-titre — **DELETE /api/subtitle?id=`{id}`**](#supprimer-un-sous-titre)
|
|
|
|
|
|
---
|
|
|
|
|
|
### Récupérer des sous-titres
|
|
|
|
|
|
**GET /api/subtitles**
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **id** : identifiant de l'épisode
|
|
|
- **path** : chemin du sous-titre
|
|
|
- **name** : nom du sous-titre
|
|
|
- **subtitlable** : si vrai, renvoie les éléments *subtitlables* associés
|
|
|
- **limit** : nombre de sous-titres maximum
|
|
|
- **first** : si vrai ne renvoie que le premier élément
|
|
|
|
|
|
---
|
|
|
|
|
|
### Ajouter un sous-titre
|
|
|
|
|
|
**POST /api/subtitle**
|
|
|
|
|
|
#### Permissions
|
|
|
|
|
|
- Post
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **[\*] path** : chemin du sous-titre
|
|
|
- **[\*] name** : nom du sous-titre
|
|
|
- **[\*] type** : type de sous-titre (entre `Film`et `Episode`)
|
|
|
- **[\*] type_id** : identifiant de l'élément associé
|
|
|
- **[\*] lang** : langue du sous-titre
|
|
|
|
|
|
---
|
|
|
|
|
|
### Modifier un sous-titre
|
|
|
|
|
|
**PUT /api/subtitle**
|
|
|
|
|
|
#### Permissions
|
|
|
|
|
|
- Put
|
|
|
|
|
|
#### Paramètres
|
|
|
|
|
|
- **[\*] id** : identifiant du fichier
|
|
|
- **path** : chemin du sous-titre
|
|
|
- **name** : nom du sous-titre
|
|
|
- **subtitlable_id** : identifiant de l'élément associé
|
|
|
- **subtlitlable_type** : type de l'élément associé (`App\Film` ou `App\Episode`)
|
|
|
- **lang** : langue du sous-titre
|
|
|
|
|
|
---
|
|
|
|
|
|
### Supprimer un sous-titre
|
|
|
|
|
|
**DELETE /api/subtitle?id=`{id}`**
|
|
|
|
|
|
#### Permission
|
|
|
|
|
|
- Delete |
|
|
\ No newline at end of file |