|
|
# API Documentation
|
|
|
|
|
|
## Tables
|
|
|
|
|
|
Ici sont listées les tables accessibles par de la base de donnée de Piexel.
|
|
|
|
|
|
---
|
|
|
|
|
|
### actables
|
|
|
|
|
|
Table de liaison polymorphique entre les acteurs et les classes pouvant avoir des acteurs (*i.e. [`App\Film`](#films) ou [`App\Serie`](#series)*). Représente le personnage dans le média dans lequel l'acteur joue.
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
| id | actor\_id | actable\_id | actable\_type | director | writer | character_name |
|
|
|
|----|-----------|-------------|---------------|----------|--------|----------------|
|
|
|
|`INTEGER PRIMARY KEY` |`INTEGER`|`INTEGER`|`VARCHAR(255)`|`BOOLEAN`|`BOOLEAN`|`VARCHAR(255)`|
|
|
|
|
|
|
|
|
|
- **actable_id** : identifiant de l'élément ayant des acteurs
|
|
|
- **actable_type** : type d'objet ([`App\Film`](#films) ou [`App\Serie`](#series))
|
|
|
- **director** : si l'acteur associé est le réalisateur
|
|
|
- **writer** : si l'acteur associé est l'écrivain
|
|
|
- **character_name** : nom de l'acteur dans le média
|
|
|
|
|
|
#### Liaisons
|
|
|
|
|
|
- n — 1 avec **actors**
|
|
|
- n — 1 avec la table actable associée
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### actors
|
|
|
|
|
|
**Objet** : `App\Actor`.
|
|
|
Elle contient l'ensemble des acteurs (des films et des séries).
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
| id | name | tmdb\_id | cover\_img |
|
|
|
|----|------|----------|------------|
|
|
|
|`INTEGER PRIMARY KEY` |`VARCHAR(255)`|`INTEGER`|`VARCHAR(255)`|
|
|
|
|
|
|
|
|
|
- **name** : nom de l'acteur
|
|
|
- **tmdb_id** : identifiant tmdb
|
|
|
- **cover_img** : url de l'image de l'acteur
|
|
|
|
|
|
#### Liaison
|
|
|
|
|
|
- n — n avec les **actables**
|
|
|
|
|
|
---
|
|
|
|
|
|
### broken_links
|
|
|
|
|
|
**Objet** : `App\BrokenLink`.
|
|
|
|
|
|
Contient l'ensemble des liens incorrects informés par les utilisateurs. Cette table possède une liaison polymorphique avec les éléments pouvant avoir des erreurs ([`App\File`](#files), [`App\Film`](#films), [`App\Serie`](#series), `App\Season` et [`App\Episode`](#episodes)).
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
| id | brokable\_id | brokable\_type | treated | created\_at | updated\_at | number\_requests |
|
|
|
|----|------|----------|------------|--|--|--|
|
|
|
|`INTEGER PRIMARY KEY` |`INTEGER`|`VARCHAR(255)`|`BOOLEAN`| `TIMESTAMP` | `TIMESTAMP` | `INTEGER` |
|
|
|
|
|
|
|
|
|
- **brokable_id** : identifiant de l'élément ayant une erreur
|
|
|
- **brokable_type** : objet associé
|
|
|
- **treated** : si la demande à été traitée
|
|
|
- **number_requests** : nombre de personne ayant informé l'erreur
|
|
|
|
|
|
#### Liaison
|
|
|
|
|
|
- n — 1 avec les tables *brokable*
|
|
|
|
|
|
---
|
|
|
|
|
|
### episodes
|
|
|
|
|
|
**Objet** : `App\Episode`.
|
|
|
|
|
|
Cette table recense l'ensemble des épisodes.
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
| id | title | summary | treated | serie\_id | season\_id | cover\_img
|
|
|
|----|------|----------|------------|--|--|--|
|
|
|
|`INTEGER PRIMARY KEY` | `VARCHAR(255)` | `LONGTEXT`|`INTEGER`| `INTEGER` | `INTEGER` | `VARCHAR(255)` |
|
|
|
|
|
|
|
|
|
|tmdb\_id|episode|rating|release_date|
|
|
|
|--|--|--|--|
|
|
|
|`INTEGER`|`INTEGER`|`VARCHAR(255)`|`DATE`|
|
|
|
|
|
|
|
|
|
- **title** : titre de l'épisode
|
|
|
- **summary** : résumé de l'épisode
|
|
|
- **serie_id** : identifiant de la [série](#series) liée à l'épisode
|
|
|
- **season_id** : identifiant de la saison à laquelle appartient l'épisode
|
|
|
- **cover_img** : url de l'image de pochette
|
|
|
- **episode** : numéro de l'épisode
|
|
|
- **rating** : note
|
|
|
|
|
|
#### Liaisons
|
|
|
|
|
|
- n — 1 avec [**series**](#series)
|
|
|
- n — 1 avec **seasons**
|
|
|
|
|
|
---
|
|
|
|
|
|
### files
|
|
|
|
|
|
**Objet** : `App\File`.
|
|
|
|
|
|
Liste l'ensemble des fichiers disponibles. Possède une liaison polymorphique avec [`App\Film`](#films) et [`App\Episode`](#episodes).
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
|id|path|name|filable\_id|filable\_type |
|
|
|
|--|--|--|--|--|
|
|
|
|`INTEGER PRIMARY KEY`|`VARCHAR(255)`|`VARCHAR(255)`|`INTEGER`|`VARCHAR(3)`|
|
|
|
|
|
|
|
|
|
- **path** : chemin vers le fichier
|
|
|
- **name** : nom du fichier
|
|
|
- **filable_id** : identifiant de l'élément pouvant avoir un fichier
|
|
|
- **filable_type** : objet associé
|
|
|
|
|
|
#### Liaison
|
|
|
|
|
|
- 1 — n avec les tables *filable*.
|
|
|
|
|
|
---
|
|
|
|
|
|
### films
|
|
|
|
|
|
**Objet** : `App\Film`.
|
|
|
|
|
|
Ensemble des films présents sur Piexel.
|
|
|
|
|
|
### Colonnes
|
|
|
|
|
|
|id|title|title\_vo|tmdb\_id|summary |cover\_img|
|
|
|
|--|--|--|--|--|
|
|
|
|`INTEGER PRIMARY KEY`|`VARCHAR(255)`|`VARCHAR(255)`|`INTEGER`|`LONGTEXT`|`VARCHAR(255)`|
|
|
|
|
|
|
|
|
|
|background\_img|rating | runtime|release\_date |
|
|
|
|--|--|--|--|
|
|
|
|`VARCHAR(255)`|`VARCHAR(3)`|`INTEGER`|`DATE`|
|
|
|
|
|
|
|
|
|
- **title** : titre du film
|
|
|
- **tmdb_id** : identifiant tmdb du film
|
|
|
- **summary** : résumé du film
|
|
|
- **cover_img** : url de l'image de pochette
|
|
|
- **background_img** : url de l'image de fond u film
|
|
|
- **rating** : note du film
|
|
|
- **runtime** : durée du film
|
|
|
- **release_date** : date de sortie
|
|
|
|
|
|
---
|
|
|
|
|
|
### series
|
|
|
|
|
|
**Objet** : `App\Serie`.
|
|
|
|
|
|
Ensemble des séries.
|
|
|
|
|
|
#### Colonnes
|
|
|
|
|
|
| id | title | status | summary | tmdb\_id |
|
|
|
|--|--|--|--|--|--|--|--|--|
|
|
|
| `INTEGER` | `VARCHAR(255)` | `VARCHAR(255)` | `LONGTEXT` | `INTEGER` |
|
|
|
|
|
|
|cover\_img | background\_img | rating |release\_date |
|
|
|
|--|--|--|--|
|
|
|
| `VARCHAR(255)` | `VARCHAR(255)` | `VARCHAR(3)` | `DATE` |
|
|
|
|
|
|
|
|
|
- **status** : status de la série (en cours, arrêté, ...)
|
|
|
|
|
|
#### Liaisons
|
|
|
|
|
|
- 1 — n avec **seasons**
|
|
|
- 1 — n avec [**episodes**](#episodes) |
|
|
\ No newline at end of file |