Skip to content

Commit 117ff5d

Browse files
stakachstakach
committed
feat(signage/playlist_media): add tags query
1 parent 7fed9df commit 117ff5d

3 files changed

Lines changed: 438 additions & 86 deletions

File tree

‎OPENAPI_DOC.yml‎

Lines changed: 188 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -21714,7 +21714,9 @@ paths:
2171421714

2171521715
group; `q=...` is a case-insensitive substring search across
2171621716

21717-
`name` and `description`.'
21717+
`name` and `description`; `tags=...` returns items carrying any of
21718+
21719+
the supplied tags.'
2171821720
tags:
2171921721
- PlaylistMedia
2172021722
operationId: PlaceOS::Api::PlaylistMedia_index
@@ -21734,6 +21736,15 @@ paths:
2173421736
schema:
2173521737
type: string
2173621738
nullable: true
21739+
- name: tags
21740+
in: query
21741+
description: return items carrying any of these tags
21742+
example: promo,lobby
21743+
schema:
21744+
type: array
21745+
items:
21746+
type: string
21747+
nullable: true
2173721748
- name: limit
2173821749
in: query
2173921750
schema:
@@ -21915,6 +21926,96 @@ paths:
2191521926
application/json:
2191621927
schema:
2191721928
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
21929+
/api/engine/v2/signage/media/tags:
21930+
get:
21931+
summary: return the distinct tags in use by media. Scopes the same way as
21932+
description: 'return the distinct tags in use by media. Scopes the same way
21933+
as
21934+
21935+
`index`: `group_id=...` limits to media linked to that group (caller
21936+
21937+
must have Read on it); without `group_id`, admin/support callers see
21938+
21939+
every tag in the authority while regular users see tags from media in
21940+
21941+
groups they can read.'
21942+
tags:
21943+
- PlaylistMedia
21944+
operationId: PlaceOS::Api::PlaylistMedia_tags
21945+
parameters:
21946+
- name: group_id
21947+
in: query
21948+
description: limit to media linked to this group (caller must have Read on
21949+
the group)
21950+
schema:
21951+
type: string
21952+
format: uuid
21953+
nullable: true
21954+
responses:
21955+
200:
21956+
description: OK
21957+
content:
21958+
application/json:
21959+
schema:
21960+
type: array
21961+
items:
21962+
$ref: '#/components/schemas/String'
21963+
409:
21964+
description: Conflict
21965+
content:
21966+
application/json:
21967+
schema:
21968+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
21969+
401:
21970+
description: Unauthorized
21971+
content:
21972+
application/json:
21973+
schema:
21974+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
21975+
503:
21976+
description: Service Unavailable
21977+
content:
21978+
application/json:
21979+
schema:
21980+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
21981+
403:
21982+
description: Forbidden
21983+
404:
21984+
description: Not Found
21985+
content:
21986+
application/json:
21987+
schema:
21988+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
21989+
406:
21990+
description: Not Acceptable
21991+
content:
21992+
application/json:
21993+
schema:
21994+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
21995+
408:
21996+
description: Request Timeout
21997+
content:
21998+
application/json:
21999+
schema:
22000+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
22001+
400:
22002+
description: Bad Request
22003+
content:
22004+
application/json:
22005+
schema:
22006+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
22007+
422:
22008+
description: Unprocessable Entity
22009+
content:
22010+
application/json:
22011+
schema:
22012+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
22013+
415:
22014+
description: Unsupported Media Type
22015+
content:
22016+
application/json:
22017+
schema:
22018+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
2191822019
/api/engine/v2/signage/media/{id}:
2191922020
get:
2192022021
summary: return the details of the requested media item
@@ -32806,19 +32907,26 @@ components:
3280632907
type: integer
3280732908
format: Int64
3280832909
nullable: true
32809-
play_at:
32810-
type: integer
32811-
format: Int64
32812-
nullable: true
32813-
play_cron:
32814-
type: string
32815-
nullable: true
32816-
play_period:
32817-
type: integer
32818-
format: Int32
32819-
nullable: true
32820-
play_takeover:
32821-
type: boolean
32910+
schedules:
32911+
type: array
32912+
items:
32913+
type: object
32914+
properties:
32915+
play_at:
32916+
type: integer
32917+
format: Int64
32918+
nullable: true
32919+
play_takeover:
32920+
type: boolean
32921+
play_period:
32922+
type: integer
32923+
format: Int32
32924+
play_cron:
32925+
type: string
32926+
required:
32927+
- play_takeover
32928+
- play_period
32929+
- play_cron
3282232930
nullable: true
3282332931
id:
3282432932
type: string
@@ -35649,19 +35757,26 @@ components:
3564935757
type: integer
3565035758
format: Int64
3565135759
nullable: true
35652-
play_at:
35653-
type: integer
35654-
format: Int64
35655-
nullable: true
35656-
play_cron:
35657-
type: string
35658-
nullable: true
35659-
play_period:
35660-
type: integer
35661-
format: Int32
35662-
nullable: true
35663-
play_takeover:
35664-
type: boolean
35760+
schedules:
35761+
type: array
35762+
items:
35763+
type: object
35764+
properties:
35765+
play_at:
35766+
type: integer
35767+
format: Int64
35768+
nullable: true
35769+
play_takeover:
35770+
type: boolean
35771+
play_period:
35772+
type: integer
35773+
format: Int32
35774+
play_cron:
35775+
type: string
35776+
required:
35777+
- play_takeover
35778+
- play_period
35779+
- play_cron
3566535780
nullable: true
3566635781
id:
3566735782
type: string
@@ -35687,6 +35802,12 @@ components:
3568735802
user_name:
3568835803
type: string
3568935804
nullable: true
35805+
approval_requested:
35806+
type: boolean
35807+
nullable: true
35808+
requested_by_id:
35809+
type: string
35810+
nullable: true
3569035811
approved:
3569135812
type: boolean
3569235813
nullable: true
@@ -36756,19 +36877,26 @@ components:
3675636877
type: integer
3675736878
format: Int64
3675836879
nullable: true
36759-
play_at:
36760-
type: integer
36761-
format: Int64
36762-
nullable: true
36763-
play_cron:
36764-
type: string
36765-
nullable: true
36766-
play_period:
36767-
type: integer
36768-
format: Int32
36769-
nullable: true
36770-
play_takeover:
36771-
type: boolean
36880+
schedules:
36881+
type: array
36882+
items:
36883+
type: object
36884+
properties:
36885+
play_at:
36886+
type: integer
36887+
format: Int64
36888+
nullable: true
36889+
play_takeover:
36890+
type: boolean
36891+
play_period:
36892+
type: integer
36893+
format: Int32
36894+
play_cron:
36895+
type: string
36896+
required:
36897+
- play_takeover
36898+
- play_period
36899+
- play_cron
3677236900
nullable: true
3677336901
id:
3677436902
type: string
@@ -39596,19 +39724,26 @@ components:
3959639724
type: integer
3959739725
format: Int64
3959839726
nullable: true
39599-
play_at:
39600-
type: integer
39601-
format: Int64
39602-
nullable: true
39603-
play_cron:
39604-
type: string
39605-
nullable: true
39606-
play_period:
39607-
type: integer
39608-
format: Int32
39609-
nullable: true
39610-
play_takeover:
39611-
type: boolean
39727+
schedules:
39728+
type: array
39729+
items:
39730+
type: object
39731+
properties:
39732+
play_at:
39733+
type: integer
39734+
format: Int64
39735+
nullable: true
39736+
play_takeover:
39737+
type: boolean
39738+
play_period:
39739+
type: integer
39740+
format: Int32
39741+
play_cron:
39742+
type: string
39743+
required:
39744+
- play_takeover
39745+
- play_period
39746+
- play_cron
3961239747
nullable: true
3961339748
id:
3961439749
type: string

0 commit comments

Comments
 (0)