From 7c4e18141c1dd49bbf0ed09967a34f85aa939bfc Mon Sep 17 00:00:00 2001 From: Andrew Fiddian-Green Date: Mon, 16 Mar 2026 17:30:27 +0000 Subject: [PATCH] Describe addon.xml new `keywords` element (#2662) Signed-off-by: Andrew Fiddian-Green --- developers/addons/addon.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/developers/addons/addon.md b/developers/addons/addon.md index ba8b5bf2c..023402319 100644 --- a/developers/addons/addon.md +++ b/developers/addons/addon.md @@ -29,6 +29,9 @@ If the add-on consists of more than one bundle, only one `addon.xml` is allowed String String String + String,String,String + String + String,String,String String @@ -51,8 +54,9 @@ If the add-on consists of more than one bundle, only one `addon.xml` is allowed | type | Either `automation`, `binding`, `misc`, `persistence`, `transform`, `ui` or `voice` | mandatory | | name | A human-readable name for the add-on | mandatory | | description | A human-readable description for the add-on | optional | +| keywords | A comma separated list of keywords that are used by the UI search function. e.g. `AwTrixLight,ESPMilight,FalconPlayerFPP,RuuviGateway`. Note that `id`, `name` and `description` are also used by the search function, so duplication is not required here. | optional | | connection | `none` for add-ons that have no interactions with external systems at all, `local` for add-ons that only interact locally without internet access, `hybrid` for add-ons that interact locally without internet access, but can optionally use a cloud connection for extended functionality (such as discovery), `cloud` for add-ons that require a cloud connection | optional | -| countries | List of two-letter ISO country codes (ISO 3166-1 alpha-2) that are supported (all countries if empty). Must be in lowercase | optional | +| countries | List of two-letter ISO country codes (ISO 3166-1 alpha-2) that are supported (all countries if empty). Must be in lowercase. e.g. `de,nl,dk` | optional | | service-id | The ID (service.pid or component.name) of the main binding service, which can be configured through OSGi configuration admin service. Should only be used in combination with a config description definition | optional | | config-description | The configuration description for the binding within the ConfigDescriptionRegistry (cf. [Configuration Description](config-xml.html)) | optional | | config-description-ref | The reference to a configuration description for the binding within the ConfigDescriptionRegistry | optional |