roapi icon indicating copy to clipboard operation
roapi copied to clipboard

Metadata & governance

Open geoHeil opened this issue 3 years ago • 5 comments

Is it possible to supply additional metadata for each column i.e. perhaps datatypes, semantic description in the YAML configuration for each dataset https://roapi.github.io/docs/config/config-file.html ?

geoHeil avatar May 18 '22 14:05 geoHeil

data type is already supported, for semantic description, what's your use-case? is it for documentation purpose?

houqp avatar May 23 '22 07:05 houqp

Hi, yes. it would be great for someone exploring the data really understand what the values served represent i.e. if the values refer to degrees in Celsius or Fahrenheit i.e. to understand the units and semantics of the values.

geoHeil avatar May 24 '22 12:05 geoHeil

I see, so this is for the end users and you want the semantic description to show up in the schema api response?

houqp avatar May 29 '22 21:05 houqp

correct

geoHeil avatar Jun 01 '22 08:06 geoHeil

It should be pretty straightforward to add a comment field in the schema config and return that in the schema api response.

houqp avatar Jan 22 '23 21:01 houqp