search

NeotomaDB / api_nodetest

node.js and express implementation for the Neotoma API
MIT License
2 stars 0 forks source link

data/GeopoliticalUnits return object #46

Open stryker-m opened 7 years ago

stryker-m commented 7 years ago

data object returned by /v2/data/GeopoliticalUnits does not match /v1 data object which is: "data":[{"GeoPoliticalID":173,"GeoPoliticalName":"Antarctica"},{"GeoPoliticalID":264,"GeoPoliticalName":"Argentina"},...

SimonGoring commented 7 years ago

Is this an issue? I thought that by moving to v2 we were going to break some backwards compatibility.

currently:

http://api-dev.neotomadb.org/v2/data/geopoliticalunits/12

Returns

{
  "status": "success",
  "data": [
    {
      "geopoliticalid": 12,
      "geopoliticalname": "Helmand",
      "geopoliticalunit": "province (velayat)",
      "rank": 2,
      "highergeopoliticalid": 1,
      "recdatecreated": "2013-09-30T18:02:51.000Z",
      "recdatemodified": "2013-09-30T18:02:51.000Z"
    }
  ]
}

I think this is the most appropriate response (although a better one would possibly include some external reference, and use an external standard for the named elements, rather than Neotoma's specific terms).

Does this need to be changed in the v2 API, or can we move forward with the new standard?

stryker-m commented 7 years ago

There needs to be a minimal migrated API set that serves Explorer (and any other clients looking to view the most recent data). v2 can break the API but there needs to be a v1.5 that does not.