Modifications importantes de l’API du registre de l’IITA

  • 1 août 2016

Le registre de l’IITA fera l’objet d’une mise à niveau dans la semaine du 10 octobre 2016 , ce qui entraînera des modifications de l’API. Nos prestataires informatiques nous aideront à mettre à niveau le logiciel CKAN et à corriger plus de 250 bogues afin d’améliorer votre utilisation du registre.

Il est conseillé aux utilisateurs API du registre de l’IITA de :

  • comprendre les modifications : consultez ci-dessous la liste des principales modifications techniques de la fonctionnalité et des réponses de l’API. Pour un aperçu complet, consultez le journal des modifications de CKAN . (Veuillez noter que nous passons de la version 2.1.4 à la version 2.5.2 de CKAN) ;
  • tester l’application : notre nouvel environnement de simulation vous aidera à comprendre les ajustements que vous devez éventuellement apporter pour éviter tout contretemps dû à la mise à niveau. Les données de l’actuel registre en ligne seront reproduites dans l’environnement de simulation tous les 15 jours à compter du mardi 16 août 2016. À ce moment, toute modification de l’environnement de simulation sera remplacée par des données en ligne ;

Si vous n’utilisez pas l’API, aucune action n’est attendue de votre part puisque la mise à jour n’affectera pratiquement pas votre interaction avec le registre de l’IITA. Une fois la mise à niveau terminée, toutes les données des signataires seront sauvegardées.

Nous vous préviendrons à l’avance de toute indisponibilité due à la mise à niveau et, dans l’intervalle, travaillerons étroitement avec nos prestataires informatiques pour faire en sorte qu’elle se déroule sans problème. Pour de plus amples informations, veuillez envoyer un courriel à l’équipe technique de l’IITA.

Principales modifications techniques affectant l’API :

  • package_purge API action added (ajouté dans la version 2.5.2 de CKAN).
  • revision_list API action now has paging (modifié dans la version 2.5.1 de CKAN).
  • The package_show API call does not return the tracking_summary , keys in the dataset or resources by default any more (modifié dans la version 2.4 de CKAN).
  • group_show and organization_show API calls no longer return the datasets by default. Users of this API call will need to pass include_datasets=True to include datasets in the response (modifié dans la version 2.4 de CKAN).
  • The vocabulary_show and tag_show API calls no longer returns the packages key – i.e. datasets that use the vocabulary or tag. However tag_show now has an include_datasets option (modifié dans la version 2.4 de CKAN).
  • The action API (v3) no longer returns the full help for the action on each request. It rather includes a link to a separate call to get the action help string (modifié dans la version 2.3 de CKAN).
  • Ability for users to re-generate their own API keys (ajouté dans la version 2.3 de CKAN).
  • Able to list private datasets via the API (ajouté dans la version 2.3 de CKAN).
  • The action API (v3) no longer returns the full help for the action on each request. It rather includes a link to a separate call to get the action help string (modifié dans la version 2.3 de CKAN).
  • The user_show API call does not return the datasets, num_followers or activity keys by default any more (modifié dans la version 2.3 de CKAN).
  • package_search now returns results with custom schemas applied like package_show , ause_default_schema parameter was added to request the old behaviour (modifié dans la version 2.2 de CKAN).