more detail in docs

This commit is contained in:
Pablo Martin 2024-06-14 16:22:00 +02:00
parent d4decdcd8b
commit bceb81ea18

View file

@ -5,10 +5,13 @@ models:
granularity is daily. Each record holds a currency pair for a specific granularity is daily. Each record holds a currency pair for a specific
day, source and version. day, source and version.
Actual rates are source from xe.com data. The `guessed` and `forecast` Actual rates are sourced from xe.com data. The `guessed` and `forecast`
versions are built by simply 'pushing' the first/last exchange rate on versions are built by simply 'pushing' the first/last exchange rate on
record. Basically, wherever we dont' have data for a date, we pick the record. Basically, wherever we dont' have data for a date, we pick the
closest actual data point that comes from xe.com. closest actual data point that comes from xe.com. Bear in mind this means
that `forecast` version records will change on a daily basis as actual
data moves forwards, meaning you shouldn't assume your money amounts
converted in the future should always stay put.
Note that, given the dimensionality, getting a simple time series for a Note that, given the dimensionality, getting a simple time series for a
currency pair will require a bit of filtering. currency pair will require a bit of filtering.
@ -68,12 +71,12 @@ models:
nature). Note that one currency pair can have multiple rate versions nature). Note that one currency pair can have multiple rate versions
on the same date. on the same date.
tests: tests:
- not_null
- accepted_values: - accepted_values:
values: values:
- guess - guess
- actual - actual
- forecast - forecast
- not_null
- name: updated_at_utc - name: updated_at_utc
data_type: timestamp with time zone data_type: timestamp with time zone
description: For external sources, this will be the point in time when the description: For external sources, this will be the point in time when the