- État À investiguer
- Pourcentage achevé
- Type Évolution
- Catégorie Freebox OS → API
-
Assignée à
rfliedel - Système d'exploitation Tous
- Sévérité Basse
- Priorité Très Basse
- Basée sur la version 3.4.1
- Due pour la version Non décidée
-
Échéance
Non décidée
-
Votes
1
- akdm (07/07/2021)
- Privée
Ouverte par zakhar - 04/05/2017
Dernière modification par mbizon - 04/09/2020
FS#21466 - Rendre la documentation plus claire concernant les headers à envoyer aux API
Suite au bug : External Linkhttps://dev.freebox.fr/bugs/task/21461
Il apparaît que depuis la version 4 des API, certains appels nécessitent vraiment le header
Content-type: application/json
pour fonctionner correctement.
En effet, ce header est bien mentionné (71 fois) pour les réponses, mais jamais clairement pour les requêtes (juste 1 fois pour expliquer qu’il ne faut PAS l’envoyer dans un cas précis).
Cela n’est indiqué nulle part en clair dans la documentation.
Je suggère donc (améliorations) que la documentation mentionne cette “bonne pratique” (puisque en réalité 99% des API fonctionnent néanmoins, mais ce n’est effectivement pas 100% fiable).
Cela pourrait figurer dans la section d’introduction, en donnant des modèles de ‘curl’ par exemple.
Une documentation plus précise est en effet à même d’aider les futurs développeurs en leur évitant de tomber dans des bugs bizarres comme celui signalé plus haut.
Chargement...
Activer les raccourcis clavier
- Alt + ⇧ Shift + l Se connecter/Se déconnecter
- Alt + ⇧ Shift + a Ouvrir une tâche
- Alt + ⇧ Shift + m Mes recherches
- Alt + ⇧ Shift + t Rechercher par ID de tâche
Liste des tâches
- o Ouvrir la tâche sélectionnée
- j Déplacer le curseur vers le bas
- k Déplacer le curseur vers le haut
Détails de la tâche
- n Tâche suivante
- p Tâche précédente
- Alt + ⇧ Shift + e ↵ Enter Modifier cette tâche
- Alt + ⇧ Shift + w Surveiller
- Alt + ⇧ Shift + y Fermer cette tâche
Édition de la tâche
- Alt + ⇧ Shift + s Enregistrer la tâche