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

Introduce add-on metadata #2058

Closed
kaikreuzer opened this issue Jan 2, 2021 · 2 comments · Fixed by #3050
Closed

Introduce add-on metadata #2058

kaikreuzer opened this issue Jan 2, 2021 · 2 comments · Fixed by #3050
Assignees
Labels
enhancement An enhancement or new feature of the Core PR pending

Comments

@kaikreuzer
Copy link
Member

kaikreuzer commented Jan 2, 2021

This is a follow-up on eclipse-archived/smarthome#4503 suggesting to define a OH-INF/addon.xml file that could include different metadata about the add-on.

In the case of bindings, this should be a replacement for the binding.xml file.

Content of the OH-INF/addon.xml file should be:

  • name - mandatory - The add-on name, no reference to specific solution (e.g. openHAB). Unclear if type should be included ("Air Quality" vs. "Air Quality Binding")
  • description - mandatory - A description of the purpose, specialization and limitations of the add-on, should be between 160-240 characters.
  • type - mandatory - One out of a counted list, e.g. "Binding", "Automation", ...
  • keywords - optional but recommended - Keywords (categories) out of an open list to filter against, e.g. "heating, lighting, graphing"
  • connection - optional - highlight if a binding/automation/... interacts locally or if it connects to an online service (seldom or continuously)
  • countries - optional - a comma-separated list of ISO 3166 2-letter country codes for which this add-on is applicable

The metadata must be made available through the REST API, so that it can be consumed by the UI.

@ghys
Copy link
Member

ghys commented Jan 4, 2021

The metadata must be made available through the REST API, so that it can be consumed by the UI.

I have made some proposals in #2070.

@J-N-K J-N-K self-assigned this Jun 1, 2022
@J-N-K J-N-K moved this to In Progress in openHAB 4 Issue Tracking Dec 18, 2022
@github-project-automation github-project-automation bot moved this from In Progress to Done in openHAB 4 Issue Tracking Jan 15, 2023
@lolodomo
Copy link
Contributor

@J-N-K @ghys : are the metadata connection and countries already supported by MainUI ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An enhancement or new feature of the Core PR pending
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants