feat: Allow integration drivers to provide entity descriptions. (#82)

* refactor: add a description field to the available entity object

Allow integration drivers to provide entity descriptions.

* docs: update API versions table

Author: zehnm

core-api/README.md

@@ -27,7 +27,8 @@ in YAML format.
 
 | UCR Firmware | Core Simulator | REST API | WS API |
 |--------------|----------------|----------|--------|
-|              | 0.70.4         | 0.45.1   | 0.35.1 |
+| 2.9.1-beta   | 0.71.0         | 0.45.3   | 0.35.3 |
+| 2.9.0-beta   | 0.70.4         | 0.45.1   | 0.35.1 |
 | 2.8.4-beta   | 0.69.3         | 0.44.4   | 0.34.0 |
 | 2.8.3-beta   | 0.68.1         | 0.44.1   | 0.34.0 |
 | 2.8.0-beta   | 0.66.4         | 0.43.1   | 0.33.0 |

core-api/rest/CHANGELOG.md

@@ -10,6 +10,10 @@ This section contains unreleased changes which will be part of an upcoming relea
 
 ---
 
+## 0.45.3
+### Added
+- Add an optional description field to AvailableEntity.
+
 ## 0.45.2
 ### Changed
 - Minimal string length requirements for BrowseMediaItem string fields.

core-api/rest/UCR-core-openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Remote Two/3 REST Core-API
-  version: 0.45.2
+  version: 0.45.3
   contact:
     name: API Support
     url: 'https://github.com/unfoldedcircle/core-api/issues'
@@ -11734,6 +11734,8 @@ components:
           $ref: '#/components/schemas/LanguageText'
         icon:
           $ref: '#/components/schemas/IconIdentifier'
+        description:
+          $ref: '#/components/schemas/LanguageText'
         features:
           description: |
             Supported features of the entity. See entity documentation for available features.

core-api/websocket/CHANGELOG.md

@@ -10,6 +10,10 @@ This section contains unreleased changes which will be part of an upcoming relea
 
 ---
 
+## 0.35.3-beta
+### Added
+- Add an optional description field in available_entity.
+
 ## 0.35.2-beta
 ### Changed
 - Minimal string length requirements for BrowseMediaItem string fields.

core-api/websocket/UCR-core-asyncapi.yaml

@@ -8,7 +8,7 @@ asyncapi: 2.2.0
 id: 'urn:com:unfoldedcircle:core'
 info:
   title: Remote Two/3 WebSocket Core-API
-  version: '0.35.2-beta'
+  version: '0.35.3-beta'
   contact:
     name: API Support
     url: https://github.com/unfoldedcircle/core-api/issues
@@ -7602,6 +7602,8 @@ components:
           $ref: '#/components/schemas/languageText'
         icon:
           $ref: '#/components/schemas/iconIdentifier'
+        description:
+          $ref: '#/components/schemas/languageText'
         features:
           $ref: '#/components/schemas/entityFeatures'
         options:

integration-api/README.md

@@ -23,7 +23,7 @@ The provided Bash wrapper script [`create-html-docker.sh`](create-html-docker.sh
 
 | Integration API | UCR Firmware | Core Simulator |
 |-----------------|--------------|----------------|
-| 0.15.3          |              | 0.70.7         |
+| 0.15.4          | 2.9.1-beta   | 0.71.0         |
 | 0.15.1          | 2.9.0-beta   | 0.70.4         |
 | 0.13.0          | 2.8.0-beta   | 0.64.4         |
 | 0.12.1          | 2.2.4-beta   | 0.58.3         |

integration-api/UCR-integration-asyncapi.yaml

@@ -8,7 +8,7 @@ asyncapi: 2.2.0
 id: 'urn:com:unfoldedcircle:integration'
 info:
   title: Remote Two/3 WebSocket Integration API
-  version: '0.15.3-beta'
+  version: '0.15.4-beta'
   contact:
     name: API Support
     url: https://github.com/unfoldedcircle/core-api/issues
@@ -1924,6 +1924,8 @@ components:
           $ref: '#/components/schemas/languageText'
         icon:
           $ref: '#/components/schemas/iconIdentifier'
+        description:
+          $ref: '#/components/schemas/languageText'
         area:
           description: |
             Optional area if supported by the integration, e.g. `Living room`. This information might be used by the UI