Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data documentation using YAML #430

Open
jesper-friis opened this issue Feb 20, 2024 · 0 comments
Open

Data documentation using YAML #430

jesper-friis opened this issue Feb 20, 2024 · 0 comments

Comments

@jesper-friis
Copy link
Contributor

We need a simple way to populate the knowledge base with documentation of data resources (sources and sinks). Below is a suggested YAML format for documenting a set of resources in a single YAML document. The idea is to create a Python API and a tool that takes this YAML and a base IRI as input and populate the knowledge base with the documented data resources.

The keyword partial_pipelines is too implementation specific. I would prefer data_resources.

---
version: 1.0

partial_pipelines:  # Find a better name. `data_resources` would be ideal, except that it may create confusion with the `dataresource` strategy below.
  TEM-BF-image1:   # This name will be prepended a `base_iri` when creating an IRI for the data resource in the knowledge base.
    dataresource:
      downloadURL: http://...
      mediaType: text/csv
      ...
    parse:
      parserType: dlite-parse
      ...
    mapping:
      mappingType: mappings
      prefixes:
        ...
      triples:
        ...
        
  TEM-BF-image2:
    dataresource:
      ...
    parse:
      ...
    mappings:
      ...

  my-data-sink:
    mappings:
      ...
    generate:
      ...
    dataresource:
      downloadURL: http://...
      mediaType: text/csv
      ```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant