OpenEnergyPlatform / OpenEnergyPlatform/oeplatform

Add an API endpoint offering each dataset oemetadata in jsonld

Open
#1,951 0 comments 0 reactions 1 assignee View on GitHub

@jh-RLI is already working on this.

Since Mar 18, 2025.

type: enhancement :gear:
Dominant language
Python
Stars
65
Forks
29
Avg merge
15h 25m
Merged PRs (30d)
32

Description

Description of the issue

Add the content of the context document and oemetadata JSON document in a new jsonld file and offer it to the user.

Note: The context.json is currently enabling widely used JSONLD Parsers to translate the oemetadata into rdf / graph data. Still, tools like Protégé are not yet supported fully due to the incomplete nature of jsonld mappings. We would need to provide structurl/type information. This would also mean we have a duplicate Mainly used the jsonld-playground for testing. JSON-LD Python libs seem to be incomplete or need specific configuration.

Ideas of solution

  • Simple improvement with low effort and good value for users.

  • The jsonld mapping stored in the context.json with each oemetadata release. We just add this document to any tables metadata and offer and download endpoint & Button on the table detail page.

Workflow checklist

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.