provider.md

Provider/Datasource Model

The broader water-api data model is predicated on the concept of a provider. Sample data will be shared below to help illustrate the concept; however, a provider roughly corresponds to a US Army Corps of Engineers office, another federal datasource (US Geological Survey), or any nameable entity that shares data aggregated in the Access to Water system.

erDiagram
    provider {
        UUID    id        PK "NOT NULL"
        VARCHAR slug         "NOT NULL"
        VARCHAR name         "NOT NULL"
        UUID    parent_id FK "optionally support parent/child relationship"
    }
    datatype {
        UUID   id    PK "NOT NULL"
        VARCHAR slug    "NOT NULL"
        VARCHAR name    "NOT NULL"
        VARCHAR uri     "NOT NULL; (typically a top-level webservice url)"
    }
    datasource }o--|| provider : has
    datasource }o--|| datatype : has
    datasource {
        UUID    id          PK "NOT NULL"
        UUID    provider_id FK "NOT NULL"
        VARCHAR type_id     FK "NOT NULL"
    }

Loading

provider

Who is providing the data.

The organization, office, or entity providing the data. For example, a provider could be "US Army Corps of Engineers St. Louis District".

Example Data

todo

datatype

What is being provided?

A distinct kind of data. For example, a datatype could be "Corps Water Management System (CWMS) Timeseries", with the datatype.uri being the top-level url for the CWMS RADAR (Restful web service) Timeseries endpoint.

Note: This entity primarily captures "what", with a bit of "how" (uri field). This could end up being split into multiple entities in the future to eliminate repeated information, particularly in the uri field. Aiming to keep this as simple as possible up-front, following the YAGNI principe.

Example Data

datasource

A unique combination of provider and datatype. This supports representing concepts like:

• The provider USACE St. Louis District provides Corps Water Management System (CWMS) Timeseries data
• The provider US Geological Survey provides USGS NWIS Instantaneous Values Timeseries data
• The provider USACE Omaha District provides Corps Water Management System (CWMS) Location Levels data

Example Data

todo