Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)

  • Status À investiguer
  • Percent Complete
    0%
  • Task Type Évolution
  • Category Freebox OS → API
  • Assigned To
    rfliedel
  • Operating System Tous
  • Severity Low
  • Priority Very Low
  • Reported Version 3.4.1
  • Due in Version Undecided
  • Due Date Undecided
  • Votes 1
  • Private
Attached to Project: Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)
Opened by zakhar - 04/05/2017
Last edited by 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.

Loading...

Available keyboard shortcuts

Tasklist

Task Details

Task Editing