OpenEnergyPlatform / OpenEnergyPlatform/oeplatform

OEMetaBuilder: bugfix and general enhancements

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

@jh-RLI is already working on this.

Since Mar 28, 2025.

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

Description

Description of the issue

Post release v1.2.0 OEMetadata specification was implemented in the OEMetaBuilder. The Builder also depends on the json schema, but it requires extra properties. Some of them are not native to the json schema spec and not related to the OEMetadata specification but relevant to the presentation and features like autocompletion and oeo term lookup.

The diff. between the json schema for specification and editing makes the process of adapting the editing schema to new metadata versions error-prone. In the long run we need a functionality that can automatically extend the metadata specification json schema with properties needed for the editor (OEMetaBuilder).

This issue is also for fixing some bugs that were introduced after migrating the builder to OEMetadata v2.0.4 - as described above.

Ideas of solution

Fix errors in OEMetaBuilder json schema file (in dataedit static assets):

  • Fix wrong title
  • missing oeo-extended feature

Long term:

  • Add functionality to merge schema and additional properties needed for the OEMetaBuilder
  • Button for oeo-extended
  • Hooks for oeo-term lookup in annotation fields
  • add annotation feature to more properties

Context and Environment

  • Version used: v-1.2.0
  • Operating system: Ubuntu
  • Environment setup and (python) version: 3.10

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.