Skip to content

Commit d2962d2

Browse files
committed
fixup! WIP feat: add media browsing and searching support
- Introduced `media_search` message and response schema. - Updated `media_browse` to distinguish browsing and searching. - Enhanced `thumbnail` field with `maxLength` constraint for encoded images. - Added `mediaSearchResponse` schema to handle search results.
1 parent ae81604 commit d2962d2

1 file changed

Lines changed: 45 additions & 3 deletions

File tree

integration-api/UCR-integration-asyncapi.yaml

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ channels:
155155
- $ref: '#/components/messages/entity_states'
156156
- $ref: '#/components/messages/available_entities'
157157
- $ref: '#/components/messages/media_browse'
158+
- $ref: '#/components/messages/media_search'
158159
# ------ events
159160
- $ref: '#/components/messages/entity_change'
160161
- $ref: '#/components/messages/entity_available'
@@ -830,14 +831,23 @@ components:
830831
$ref: '#/components/messages/media_browse'
831832

832833
media_browse:
833-
summary: 👷 Media browse/search result.
834+
summary: 👷 Media browse result.
834835
description: |
835-
Response message for `browse_media` and `search_media` requests.
836+
Response message for `browse_media` requests.
836837
tags:
837838
- name: entity
838839
payload:
839840
$ref: '#/components/schemas/mediaBrowseRespMsg'
840841

842+
media_search:
843+
summary: 👷 Media search result.
844+
description: |
845+
Response message for `search_media` requests.
846+
tags:
847+
- name: entity
848+
payload:
849+
$ref: '#/components/schemas/mediaSearchRespMsg'
850+
841851
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
842852
schemas:
843853
# =========================================================================
@@ -1499,6 +1509,20 @@ components:
14991509
- msg
15001510
- msg_data
15011511

1512+
mediaSearchRespMsg:
1513+
type: object
1514+
allOf:
1515+
- $ref: '#/components/schemas/commonResp'
1516+
- properties:
1517+
msg:
1518+
type: string
1519+
const: media_search
1520+
msg_data:
1521+
$ref: '#/components/schemas/mediaSearchResponse'
1522+
required:
1523+
- msg
1524+
- msg_data
1525+
15021526
MediaClass:
15031527
description: |
15041528
The media class is for browser/structure semantics.
@@ -1616,8 +1640,11 @@ components:
16161640
type: boolean
16171641
default: false
16181642
thumbnail:
1619-
description: URL to download the media artwork, or a base64 encoded PNG or JPG image.
1643+
description: |
1644+
URL to download the media artwork, or a base64 encoded PNG or JPG image.
1645+
Please use a URL whenever possible. Encoded images should be as small as possible.
16201646
type: string
1647+
maxLength: 32768
16211648
duration:
16221649
description: Duration in seconds.
16231650
type: integer
@@ -1639,6 +1666,21 @@ components:
16391666
$ref: '#/components/schemas/BrowseMediaItem'
16401667
pagination:
16411668
$ref: '#/components/schemas/Pagination'
1669+
required:
1670+
- pagination
1671+
1672+
mediaSearchResponse:
1673+
type: object
1674+
properties:
1675+
media:
1676+
type: array
1677+
items:
1678+
$ref: '#/components/schemas/BrowseMediaItem'
1679+
pagination:
1680+
$ref: '#/components/schemas/Pagination'
1681+
required:
1682+
- media
1683+
- pagination
16421684

16431685
# =========================================================================
16441686
# Event message schemas

0 commit comments

Comments
 (0)