facilityregistry / fred-api

Facility Registry API Documentation Website
11 stars 4 forks source link

How to monitor versioning and track updates #58

Open steesdale opened 11 years ago

steesdale commented 11 years ago

How to monitor versioning and track updates (and query previous versions etc)

Why it matters: Keeping track of all or some older versions for a facility, just a variable, or the whole facility dataset as a whole supports analysis of progress and retrospective reporting/auditing.

edjez commented 11 years ago

From the 0.001 API proposal: Note "feature" is "facility" as this was using GeoJson Feature Versioning

Each time a feature is updated, a new document is created linked to the feature_id and marked with a unique epoch (timestamp).

Maintaining Official Sets with Tags

A tag can be assigned to a particular epoch for a particular feature. This allows to preserve a particular state.

SR_2345sg234@125 - third edit (waiting to be verified) SR_2345sg234@124 - 2nd edit [official] SR_2345sg234@123 - first edit SR_2345sg234@122 - creation

A query on the official tag would return all features frozen at the time the label was applied. This allows for the feature to be updated for verification later. The official version could be represented by SR_2345sg234@official

edjez commented 11 years ago

Discussed during call: getting past versions {FacilityURL}/history returns list of past versions with href links with full epoch, and tag-versions. Each version can also have additional string fields.

getting a specific past version

facility/23/history/TAGX facility/23/history/{epoch}

Querying facilities:

This is in spirit of managing core data responsibly. UIs and Workflows for editing, revisions, approvals would all exist externally