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

  • État Fermée
  • Pourcentage achevé
    100%
  • Type Anomalie
  • Catégorie Freebox OS → API
  • Assignée à Personne
  • Système d'exploitation Freebox Server V6 (Révolution)
  • Sévérité Moyenne
  • Priorité Très Basse
  • Basée sur la version 2.0.2
  • Due pour la version Non décidée
  • Échéance Non décidée
  • Votes
  • Privée

FS#13052 - Clarification de la version de "Freebox OS developer API"

D’abord une imprécision:
Sur la page “Freebox OS developer API” située ici http://dev.freebox.fr/sdk/os/, dans le chapitre “Discovery using HTTP” la version de l’API donnée dans l’exemple est api_version: “1.0”.
Cela pourrait sous-entendre au travers des guillemets que api_version est de type string or l’exemple du chapitre suivant “Building the API request URL” (et de nombreux autres dans la documentation) tend à démontrer que ce jeton est de type number.
L’implémentation en 2.0.2 le renvoie entre guillement mais l’usage demandé par la documentation (cf. paragraphe “API Version” de la même page “Current API version is: 1”) et par le logiciel voudrait que nous l’utilisions en number converti en entier uniquement.
.
Donc qu’en est-il? Devons-nous lui donner un type entier, réel(équivalent number), texte pour sa stabilité dans le temps?

De même une “anomalie” est glissée dans l’exemple concernant l’échappement de “api_base_url”: “/api/”; il devrait être consigné “api_base_url”:”\/api\/”. Dès lors le chapitre suivant devrait, au lieu d’indiquer “http://[freebox_ip]:[freebox_port]/[api_base_url]/v[api_version]/[api_url]”, faire apparaître “http://[freebox_ip]:[freebox_port][api_base_url]v[api_version]/[api_url].

Enfin l’usage des guillemets sur les identifiants des objets est largement incorrect dans la documentation, l’implémentation elle intègre les guillemets, conformément à du JSON courant.

Fermée par  rfliedel
14.08.2013 14:04
Raison de la fermeture :  Evolution intégrée
Admin
rfliedel a commenté le 14.08.2013 14:03

J’ai ajouté une clarification à propos de la version, ça sera mis en ligne lors de la prochaine mise à jour.
La version de l’api est une string formée de “major.minor” avec major et minor des entiers.
Dans l’url il convient d’utiliser la version majeure, d’ou le /api/v1/
Si l’api passe en 1.1 il faudra toujours utiliser /api/v1/
Si l’api passe en 2.0 il faudra utiliser /api/v2/

Chargement...

Activer les raccourcis clavier

Liste des tâches

Détails de la tâche

Édition de la tâche