OpenEnergyPlatform / OpenEnergyPlatform/oemetadata
Table schema: Foreign Key constrains information could be enhanced.
Open
@Ludee is already working on this.
Since Sep 15, 2026.
part: documentation 📖
priority: high ⚡
status: active 🚧
type: enhancement ⚙️
- Dominant language
- Python
- Stars
- 26
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Description of the issue
We introduced the "topics" key as list for all schemas/topics a table is available at on the OEP. We do not use this approach when referencing a Foreign key table
https://github.com/OpenEnergyPlatform/oemetadata/blob/5e435ab3755ac32cb7a9d4dc5089e8cad1aab106/oemetadata/v2/v20/example.json#L322
Ideas of solution
To make the usage of topics consistent, we could introduce a "topic" key which is not a list of topics but expects a string with the topic name where the FK table is available at.
Workflow checklist
- I am aware of the workflow in CONTRIBUTING.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.