search

OpenAddressesUK / hippodamus

Open Addresses' publishing scripts that create the downloadable versions of Open Addresses' database.
http://openaddressesuk.org/docs/
MIT License
0 stars 0 forks source link

Why do we need the 'address' topmost 'container' property in each JSON address? #4

Open giacecco opened 9 years ago

giacecco commented 9 years ago

In the downloadable JSON version each file is a JSON array of address objects, where each address is an object with an 'address' property that contains the whole thing. I don't see the value of it. Is it necessary? Some good practice or pattern I'm missing? 

{
  "address" : {
    "url" : "http://alpha.openaddressesuk.org/addresses/7pW9D2",
    "sao" : "1ST FLOOR",
    (...)
    "provenance": { (...) }
  }
}

Perhaps it is a bug and what you had planned is that 'provenance' was a first level property too, as in the example below? I would actually like that.

{
  "address" : {
    "url" : "http://alpha.openaddressesuk.org/addresses/7pW9D2",
    "sao" : "1ST FLOOR",
    (...)
  },
  "provenance": { (...) }
}

Please share your reasoning. I don't have a strong opinion either way.

pezholio commented 9 years ago

This is to mirror what we have at http://alpha.openaddressesuk.org/. See http://alpha.openaddressesuk.org/addresses/oop9R5.json for an example.

giacecco commented 9 years ago

Ok but you still did not say if we need it or not, either in the live or downloadable version.

What do you think about moving provenance out?

Don't take any action for now anyway, this will go to Beta.

pezholio commented 9 years ago

The reason it's that way is because I saw provenance as a property of the address. I could be wrong though

giacecco commented 9 years ago

I see provenance as metadata about the address, rather than a property of the address. My own example was wrong from this point of view.

How would that look like if we used PROV?

Let's ask @Floppy what his opinion is.