Normalisation des champs de l’API le 19/06

Chers utilisatrices et utilisateurs,
Comme vous avez pu le constater, les différents champs renvoyés par l’API sont actuellement normalisés dans des formats différents.
Nous retrouvons essentiellement du camelCase :

{
  "total": 13651633,
  "nextPageURI": "https://api.istex.fr/document/?q=*&size=10&output=*&facet=score,copyrightdate,pdfWordCount&corpus=springer&from=10",
  "firstPageURI": "https://api.istex.fr/document/?q=*&size=10&output=*&facet=score,copyrightdate,pdfWordCount&corpus=springer&from=0",
  "lastPageURI": "https://api.istex.fr/document/?q=*&size=10&output=*&facet=score,copyrightdate,pdfWordCount&corpus=springer&from=1190",
  "hits": [
    {
      "corpusName": "springer",
...

mais également du snake_case pour les agrégations/facettes :

"aggregations": {
    "copyrightdate": {
      "buckets": [
        {
          "key": "1943-2010",
          "from": -852076800000,
          "from_as_string": "1943",
          "to": 1262304000000,
          "to_as_string": "2010",
          "doc_count": 1147
        }
      ]
    },
    "corpus": {
      "doc_count_error_upper_bound": 0,
      "sum_other_doc_count": 0,
      "buckets": [
        {
          "key": "springer",
          "doc_count": 1200
        }
      ]
    }
  }

et certains champs sont même en lowercase :

"copyrightdate": "2009",
"pubdate": "1998"

Le snake_case des agrégations/facettes s’explique par le retour du moteur de recherche ElasticSearch. En effet, l’API renvoie jusqu’ici la réponse brute de ce dernier, qui est bel et bien en snake_case.
Dans un souci d’homogénéité des résultats, pour une meilleure lisibilité et facilité d’utilisation, il a été convenu que ces champs devraient être également en camelCase. Ce changement sera effectif lors du prochain rechargement des corpus, à la fin de la semaine prochaine.
Les différents champs concernés sont les suivants :

- from_as_string deviendra : fromAsString
- to_as_string deviendra : toAsString
- doc_count deviendra : docCount
- doc_count_error_upper_bound deviendra : docCountErrorUpperBound
- sum_other_doc_count deviendra : sumOtherDocCount
- pubdate deviendra : publicationDate
- copyrightdate deviendra : copyrightDate

De même, cette normalisation va également impactée le nom des facettes en question. En effet, pour garder une logique, le nom de la facette correspond au nom du champ interrogé, ce qui impliquera que :

- copyrightdate deviendra : copyrightDate
- pubdate deviendra : publicationDate
- copyrightdate_over_time deviendra : copyrightDateOverTime
- pubdate_over_time deviendra : publicationDateOverTime
- corpus deviendra : corpusName

Pour toutes suggestions et/ou remarques, n’hésitez pas à nous écrire un commentaire !

• camelCase
• normalisation