search

open311 / swagger-open311

An swagger definition of Open311 GeoReport API
4 stars 8 forks source link

data lifetime #16

Open kvlahromei opened 9 years ago

kvlahromei commented 9 years ago

Think about an server offering the API for a period of time. During the months/years it's getting obvious, that the configuration/scenario of the operator will change and he needs to add or change e.g. service definitions, service name or codes.

Are there any speficications how we expect that the API will deal with that?
Do we suggest to present data as "snapshots" (keep values as the were while editing the data) or do we expect to present consistent data as 'live view' ?
What we suggest about migration and backwards compability of data?

philipashlock commented 9 years ago

If I understand the question correctly, you're asking about the fact that a service definition might change over time and no longer match some of the historical service requests that had been generated using that definition. Is that correct?

I don't think this is something that has received much discussion. Perhaps there could be some what to retain a version history of the service definitions or maybe we just try to ensure there's enough context available stored within the service request that we can make sense of it even if the original service definition is no longer available. This also points to another unresolved issue which is that the specification doesn't explain how custom parameters defined by a service definition are stored with the service request.