diff --git a/docs/toar_db.pdf b/docs/toar_db.pdf deleted file mode 120000 index 2247543833bb161ba2f5c39ac36e5076661dde90..0000000000000000000000000000000000000000 --- a/docs/toar_db.pdf +++ /dev/null @@ -1 +0,0 @@ -_build/latex/toar_db.pdf \ No newline at end of file diff --git a/docs/toardb_fastapi.md b/docs/toardb_fastapi.md index 6cefa42578521609e24206f307825beae4bff833..d00df760fdc00e176cf1bf03ae13989bccf95d35 100644 --- a/docs/toardb_fastapi.md +++ b/docs/toardb_fastapi.md @@ -15,18 +15,18 @@ | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| lat | number | | No | -| lng | number | | No | -| alt | number | | Yes | +| lat | number | longitude coordinate of station (decimal degrees_east). This is our best estimate of the station location which is not always identical to the official station coordinates (see coordinate_validation_status). | No | +| lng | number | latitude coordinate of station (decimal degrees_north). This is our best estimate of the station location which is not always identical to the official station coordinates (see coordinate_validation_status). | No | +| alt | number | altitude of station (in m above sea level). This is our best estimate of the station altitude, which is not always identical to the reported station altitude, but frequently uses the elevation from google earth instead (see coordinate_validation_status). | No | #### Data | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | -| datetime | dateTime | | Yes | -| value | number | | Yes | -| flags | string | | Yes | -| timeseries_id | integer | | Yes | +| datetime | dateTime | date and time of observation | Yes | +| value | number | variable value at datetime | Yes | +| flags | string | flags | Yes | +| timeseries_id | integer | ID of timeseries | Yes | #### Organisation @@ -57,7 +57,7 @@ | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | integer | | Yes | -| codes | [ string ] | | No | +| codes | [ string ] | list of station's codes | Yes | | name | string | | Yes | | coordinates | [Coordinates](#coordinates) | | Yes | | country | string | | Yes | @@ -75,7 +75,6 @@ | aux_docs | [ [StationmetaAuxDoc](#stationmetaauxdoc) ] | | No | | aux_urls | [ [StationmetaAuxUrl](#stationmetaauxurl) ] | | No | | globalmeta | [StationmetaGlobal](#stationmetaglobal) | | No | -| globalservice | [StationmetaGlobalService](#stationmetaglobalservice) | | No | #### StationmetaAnnotation @@ -125,7 +124,7 @@ | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | integer | | Yes | -| codes | [ string ] | | No | +| codes | [ string ] | list of station's codes | Yes | | name | string | | Yes | | coordinates | [Coordinates](#coordinates) | | Yes | | country | string | | Yes | @@ -161,17 +160,6 @@ | toar1_category | string | | Yes | | station_id | integer | | Yes | -#### StationmetaGlobalService - -| Name | Type | Description | Required | -| ---- | ---- | ----------- | -------- | -| id | integer | | Yes | -| variable_name | string | | Yes | -| result_type | integer | | Yes | -| result_nvalues | integer | | Yes | -| service_valid_year | integer | | Yes | -| service_url | string | | Yes | - #### StationmetaRole | Name | Type | Description | Required | diff --git a/docs/toardb_v2.pdf b/docs/toardb_v2.pdf new file mode 100644 index 0000000000000000000000000000000000000000..9eb95458ad937b9a2f91f83d7e17895c2fe7a523 Binary files /dev/null and b/docs/toardb_v2.pdf differ