Skip to content

Commit 86ea17a

Browse files
stakachstakach
committed
feat(signage): add media item scheduling support
1 parent 2e3aa2f commit 86ea17a

5 files changed

Lines changed: 601 additions & 13 deletions

File tree

‎OPENAPI_DOC.yml‎

Lines changed: 220 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23422,6 +23422,172 @@ paths:
2342223422
application/json:
2342323423
schema:
2342423424
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
23425+
/api/engine/v2/signage/playlists/{id}/media/schedule:
23426+
post:
23427+
summary: add scheduled media to a distribution playlist
23428+
tags:
23429+
- Playlist
23430+
operationId: PlaceOS::Api::Playlist_schedule_media
23431+
requestBody:
23432+
content:
23433+
application/json:
23434+
schema:
23435+
$ref: '#/components/schemas/PlaceOS__Model__Playlist__ItemSchedule'
23436+
required: true
23437+
parameters:
23438+
- name: id
23439+
in: path
23440+
required: true
23441+
schema:
23442+
type: string
23443+
responses:
23444+
200:
23445+
description: OK
23446+
content:
23447+
application/json:
23448+
schema:
23449+
$ref: '#/components/schemas/PlaceOS__Model__Playlist__Revision'
23450+
409:
23451+
description: Conflict
23452+
content:
23453+
application/json:
23454+
schema:
23455+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23456+
401:
23457+
description: Unauthorized
23458+
content:
23459+
application/json:
23460+
schema:
23461+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23462+
503:
23463+
description: Service Unavailable
23464+
content:
23465+
application/json:
23466+
schema:
23467+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23468+
403:
23469+
description: Forbidden
23470+
404:
23471+
description: Not Found
23472+
content:
23473+
application/json:
23474+
schema:
23475+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23476+
406:
23477+
description: Not Acceptable
23478+
content:
23479+
application/json:
23480+
schema:
23481+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
23482+
408:
23483+
description: Request Timeout
23484+
content:
23485+
application/json:
23486+
schema:
23487+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23488+
400:
23489+
description: Bad Request
23490+
content:
23491+
application/json:
23492+
schema:
23493+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
23494+
422:
23495+
description: Unprocessable Entity
23496+
content:
23497+
application/json:
23498+
schema:
23499+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
23500+
415:
23501+
description: Unsupported Media Type
23502+
content:
23503+
application/json:
23504+
schema:
23505+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
23506+
/api/engine/v2/signage/playlists/{id}/media/schedule/{item_id}:
23507+
patch:
23508+
tags:
23509+
- Playlist
23510+
operationId: PlaceOS::Api::Playlist_update_schedule
23511+
requestBody:
23512+
content:
23513+
application/json:
23514+
schema:
23515+
$ref: '#/components/schemas/PlaceOS__Model__Playlist__ItemSchedule'
23516+
required: true
23517+
parameters:
23518+
- name: id
23519+
in: path
23520+
required: true
23521+
schema:
23522+
type: string
23523+
- name: item_id
23524+
in: path
23525+
required: true
23526+
schema:
23527+
type: string
23528+
responses:
23529+
200:
23530+
description: OK
23531+
content:
23532+
application/json:
23533+
schema:
23534+
$ref: '#/components/schemas/PlaceOS__Model__Playlist__ItemSchedule'
23535+
409:
23536+
description: Conflict
23537+
content:
23538+
application/json:
23539+
schema:
23540+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23541+
401:
23542+
description: Unauthorized
23543+
content:
23544+
application/json:
23545+
schema:
23546+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23547+
503:
23548+
description: Service Unavailable
23549+
content:
23550+
application/json:
23551+
schema:
23552+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23553+
403:
23554+
description: Forbidden
23555+
404:
23556+
description: Not Found
23557+
content:
23558+
application/json:
23559+
schema:
23560+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23561+
406:
23562+
description: Not Acceptable
23563+
content:
23564+
application/json:
23565+
schema:
23566+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
23567+
408:
23568+
description: Request Timeout
23569+
content:
23570+
application/json:
23571+
schema:
23572+
$ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
23573+
400:
23574+
description: Bad Request
23575+
content:
23576+
application/json:
23577+
schema:
23578+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
23579+
422:
23580+
description: Unprocessable Entity
23581+
content:
23582+
application/json:
23583+
schema:
23584+
$ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
23585+
415:
23586+
description: Unsupported Media Type
23587+
content:
23588+
application/json:
23589+
schema:
23590+
$ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
2342523591
/api/engine/v2/signage/playlists/{id}/media/approve:
2342623592
post:
2342723593
summary: approve a playlist for publication on displays
@@ -25070,8 +25236,6 @@ paths:
2507025236
parameters:
2507125237
- name: sys_id
2507225238
in: path
25073-
description: the id of the system
25074-
example: sys-1234
2507525239
required: true
2507625240
schema:
2507725241
type: string
@@ -25163,8 +25327,6 @@ paths:
2516325327
parameters:
2516425328
- name: sys_id
2516525329
in: path
25166-
description: the id of the system
25167-
example: sys-1234
2516825330
required: true
2516925331
schema:
2517025332
type: string
@@ -25246,8 +25408,6 @@ paths:
2524625408
parameters:
2524725409
- name: sys_id
2524825410
in: path
25249-
description: the id of the system
25250-
example: sys-1234
2525125411
required: true
2525225412
schema:
2525325413
type: string
@@ -25331,8 +25491,6 @@ paths:
2533125491
parameters:
2533225492
- name: sys_id
2533325493
in: path
25334-
description: the id of the system
25335-
example: sys-1234
2533625494
required: true
2533725495
schema:
2533825496
type: string
@@ -33041,6 +33199,9 @@ components:
3304133199
enabled:
3304233200
type: boolean
3304333201
nullable: true
33202+
distribution:
33203+
type: boolean
33204+
nullable: true
3304433205
default_duration:
3304533206
type: integer
3304633207
format: Int32
@@ -35947,6 +36108,9 @@ components:
3594736108
enabled:
3594836109
type: boolean
3594936110
nullable: true
36111+
distribution:
36112+
type: boolean
36113+
nullable: true
3595036114
default_duration:
3595136115
type: integer
3595236116
format: Int32
@@ -36036,6 +36200,48 @@ components:
3603636200
type: string
3603736201
nullable: true
3603836202
required: []
36203+
PlaceOS__Model__Playlist__ItemSchedule:
36204+
type: object
36205+
properties:
36206+
created_at:
36207+
type: integer
36208+
format: Int64
36209+
nullable: true
36210+
updated_at:
36211+
type: integer
36212+
format: Int64
36213+
nullable: true
36214+
playlist_id:
36215+
type: string
36216+
nullable: true
36217+
item_id:
36218+
type: string
36219+
nullable: true
36220+
schedules:
36221+
type: array
36222+
items:
36223+
type: object
36224+
properties:
36225+
play_at:
36226+
type: integer
36227+
format: Int64
36228+
nullable: true
36229+
play_takeover:
36230+
type: boolean
36231+
play_period:
36232+
type: integer
36233+
format: Int32
36234+
play_cron:
36235+
type: string
36236+
required:
36237+
- play_takeover
36238+
- play_period
36239+
- play_cron
36240+
nullable: true
36241+
id:
36242+
type: string
36243+
nullable: true
36244+
required: []
3603936245
PlaceOS__Api__Playlist__Approver:
3604036246
type: object
3604136247
properties:
@@ -37087,6 +37293,9 @@ components:
3708737293
enabled:
3708837294
type: boolean
3708937295
nullable: true
37296+
distribution:
37297+
type: boolean
37298+
nullable: true
3709037299
default_duration:
3709137300
type: integer
3709237301
format: Int32
@@ -39968,6 +40177,9 @@ components:
3996840177
enabled:
3996940178
type: boolean
3997040179
nullable: true
40180+
distribution:
40181+
type: boolean
40182+
nullable: true
3997140183
default_duration:
3997240184
type: integer
3997340185
format: Int32

0 commit comments

Comments
 (0)