Skip to content
Aura Live Documentation

Changelog
All versions

Version 0.2.1 Latest

Résumé Général

La nouvelle version de l’API est une mise à jour majeure axée sur l’expérience utilisateur. Les changements les plus significatifs incluent :

  • Suppression des Endpoints d’Administration : Toutes les routes de création, modification et suppression des ressources de base (modèles, langues, utilisateurs) ont été retirées de cette spécification pour la rendre purement orientée utilisateur.
  • Nouvelle Méthode d’Authentification : Le système d’authentification a été revu.
  • Standardisation des URLs : Les chemins des endpoints ont été simplifiés et rendus plus cohérents.
  • Introduction de la Pagination : Les listes de ressources sont désormais paginées pour de meilleures performances.
  • Enrichissement des Modèles de Données : Les réponses de l’API sont maintenant plus détaillées et mieux documentées.

❗ Changements Cassants (Breaking Changes)

Ces changements nécessiteront des modifications dans toute intégration existante.

1. Authentification

  • L’ancien mécanisme de sécurité ApiKeyAuth qui utilisait l’en-tête Authorization a été supprimé.
  • La nouvelle version utilise bearerAuth (pour les jetons JWT) et apiKeyHeader qui attend une clé dans l’en-tête X-API-Key.

2. Structure des URLs

  • Le préfixe /api/v1 a été retiré de tous les chemins et fait maintenant partie de l’URL du serveur (https://aura.authot.live/backend/api/v1).
  • Les identifiants dans les chemins ont été standardisés en {id} (ex: /models/{modelId} devient /models/{id}).
  • Des slashes de fin ont été ajoutés à plusieurs routes pour plus de cohérence (ex: /languages devient /languages/).

3. Endpoints Supprimés

  • Tous les endpoints d’administration ont été supprimés de cette documentation, notamment :
    • POST, PUT, DELETE sur /languages
    • POST, PUT, DELETE sur /models
    • POST, PUT, DELETE sur /translations
    • POST /users, POST /setup/initial-admin
    • POST /settings
  • Les endpoints utilisateurs suivants ont été supprimés :
    • GET /api/v1/ping (maintenant /ping mais le préfixe a changé)
    • GET /api/v1/lives/1/save
    • GET /api/v1/lives/1/saves/
    • GET /api/v1/live_translations/{liveTranslationId}/save

4. Structure des Réponses

  • Les endpoints qui retournent des listes (comme GET /languages/) n’utilisent plus un champ count. Ils retournent maintenant un objet pagination contenant total_items, total_pages, current_page, et per_page.

5. Paramètres de Requête Modifiés

  • GET /languages/ : Le paramètre de filtre active a été supprimé.
  • GET /models : Le paramètre de filtre active a été supprimé.
  • GET /settings : Les paramètres user_id et username ont été supprimés. L’endpoint retourne désormais les paramètres de l’utilisateur authentifié.

✨ Nouvelles Fonctionnalités (Ajouts)

1. Nouveaux Endpoints

De nouveaux endpoints GET ont été ajoutés pour récupérer une ressource unique par son identifiant :

  • GET /languages/{id} : Récupérer une langue spécifique.
  • GET /models/{id} : Récupérer un modèle spécifique.
  • GET /translations/{id} : Récupérer une paire de traduction spécifique.
  • GET /tokens/{id} : Récupérer un jeton d’API spécifique.

2. Pagination

  • Les endpoints de listage suivants supportent désormais la pagination avec les paramètres de requête skip et limit :
    • GET /languages/
    • GET /models/
    • GET /translations/
    • GET /user-live-configs/
    • GET /tokens/
    • GET /lives/

3. Documentation WebSocket

  • Une nouvelle section Websocket a été ajoutée pour documenter en détail le fonctionnement de l’API temps réel.

✏️ Modifications et Améliorations

1. Schémas de Données

  • Les modèles de données (schemas) sont maintenant formellement définis et très détaillés, avec des descriptions claires pour chaque champ. Cela améliore considérablement la clarté et la prévisibilité de l’API.
  • Les réponses pour les sessions live (Live), les traductions (Translation) et autres sont beaucoup plus riches et incluent des objets imbriqués pour les modèles et les langues.

2. Simplification des Endpoints

  • GET /settings : A été simplifié pour ne plus prendre de paramètres et retourner directement la configuration de l’utilisateur connecté.

3. Codes de Réponse HTTP

  • Les opérations DELETE retournent maintenant un code de statut 204 No Content, ce qui est une pratique plus standard pour les suppressions réussies sans contenu à retourner.

4. Métadonnées de l’API

  • Le titre de l’API a été changé de “Aura Live” à “User”.
  • La version d’OpenAPI est passée de 3.0.3 à 3.0.1.
  • L’URL du serveur a été mise à jour.