diff --git a/CHANGELOG.md b/CHANGELOG.md index 8657ff44..81f44741 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file. ## [Unreleased] +- [#223](https://github.com/os2display/display-admin-client/pull/223) + - Updated to API Platform 3 - [#222](https://github.com/os2display/display-admin-client/pull/222) - Fixed redux build. @@ -39,8 +41,8 @@ All notable changes to this project will be documented in this file. - [#205](https://github.com/os2display/display-admin-client/pull/205) Setup separate image builds for itkdev and os2display - [#204](https://github.com/os2display/display-admin-client/pull/204) - Change docker image name from `os2display/os2display-admin-client` - to `os2display/display-admin-client` to match image name and + Change docker image name from `os2display/os2display-admin-client` + to `os2display/display-admin-client` to match image name and repository name - [#200](https://github.com/os2display/display-admin-client/pull/200) Update docker build to publish to "os2display" org on docker hub. @@ -65,7 +67,7 @@ All notable changes to this project will be documented in this file. Prevent screen-manager.js from redirecting before everything is saved. - [#192](https://github.com/os2display/display-admin-client/pull/193) Readd and fix cypress tests. -- +- ## [1.2.6] - 2023-05-11 - [#197](https://github.com/os2display/display-admin-client/pull/197) diff --git a/src/redux/api/api.generated.js b/src/redux/api/api.generated.js index 9eb9f2ad..d569e93d 100644 --- a/src/redux/api/api.generated.js +++ b/src/redux/api/api.generated.js @@ -1,7 +1,7 @@ "use strict"; exports.__esModule = true; -exports.useDeletePlaylistScreenRegionItemMutation = exports.usePutPlaylistScreenRegionItemMutation = exports.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery = exports.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation = exports.usePutV1ScreensByIdCampaignsMutation = exports.useGetV1ScreensByIdCampaignsQuery = exports.usePostScreenBindKeyMutation = exports.useDeleteV1ScreensByIdMutation = exports.usePutV1ScreensByIdMutation = exports.useGetV1ScreensByIdQuery = exports.usePostV1ScreensMutation = exports.useGetV1ScreensQuery = exports.useGetV1ScreenGroupsByIdScreensQuery = exports.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation = exports.usePutV1ScreenGroupsByIdCampaignsMutation = exports.useGetV1ScreenGroupsByIdCampaignsQuery = exports.useDeleteV1ScreenGroupsByIdMutation = exports.usePutV1ScreenGroupsByIdMutation = exports.useGetV1ScreenGroupsByIdQuery = exports.useGetScreenGroupCampaignItemQuery = exports.usePostV1ScreenGroupsMutation = exports.useGetV1ScreenGroupsQuery = exports.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation = exports.usePutV1PlaylistsByIdSlidesMutation = exports.useGetV1PlaylistsByIdSlidesQuery = exports.useDeleteV1PlaylistsByIdMutation = exports.usePutV1PlaylistsByIdMutation = exports.useGetV1PlaylistsByIdQuery = exports.usePostV1PlaylistsMutation = exports.useGetV1PlaylistsQuery = exports.useDeleteV1MediaByIdMutation = exports.useGetV1MediaByIdQuery = exports.usePostMediaCollectionMutation = exports.useGetV1MediaQuery = exports.useGetV1LayoutsByIdQuery = exports.useGetV1LayoutsQuery = exports.useGetV1FeedsByIdDataQuery = exports.useGetV1FeedsByIdQuery = exports.useGetV1FeedsQuery = exports.useGetV1FeedSourcesByIdConfigAndNameQuery = exports.useGetV1FeedSourcesByIdQuery = exports.useGetV1FeedSourcesQuery = exports.useGetV1CampaignsByIdScreensQuery = exports.useGetV1CampaignsByIdScreenGroupsQuery = exports.usePostRefreshTokenItemMutation = exports.usePostCredentialsItemMutation = exports.usePostLoginInfoScreenMutation = exports.useGetOidcAuthUrlsItemQuery = exports.useGetOidcAuthTokenItemQuery = exports.api = void 0; -exports.useDeleteV1ThemesByIdMutation = exports.usePutV1ThemesByIdMutation = exports.useGetV1ThemesByIdQuery = exports.usePostV1ThemesMutation = exports.useGetV1ThemesQuery = exports.useGetV1TenantsByIdQuery = exports.useGetV1TenantsQuery = exports.useGetV1TemplatesByIdQuery = exports.useGetV1TemplatesQuery = exports.usePutV1SlidesByIdPlaylistsMutation = exports.useGetV1SlidesByIdPlaylistsQuery = exports.useDeleteV1SlidesByIdMutation = exports.usePutV1SlidesByIdMutation = exports.useGetV1SlidesByIdQuery = exports.usePostV1SlidesMutation = exports.useGetV1SlidesQuery = exports.usePostScreenUnbindMutation = exports.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation = exports.usePutV1ScreensByIdScreenGroupsMutation = exports.useGetV1ScreensByIdScreenGroupsQuery = void 0; +exports.useGetV1ScreensByIdCampaignsQuery = exports.usePostScreenBindKeyMutation = exports.useDeleteV1ScreensByIdMutation = exports.usePutV1ScreensByIdMutation = exports.useGetV1ScreensByIdQuery = exports.usePostV1ScreensMutation = exports.useGetV1ScreensQuery = exports.useGetV1ScreenGroupsByIdScreensQuery = exports.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation = exports.usePutV1ScreenGroupsByIdCampaignsMutation = exports.useGetV1ScreenGroupsByIdCampaignsQuery = exports.useDeleteV1ScreenGroupsByIdMutation = exports.usePutV1ScreenGroupsByIdMutation = exports.useGetV1ScreenGroupsByIdQuery = exports.useGetScreenGroupCampaignItemQuery = exports.usePostV1ScreenGroupsMutation = exports.useGetV1ScreenGroupsQuery = exports.usePatchV1ScreenCampaignsMutation = exports.useDeleteV1ScreenCampaignsMutation = exports.usePostV1ScreenCampaignsMutation = exports.usePutV1ScreenCampaignsMutation = exports.useGetV1ScreenCampaignsQuery = exports.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation = exports.usePutV1PlaylistsByIdSlidesMutation = exports.useGetV1PlaylistsByIdSlidesQuery = exports.useDeleteV1PlaylistsByIdMutation = exports.usePutV1PlaylistsByIdMutation = exports.useGetV1PlaylistsByIdQuery = exports.usePostV1PlaylistsMutation = exports.useGetV1PlaylistsQuery = exports.useDeleteV1MediaByIdMutation = exports.useGetV1MediaByIdQuery = exports.usePostMediaCollectionMutation = exports.useGetV1MediaQuery = exports.useGetV1LayoutsByIdQuery = exports.useGetV1LayoutsQuery = exports.useGetV1FeedsByIdDataQuery = exports.useGetV1FeedsByIdQuery = exports.useGetV1FeedsQuery = exports.useGetV1FeedSourcesByIdConfigAndNameQuery = exports.useGetV1FeedSourcesByIdQuery = exports.useGetV1FeedSourcesQuery = exports.useGetV1CampaignsByIdScreensQuery = exports.useGetV1CampaignsByIdScreenGroupsQuery = exports.usePostRefreshTokenItemMutation = exports.useLoginCheckPostMutation = exports.usePostLoginInfoScreenMutation = exports.useGetOidcAuthUrlsItemQuery = exports.useGetOidcAuthTokenItemQuery = exports.api = void 0; +exports.useDeleteV1ThemesByIdMutation = exports.usePutV1ThemesByIdMutation = exports.useGetV1ThemesByIdQuery = exports.usePostV1ThemesMutation = exports.useGetV1ThemesQuery = exports.useGetV1TenantsByIdQuery = exports.useGetV1TenantsQuery = exports.useGetV1TemplatesByIdQuery = exports.useGetV1TemplatesQuery = exports.usePutV1SlidesByIdPlaylistsMutation = exports.useGetV1SlidesByIdPlaylistsQuery = exports.useDeleteV1SlidesByIdMutation = exports.usePutV1SlidesByIdMutation = exports.useGetV1SlidesByIdQuery = exports.usePostV1SlidesMutation = exports.useGetV1SlidesQuery = exports.usePostScreenUnbindMutation = exports.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation = exports.usePutV1ScreensByIdScreenGroupsMutation = exports.useGetV1ScreensByIdScreenGroupsQuery = exports.useDeletePlaylistScreenRegionItemMutation = exports.usePutPlaylistScreenRegionItemMutation = exports.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery = exports.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation = exports.usePutV1ScreensByIdCampaignsMutation = void 0; var react_1 = require("@reduxjs/toolkit/query/react"); var dynamic_base_query_1 = require("../dynamic-base-query"); exports.api = (0, react_1.createApi)({ @@ -11,7 +11,7 @@ exports.api = (0, react_1.createApi)({ getOidcAuthTokenItem: build.query({ query: function (queryArg) { return ({ url: "/v1/authentication/oidc/token", - params: { state: queryArg.state, id_token: queryArg.idToken } + params: { state: queryArg.state, code: queryArg.code } }); } }), getOidcAuthUrlsItem: build.query({ @@ -27,11 +27,11 @@ exports.api = (0, react_1.createApi)({ body: queryArg.screenLoginInput }); } }), - postCredentialsItem: build.mutation({ + loginCheckPost: build.mutation({ query: function (queryArg) { return ({ url: "/v1/authentication/token", method: "POST", - body: queryArg.credentials + body: queryArg.body }); } }), postRefreshTokenItem: build.mutation({ @@ -207,6 +207,36 @@ exports.api = (0, react_1.createApi)({ method: "DELETE" }); } }), + getV1ScreenCampaigns: build.query({ + query: function (queryArg) { return ({ + url: "/v1/screen-campaigns", + params: { page: queryArg.page, itemsPerPage: queryArg.itemsPerPage } + }); } + }), + putV1ScreenCampaigns: build.mutation({ + query: function (queryArg) { return ({ + url: "/v1/screen-campaigns", + method: "PUT", + body: queryArg.screenCampaign + }); } + }), + postV1ScreenCampaigns: build.mutation({ + query: function (queryArg) { return ({ + url: "/v1/screen-campaigns", + method: "POST", + body: queryArg.screenCampaign + }); } + }), + deleteV1ScreenCampaigns: build.mutation({ + query: function () { return ({ url: "/v1/screen-campaigns", method: "DELETE" }); } + }), + patchV1ScreenCampaigns: build.mutation({ + query: function (queryArg) { return ({ + url: "/v1/screen-campaigns", + method: "PATCH", + body: queryArg.body + }); } + }), getV1ScreenGroups: build.query({ query: function (queryArg) { return ({ url: "/v1/screen-groups", @@ -533,4 +563,4 @@ exports.api = (0, react_1.createApi)({ }) }); } }); -exports.useGetOidcAuthTokenItemQuery = exports.api.useGetOidcAuthTokenItemQuery, exports.useGetOidcAuthUrlsItemQuery = exports.api.useGetOidcAuthUrlsItemQuery, exports.usePostLoginInfoScreenMutation = exports.api.usePostLoginInfoScreenMutation, exports.usePostCredentialsItemMutation = exports.api.usePostCredentialsItemMutation, exports.usePostRefreshTokenItemMutation = exports.api.usePostRefreshTokenItemMutation, exports.useGetV1CampaignsByIdScreenGroupsQuery = exports.api.useGetV1CampaignsByIdScreenGroupsQuery, exports.useGetV1CampaignsByIdScreensQuery = exports.api.useGetV1CampaignsByIdScreensQuery, exports.useGetV1FeedSourcesQuery = exports.api.useGetV1FeedSourcesQuery, exports.useGetV1FeedSourcesByIdQuery = exports.api.useGetV1FeedSourcesByIdQuery, exports.useGetV1FeedSourcesByIdConfigAndNameQuery = exports.api.useGetV1FeedSourcesByIdConfigAndNameQuery, exports.useGetV1FeedsQuery = exports.api.useGetV1FeedsQuery, exports.useGetV1FeedsByIdQuery = exports.api.useGetV1FeedsByIdQuery, exports.useGetV1FeedsByIdDataQuery = exports.api.useGetV1FeedsByIdDataQuery, exports.useGetV1LayoutsQuery = exports.api.useGetV1LayoutsQuery, exports.useGetV1LayoutsByIdQuery = exports.api.useGetV1LayoutsByIdQuery, exports.useGetV1MediaQuery = exports.api.useGetV1MediaQuery, exports.usePostMediaCollectionMutation = exports.api.usePostMediaCollectionMutation, exports.useGetV1MediaByIdQuery = exports.api.useGetV1MediaByIdQuery, exports.useDeleteV1MediaByIdMutation = exports.api.useDeleteV1MediaByIdMutation, exports.useGetV1PlaylistsQuery = exports.api.useGetV1PlaylistsQuery, exports.usePostV1PlaylistsMutation = exports.api.usePostV1PlaylistsMutation, exports.useGetV1PlaylistsByIdQuery = exports.api.useGetV1PlaylistsByIdQuery, exports.usePutV1PlaylistsByIdMutation = exports.api.usePutV1PlaylistsByIdMutation, exports.useDeleteV1PlaylistsByIdMutation = exports.api.useDeleteV1PlaylistsByIdMutation, exports.useGetV1PlaylistsByIdSlidesQuery = exports.api.useGetV1PlaylistsByIdSlidesQuery, exports.usePutV1PlaylistsByIdSlidesMutation = exports.api.usePutV1PlaylistsByIdSlidesMutation, exports.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation = exports.api.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation, exports.useGetV1ScreenGroupsQuery = exports.api.useGetV1ScreenGroupsQuery, exports.usePostV1ScreenGroupsMutation = exports.api.usePostV1ScreenGroupsMutation, exports.useGetScreenGroupCampaignItemQuery = exports.api.useGetScreenGroupCampaignItemQuery, exports.useGetV1ScreenGroupsByIdQuery = exports.api.useGetV1ScreenGroupsByIdQuery, exports.usePutV1ScreenGroupsByIdMutation = exports.api.usePutV1ScreenGroupsByIdMutation, exports.useDeleteV1ScreenGroupsByIdMutation = exports.api.useDeleteV1ScreenGroupsByIdMutation, exports.useGetV1ScreenGroupsByIdCampaignsQuery = exports.api.useGetV1ScreenGroupsByIdCampaignsQuery, exports.usePutV1ScreenGroupsByIdCampaignsMutation = exports.api.usePutV1ScreenGroupsByIdCampaignsMutation, exports.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation = exports.api.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation, exports.useGetV1ScreenGroupsByIdScreensQuery = exports.api.useGetV1ScreenGroupsByIdScreensQuery, exports.useGetV1ScreensQuery = exports.api.useGetV1ScreensQuery, exports.usePostV1ScreensMutation = exports.api.usePostV1ScreensMutation, exports.useGetV1ScreensByIdQuery = exports.api.useGetV1ScreensByIdQuery, exports.usePutV1ScreensByIdMutation = exports.api.usePutV1ScreensByIdMutation, exports.useDeleteV1ScreensByIdMutation = exports.api.useDeleteV1ScreensByIdMutation, exports.usePostScreenBindKeyMutation = exports.api.usePostScreenBindKeyMutation, exports.useGetV1ScreensByIdCampaignsQuery = exports.api.useGetV1ScreensByIdCampaignsQuery, exports.usePutV1ScreensByIdCampaignsMutation = exports.api.usePutV1ScreensByIdCampaignsMutation, exports.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation = exports.api.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation, exports.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery = exports.api.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery, exports.usePutPlaylistScreenRegionItemMutation = exports.api.usePutPlaylistScreenRegionItemMutation, exports.useDeletePlaylistScreenRegionItemMutation = exports.api.useDeletePlaylistScreenRegionItemMutation, exports.useGetV1ScreensByIdScreenGroupsQuery = exports.api.useGetV1ScreensByIdScreenGroupsQuery, exports.usePutV1ScreensByIdScreenGroupsMutation = exports.api.usePutV1ScreensByIdScreenGroupsMutation, exports.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation = exports.api.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation, exports.usePostScreenUnbindMutation = exports.api.usePostScreenUnbindMutation, exports.useGetV1SlidesQuery = exports.api.useGetV1SlidesQuery, exports.usePostV1SlidesMutation = exports.api.usePostV1SlidesMutation, exports.useGetV1SlidesByIdQuery = exports.api.useGetV1SlidesByIdQuery, exports.usePutV1SlidesByIdMutation = exports.api.usePutV1SlidesByIdMutation, exports.useDeleteV1SlidesByIdMutation = exports.api.useDeleteV1SlidesByIdMutation, exports.useGetV1SlidesByIdPlaylistsQuery = exports.api.useGetV1SlidesByIdPlaylistsQuery, exports.usePutV1SlidesByIdPlaylistsMutation = exports.api.usePutV1SlidesByIdPlaylistsMutation, exports.useGetV1TemplatesQuery = exports.api.useGetV1TemplatesQuery, exports.useGetV1TemplatesByIdQuery = exports.api.useGetV1TemplatesByIdQuery, exports.useGetV1TenantsQuery = exports.api.useGetV1TenantsQuery, exports.useGetV1TenantsByIdQuery = exports.api.useGetV1TenantsByIdQuery, exports.useGetV1ThemesQuery = exports.api.useGetV1ThemesQuery, exports.usePostV1ThemesMutation = exports.api.usePostV1ThemesMutation, exports.useGetV1ThemesByIdQuery = exports.api.useGetV1ThemesByIdQuery, exports.usePutV1ThemesByIdMutation = exports.api.usePutV1ThemesByIdMutation, exports.useDeleteV1ThemesByIdMutation = exports.api.useDeleteV1ThemesByIdMutation; +exports.useGetOidcAuthTokenItemQuery = exports.api.useGetOidcAuthTokenItemQuery, exports.useGetOidcAuthUrlsItemQuery = exports.api.useGetOidcAuthUrlsItemQuery, exports.usePostLoginInfoScreenMutation = exports.api.usePostLoginInfoScreenMutation, exports.useLoginCheckPostMutation = exports.api.useLoginCheckPostMutation, exports.usePostRefreshTokenItemMutation = exports.api.usePostRefreshTokenItemMutation, exports.useGetV1CampaignsByIdScreenGroupsQuery = exports.api.useGetV1CampaignsByIdScreenGroupsQuery, exports.useGetV1CampaignsByIdScreensQuery = exports.api.useGetV1CampaignsByIdScreensQuery, exports.useGetV1FeedSourcesQuery = exports.api.useGetV1FeedSourcesQuery, exports.useGetV1FeedSourcesByIdQuery = exports.api.useGetV1FeedSourcesByIdQuery, exports.useGetV1FeedSourcesByIdConfigAndNameQuery = exports.api.useGetV1FeedSourcesByIdConfigAndNameQuery, exports.useGetV1FeedsQuery = exports.api.useGetV1FeedsQuery, exports.useGetV1FeedsByIdQuery = exports.api.useGetV1FeedsByIdQuery, exports.useGetV1FeedsByIdDataQuery = exports.api.useGetV1FeedsByIdDataQuery, exports.useGetV1LayoutsQuery = exports.api.useGetV1LayoutsQuery, exports.useGetV1LayoutsByIdQuery = exports.api.useGetV1LayoutsByIdQuery, exports.useGetV1MediaQuery = exports.api.useGetV1MediaQuery, exports.usePostMediaCollectionMutation = exports.api.usePostMediaCollectionMutation, exports.useGetV1MediaByIdQuery = exports.api.useGetV1MediaByIdQuery, exports.useDeleteV1MediaByIdMutation = exports.api.useDeleteV1MediaByIdMutation, exports.useGetV1PlaylistsQuery = exports.api.useGetV1PlaylistsQuery, exports.usePostV1PlaylistsMutation = exports.api.usePostV1PlaylistsMutation, exports.useGetV1PlaylistsByIdQuery = exports.api.useGetV1PlaylistsByIdQuery, exports.usePutV1PlaylistsByIdMutation = exports.api.usePutV1PlaylistsByIdMutation, exports.useDeleteV1PlaylistsByIdMutation = exports.api.useDeleteV1PlaylistsByIdMutation, exports.useGetV1PlaylistsByIdSlidesQuery = exports.api.useGetV1PlaylistsByIdSlidesQuery, exports.usePutV1PlaylistsByIdSlidesMutation = exports.api.usePutV1PlaylistsByIdSlidesMutation, exports.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation = exports.api.useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation, exports.useGetV1ScreenCampaignsQuery = exports.api.useGetV1ScreenCampaignsQuery, exports.usePutV1ScreenCampaignsMutation = exports.api.usePutV1ScreenCampaignsMutation, exports.usePostV1ScreenCampaignsMutation = exports.api.usePostV1ScreenCampaignsMutation, exports.useDeleteV1ScreenCampaignsMutation = exports.api.useDeleteV1ScreenCampaignsMutation, exports.usePatchV1ScreenCampaignsMutation = exports.api.usePatchV1ScreenCampaignsMutation, exports.useGetV1ScreenGroupsQuery = exports.api.useGetV1ScreenGroupsQuery, exports.usePostV1ScreenGroupsMutation = exports.api.usePostV1ScreenGroupsMutation, exports.useGetScreenGroupCampaignItemQuery = exports.api.useGetScreenGroupCampaignItemQuery, exports.useGetV1ScreenGroupsByIdQuery = exports.api.useGetV1ScreenGroupsByIdQuery, exports.usePutV1ScreenGroupsByIdMutation = exports.api.usePutV1ScreenGroupsByIdMutation, exports.useDeleteV1ScreenGroupsByIdMutation = exports.api.useDeleteV1ScreenGroupsByIdMutation, exports.useGetV1ScreenGroupsByIdCampaignsQuery = exports.api.useGetV1ScreenGroupsByIdCampaignsQuery, exports.usePutV1ScreenGroupsByIdCampaignsMutation = exports.api.usePutV1ScreenGroupsByIdCampaignsMutation, exports.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation = exports.api.useDeleteV1ScreenGroupsByIdCampaignsAndCampaignIdMutation, exports.useGetV1ScreenGroupsByIdScreensQuery = exports.api.useGetV1ScreenGroupsByIdScreensQuery, exports.useGetV1ScreensQuery = exports.api.useGetV1ScreensQuery, exports.usePostV1ScreensMutation = exports.api.usePostV1ScreensMutation, exports.useGetV1ScreensByIdQuery = exports.api.useGetV1ScreensByIdQuery, exports.usePutV1ScreensByIdMutation = exports.api.usePutV1ScreensByIdMutation, exports.useDeleteV1ScreensByIdMutation = exports.api.useDeleteV1ScreensByIdMutation, exports.usePostScreenBindKeyMutation = exports.api.usePostScreenBindKeyMutation, exports.useGetV1ScreensByIdCampaignsQuery = exports.api.useGetV1ScreensByIdCampaignsQuery, exports.usePutV1ScreensByIdCampaignsMutation = exports.api.usePutV1ScreensByIdCampaignsMutation, exports.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation = exports.api.useDeleteV1ScreensByIdCampaignsAndCampaignIdMutation, exports.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery = exports.api.useGetV1ScreensByIdRegionsAndRegionIdPlaylistsQuery, exports.usePutPlaylistScreenRegionItemMutation = exports.api.usePutPlaylistScreenRegionItemMutation, exports.useDeletePlaylistScreenRegionItemMutation = exports.api.useDeletePlaylistScreenRegionItemMutation, exports.useGetV1ScreensByIdScreenGroupsQuery = exports.api.useGetV1ScreensByIdScreenGroupsQuery, exports.usePutV1ScreensByIdScreenGroupsMutation = exports.api.usePutV1ScreensByIdScreenGroupsMutation, exports.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation = exports.api.useDeleteV1ScreensByIdScreenGroupsAndScreenGroupIdMutation, exports.usePostScreenUnbindMutation = exports.api.usePostScreenUnbindMutation, exports.useGetV1SlidesQuery = exports.api.useGetV1SlidesQuery, exports.usePostV1SlidesMutation = exports.api.usePostV1SlidesMutation, exports.useGetV1SlidesByIdQuery = exports.api.useGetV1SlidesByIdQuery, exports.usePutV1SlidesByIdMutation = exports.api.usePutV1SlidesByIdMutation, exports.useDeleteV1SlidesByIdMutation = exports.api.useDeleteV1SlidesByIdMutation, exports.useGetV1SlidesByIdPlaylistsQuery = exports.api.useGetV1SlidesByIdPlaylistsQuery, exports.usePutV1SlidesByIdPlaylistsMutation = exports.api.usePutV1SlidesByIdPlaylistsMutation, exports.useGetV1TemplatesQuery = exports.api.useGetV1TemplatesQuery, exports.useGetV1TemplatesByIdQuery = exports.api.useGetV1TemplatesByIdQuery, exports.useGetV1TenantsQuery = exports.api.useGetV1TenantsQuery, exports.useGetV1TenantsByIdQuery = exports.api.useGetV1TenantsByIdQuery, exports.useGetV1ThemesQuery = exports.api.useGetV1ThemesQuery, exports.usePostV1ThemesMutation = exports.api.usePostV1ThemesMutation, exports.useGetV1ThemesByIdQuery = exports.api.useGetV1ThemesByIdQuery, exports.usePutV1ThemesByIdMutation = exports.api.usePutV1ThemesByIdMutation, exports.useDeleteV1ThemesByIdMutation = exports.api.useDeleteV1ThemesByIdMutation; diff --git a/src/redux/api/api.generated.ts b/src/redux/api/api.generated.ts index 73ccbf90..2afcfcda 100644 --- a/src/redux/api/api.generated.ts +++ b/src/redux/api/api.generated.ts @@ -10,7 +10,7 @@ export const api = createApi({ >({ query: (queryArg) => ({ url: `/v1/authentication/oidc/token`, - params: { state: queryArg.state, id_token: queryArg.idToken }, + params: { state: queryArg.state, code: queryArg.code }, }), }), getOidcAuthUrlsItem: build.query< @@ -32,14 +32,14 @@ export const api = createApi({ body: queryArg.screenLoginInput, }), }), - postCredentialsItem: build.mutation< - PostCredentialsItemApiResponse, - PostCredentialsItemApiArg + loginCheckPost: build.mutation< + LoginCheckPostApiResponse, + LoginCheckPostApiArg >({ query: (queryArg) => ({ url: `/v1/authentication/token`, method: "POST", - body: queryArg.credentials, + body: queryArg.body, }), }), postRefreshTokenItem: build.mutation< @@ -275,6 +275,51 @@ export const api = createApi({ method: "DELETE", }), }), + getV1ScreenCampaigns: build.query< + GetV1ScreenCampaignsApiResponse, + GetV1ScreenCampaignsApiArg + >({ + query: (queryArg) => ({ + url: `/v1/screen-campaigns`, + params: { page: queryArg.page, itemsPerPage: queryArg.itemsPerPage }, + }), + }), + putV1ScreenCampaigns: build.mutation< + PutV1ScreenCampaignsApiResponse, + PutV1ScreenCampaignsApiArg + >({ + query: (queryArg) => ({ + url: `/v1/screen-campaigns`, + method: "PUT", + body: queryArg.screenCampaign, + }), + }), + postV1ScreenCampaigns: build.mutation< + PostV1ScreenCampaignsApiResponse, + PostV1ScreenCampaignsApiArg + >({ + query: (queryArg) => ({ + url: `/v1/screen-campaigns`, + method: "POST", + body: queryArg.screenCampaign, + }), + }), + deleteV1ScreenCampaigns: build.mutation< + DeleteV1ScreenCampaignsApiResponse, + DeleteV1ScreenCampaignsApiArg + >({ + query: () => ({ url: `/v1/screen-campaigns`, method: "DELETE" }), + }), + patchV1ScreenCampaigns: build.mutation< + PatchV1ScreenCampaignsApiResponse, + PatchV1ScreenCampaignsApiArg + >({ + query: (queryArg) => ({ + url: `/v1/screen-campaigns`, + method: "PATCH", + body: queryArg.body, + }), + }), getV1ScreenGroups: build.query< GetV1ScreenGroupsApiResponse, GetV1ScreenGroupsApiArg @@ -710,12 +755,12 @@ export const api = createApi({ }), }); export type GetOidcAuthTokenItemApiResponse = - /** status 200 Get JWT token from OIDC token */ Token; + /** status 200 Get JWT token from OIDC code */ Token; export type GetOidcAuthTokenItemApiArg = { /** OIDC state */ state?: string; - /** OIDC id token */ - idToken?: string; + /** OIDC code */ + code?: string; }; export type GetOidcAuthUrlsItemApiResponse = /** status 200 Get authentication and end session endpoints */ OidcEndpoints; @@ -729,11 +774,15 @@ export type PostLoginInfoScreenApiArg = { /** Get login info with JWT token for given nonce */ screenLoginInput: ScreenLoginInput; }; -export type PostCredentialsItemApiResponse = - /** status 200 Get JWT token */ Token; -export type PostCredentialsItemApiArg = { - /** Generate new JWT Token */ - credentials: Credentials; +export type LoginCheckPostApiResponse = /** status 200 User token created */ { + token: string; +}; +export type LoginCheckPostApiArg = { + /** The login data */ + body: { + email: string; + password: string; + }; }; export type PostRefreshTokenItemApiResponse = /** status 200 Refresh JWT token */ RefreshTokenResponse; @@ -925,7 +974,7 @@ export type GetV1PlaylistsByIdSlidesApiArg = { }; export type PutV1PlaylistsByIdSlidesApiResponse = unknown; export type PutV1PlaylistsByIdSlidesApiArg = { - /** Resource identifier */ + /** PlaylistSlide identifier */ id: string; body: Blob; }; @@ -934,6 +983,30 @@ export type DeleteV1PlaylistsByIdSlidesAndSlideIdApiArg = { id: string; slideId: string; }; +export type GetV1ScreenCampaignsApiResponse = unknown; +export type GetV1ScreenCampaignsApiArg = { + /** The collection page number */ + page?: number; + /** The number of items per page */ + itemsPerPage?: number; +}; +export type PutV1ScreenCampaignsApiResponse = unknown; +export type PutV1ScreenCampaignsApiArg = { + /** The updated ScreenCampaign resource */ + screenCampaign: ScreenCampaign; +}; +export type PostV1ScreenCampaignsApiResponse = unknown; +export type PostV1ScreenCampaignsApiArg = { + /** The new ScreenCampaign resource */ + screenCampaign: ScreenCampaign; +}; +export type DeleteV1ScreenCampaignsApiResponse = unknown; +export type DeleteV1ScreenCampaignsApiArg = void; +export type PatchV1ScreenCampaignsApiResponse = unknown; +export type PatchV1ScreenCampaignsApiArg = { + /** The updated ScreenCampaign resource */ + body: Blob; +}; export type GetV1ScreenGroupsApiResponse = unknown; export type GetV1ScreenGroupsApiArg = { page?: number; @@ -960,7 +1033,7 @@ export type PostV1ScreenGroupsApiArg = { }; export type GetScreenGroupCampaignItemApiResponse = unknown; export type GetScreenGroupCampaignItemApiArg = { - /** Resource identifier */ + /** ScreenGroupCampaign identifier */ id: string; }; export type GetV1ScreenGroupsByIdApiResponse = unknown; @@ -997,7 +1070,7 @@ export type GetV1ScreenGroupsByIdCampaignsApiArg = { }; export type PutV1ScreenGroupsByIdCampaignsApiResponse = unknown; export type PutV1ScreenGroupsByIdCampaignsApiArg = { - /** Resource identifier */ + /** ScreenGroupCampaign identifier */ id: string; body: Blob; }; @@ -1078,7 +1151,7 @@ export type GetV1ScreensByIdCampaignsApiArg = { }; export type PutV1ScreensByIdCampaignsApiResponse = unknown; export type PutV1ScreensByIdCampaignsApiArg = { - /** Resource identifier */ + /** ScreenCampaign identifier */ id: string; body: Blob; }; @@ -1281,6 +1354,7 @@ export type DeleteV1ThemesByIdApiArg = { export type Token = { token?: string; refresh_token?: string; + refresh_token_expiration?: any; tenants?: { tenantKey?: string; title?: string; @@ -1301,10 +1375,6 @@ export type ScreenLoginOutput = { token?: string; }; export type ScreenLoginInput = object; -export type Credentials = { - email?: string; - password?: string; -}; export type RefreshTokenResponse = { token?: string; refresh_token?: string; @@ -1320,6 +1390,10 @@ export type PlaylistPlaylistInput = { isCampaign?: boolean; published?: string[]; }; +export type ScreenCampaign = { + campaign?: string; + screen?: string; +}; export type ScreenGroupScreenGroupInput = { title?: string; description?: string; @@ -1330,8 +1404,9 @@ export type ScreenScreenInput = { size?: string; layout?: string; location?: string; - dimensions?: string[]; - enableColorSchemeChange?: boolean | null; + resolution?: string; + orientation?: string; + enableColorSchemeChange?: any; }; export type ScreenBindObject = { bindKey?: string; @@ -1341,9 +1416,9 @@ export type SlideSlideInput = { description?: string; templateInfo?: string[]; theme?: string; - duration?: number | null; + duration?: any; published?: string[]; - feed?: string[] | null; + feed?: string[]; media?: string[]; content?: string[]; }; @@ -1357,7 +1432,7 @@ export const { useGetOidcAuthTokenItemQuery, useGetOidcAuthUrlsItemQuery, usePostLoginInfoScreenMutation, - usePostCredentialsItemMutation, + useLoginCheckPostMutation, usePostRefreshTokenItemMutation, useGetV1CampaignsByIdScreenGroupsQuery, useGetV1CampaignsByIdScreensQuery, @@ -1381,6 +1456,11 @@ export const { useGetV1PlaylistsByIdSlidesQuery, usePutV1PlaylistsByIdSlidesMutation, useDeleteV1PlaylistsByIdSlidesAndSlideIdMutation, + useGetV1ScreenCampaignsQuery, + usePutV1ScreenCampaignsMutation, + usePostV1ScreenCampaignsMutation, + useDeleteV1ScreenCampaignsMutation, + usePatchV1ScreenCampaignsMutation, useGetV1ScreenGroupsQuery, usePostV1ScreenGroupsMutation, useGetScreenGroupCampaignItemQuery, diff --git a/src/redux/api/api.json b/src/redux/api/api.json index f2030576..aa3b8121 100644 --- a/src/redux/api/api.json +++ b/src/redux/api/api.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.3", + "openapi": "3.1.0", "info": { "title": "OS2Display Service API", "description": "API description", @@ -23,7 +23,7 @@ ], "responses": { "200": { - "description": "Get JWT token from OIDC token", + "description": "Get JWT token from OIDC code", "content": { "application/json": { "schema": { @@ -33,8 +33,7 @@ } } }, - "summary": "Get JWT token to login from OIDC token", - "description": "", + "summary": "Get JWT token to login from OIDC code", "parameters": [ { "name": "state", @@ -47,8 +46,8 @@ } }, { - "name": "id_token", - "description": "OIDC id token", + "name": "code", + "description": "OIDC code", "in": "query", "required": false, "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", @@ -56,8 +55,7 @@ "type": "string" } } - ], - "deprecated": false + ] }, "parameters": [] }, @@ -80,7 +78,6 @@ } }, "summary": "Get OpenID connect URLs", - "description": "", "parameters": [ { "name": "providerKey", @@ -92,8 +89,7 @@ "type": "string" } } - ], - "deprecated": false + ] }, "parameters": [] }, @@ -116,8 +112,6 @@ } }, "summary": "Get login info for a screen.", - "description": "", - "parameters": [], "requestBody": { "description": "Get login info with JWT token for given nonce", "content": { @@ -128,44 +122,65 @@ } }, "required": false - }, - "deprecated": false + } }, "parameters": [] }, "/v1/authentication/token": { "post": { - "operationId": "postCredentialsItem", + "operationId": "login_check_post", "tags": [ - "Authentication" + "Login Check" ], "responses": { "200": { - "description": "Get JWT token", + "description": "User token created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Token" + "type": "object", + "properties": { + "token": { + "readOnly": true, + "type": "string", + "nullable": false + } + }, + "required": [ + "token" + ] } } } } }, - "summary": "Get JWT token to login from local user.", - "description": "", - "parameters": [], + "summary": "Creates a user token.", + "description": "Creates a user token.", "requestBody": { - "description": "Generate new JWT Token", + "description": "The login data", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Credentials" + "type": "object", + "properties": { + "email": { + "type": "string", + "nullable": false + }, + "password": { + "type": "string", + "nullable": false + } + }, + "required": [ + "email", + "password" + ] } } }, - "required": false - }, - "deprecated": false + "required": true + } }, "parameters": [] }, @@ -188,8 +203,6 @@ } }, "summary": "Get JWT token from refresh token.", - "description": "", - "parameters": [], "requestBody": { "description": "Refresh JWT Token", "content": { @@ -200,8 +213,7 @@ } }, "required": false - }, - "deprecated": false + } }, "parameters": [] }, @@ -255,6 +267,14 @@ "type": "string", "format": "iri-reference" } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" } }, "hydra:search": { @@ -281,8 +301,10 @@ "type": "string" }, "property": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "required": { "type": "boolean" @@ -441,6 +463,14 @@ "type": "string", "format": "iri-reference" } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" } }, "hydra:search": { @@ -467,8 +497,10 @@ "type": "string" }, "property": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "required": { "type": "boolean" @@ -591,7 +623,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of FeedSource resources.", @@ -823,10 +855,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Feed Source resource.", @@ -861,7 +890,6 @@ ], "responses": { "200": { - "description": "", "content": { "application/ld+json": { "examples": { @@ -877,10 +905,7 @@ } } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Get config for name from a feed source.", @@ -936,7 +961,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of Feed resources.", @@ -1073,10 +1098,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a feed resource.", @@ -1111,7 +1133,6 @@ ], "responses": { "200": { - "description": "", "content": { "application/ld+json": { "examples": { @@ -1135,10 +1156,7 @@ } } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Get data from a feed.", @@ -1177,9 +1195,9 @@ "content": { "application/ld+json": { "examples": null - } - }, - "headers": {} + }, + "headers": [] + } } }, "summary": "Retrieves a collection of layouts resources.", @@ -1238,10 +1256,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a screen layout resource.", @@ -1282,7 +1297,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of Media resources.", @@ -1542,7 +1557,7 @@ }, "/v1/media/{id}": { "get": { - "operationId": "get-v1-media-id", + "operationId": "getV1MediaById", "tags": [ "Media" ], @@ -1554,10 +1569,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Media resource.", @@ -1633,7 +1645,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieve a collection of Playlist resources.", @@ -1938,10 +1950,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieves a Playlist resource.", @@ -2097,7 +2106,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves collection of weighted slide resources.", @@ -2254,44 +2263,6 @@ "Playlists" ], "responses": { - "200": { - "description": "PlaylistSlide resource updated", - "content": { - "application/ld+json": { - "schema": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide.jsonld" - } - }, - "text/html": { - "schema": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" - } - } - }, - "links": { - "GetPlaylistSlideItem": { - "operationId": "getPlaylistSlideItem", - "parameters": { - "id": "$response.body#/id" - }, - "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /v1/playlist-slides/{id}`." - } - } - }, - "400": { - "description": "Invalid input" - }, - "422": { - "description": "Unprocessable entity" - }, - "404": { - "description": "Resource not found" - }, "201": { "description": "Created", "content": { @@ -2323,7 +2294,7 @@ { "name": "id", "in": "path", - "description": "Resource identifier", + "description": "PlaylistSlide identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -2418,37 +2389,140 @@ }, "parameters": [] }, - "/v1/screen-groups": { + "/v1/screen-campaigns": { "get": { - "operationId": "get-v1-screen-groups", + "operationId": "api_v1screen-campaigns_get_collection", "tags": [ - "ScreenGroups" + "ScreenCampaign" ], "responses": { "200": { - "description": "OK", + "description": "ScreenCampaign collection", "content": { "application/ld+json": { - "examples": null + "schema": { + "type": "object", + "properties": { + "hydra:member": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "hydra:totalItems": { + "type": "integer", + "minimum": 0 + }, + "hydra:view": { + "type": "object", + "properties": { + "@id": { + "type": "string", + "format": "iri-reference" + }, + "@type": { + "type": "string" + }, + "hydra:first": { + "type": "string", + "format": "iri-reference" + }, + "hydra:last": { + "type": "string", + "format": "iri-reference" + }, + "hydra:previous": { + "type": "string", + "format": "iri-reference" + }, + "hydra:next": { + "type": "string", + "format": "iri-reference" + } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" + } + }, + "hydra:search": { + "type": "object", + "properties": { + "@type": { + "type": "string" + }, + "hydra:template": { + "type": "string" + }, + "hydra:variableRepresentation": { + "type": "string" + }, + "hydra:mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@type": { + "type": "string" + }, + "variable": { + "type": "string" + }, + "property": { + "type": [ + "string", + "null" + ] + }, + "required": { + "type": "boolean" + } + } + } + } + } + } + }, + "required": [ + "hydra:member" + ] + } + }, + "text/html": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "multipart/form-data": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } } - }, - "headers": {} + } } }, - "summary": "Retrieves a collection of Screen group resources.", - "description": "Retrieve a collection of Screen group resources.", + "summary": "Retrieves the collection of ScreenCampaign resources.", + "description": "Retrieves the collection of ScreenCampaign resources.", "parameters": [ { "name": "page", "in": "query", - "description": "", + "description": "The collection page number", "required": false, "deprecated": false, - "allowEmptyValue": false, + "allowEmptyValue": true, "schema": { "type": "integer", - "minimum": 0, - "format": "int32", "default": 1 }, "style": "form", @@ -2461,24 +2535,277 @@ "description": "The number of items per page", "required": false, "deprecated": false, - "allowEmptyValue": false, - "schema": { - "type": "string", - "default": "10" - }, - "style": "form", - "explode": false, - "allowReserved": false - }, - { - "name": "title", - "in": "query", - "description": "", - "required": false, - "deprecated": false, "allowEmptyValue": true, "schema": { - "type": "string" + "type": "integer", + "default": 10, + "minimum": 0, + "maximum": 30 + }, + "style": "form", + "explode": false, + "allowReserved": false + } + ], + "deprecated": false + }, + "put": { + "operationId": "api_v1screen-campaigns_put", + "tags": [ + "ScreenCampaign" + ], + "responses": { + "200": { + "description": "ScreenCampaign resource updated", + "content": { + "application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "links": {} + }, + "400": { + "description": "Invalid input" + }, + "422": { + "description": "Unprocessable entity" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Replaces the ScreenCampaign resource.", + "description": "Replaces the ScreenCampaign resource.", + "parameters": [], + "requestBody": { + "description": "The updated ScreenCampaign resource", + "content": { + "application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "required": true + }, + "deprecated": false + }, + "post": { + "operationId": "api_v1screen-campaigns_post", + "tags": [ + "ScreenCampaign" + ], + "responses": { + "201": { + "description": "ScreenCampaign resource created", + "content": { + "application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "links": {} + }, + "400": { + "description": "Invalid input" + }, + "422": { + "description": "Unprocessable entity" + } + }, + "summary": "Creates a ScreenCampaign resource.", + "description": "Creates a ScreenCampaign resource.", + "parameters": [], + "requestBody": { + "description": "The new ScreenCampaign resource", + "content": { + "application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "required": true + }, + "deprecated": false + }, + "delete": { + "operationId": "api_v1screen-campaigns_delete", + "tags": [ + "ScreenCampaign" + ], + "responses": { + "204": { + "description": "ScreenCampaign resource deleted" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Removes the ScreenCampaign resource.", + "description": "Removes the ScreenCampaign resource.", + "parameters": [], + "deprecated": false + }, + "patch": { + "operationId": "api_v1screen-campaigns_patch", + "tags": [ + "ScreenCampaign" + ], + "responses": { + "200": { + "description": "ScreenCampaign resource updated", + "content": { + "application/ld+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign.jsonld" + } + }, + "text/html": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + }, + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "links": {} + }, + "400": { + "description": "Invalid input" + }, + "422": { + "description": "Unprocessable entity" + }, + "404": { + "description": "Resource not found" + } + }, + "summary": "Updates the ScreenCampaign resource.", + "description": "Updates the ScreenCampaign resource.", + "parameters": [], + "requestBody": { + "description": "The updated ScreenCampaign resource", + "content": { + "application/merge-patch+json": { + "schema": { + "$ref": "#/components/schemas/ScreenCampaign" + } + } + }, + "required": true + }, + "deprecated": false + }, + "parameters": [] + }, + "/v1/screen-groups": { + "get": { + "operationId": "get-v1-screen-groups", + "tags": [ + "ScreenGroups" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/ld+json": { + "examples": null + } + }, + "headers": [] + } + }, + "summary": "Retrieves a collection of Screen group resources.", + "description": "Retrieve a collection of Screen group resources.", + "parameters": [ + { + "name": "page", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "integer", + "minimum": 0, + "format": "int32", + "default": 1 + }, + "style": "form", + "explode": false, + "allowReserved": false + }, + { + "name": "itemsPerPage", + "in": "query", + "description": "The number of items per page", + "required": false, + "deprecated": false, + "allowEmptyValue": false, + "schema": { + "type": "string", + "default": "10" + }, + "style": "form", + "explode": false, + "allowReserved": false + }, + { + "name": "title", + "in": "query", + "description": "", + "required": false, + "deprecated": false, + "allowEmptyValue": true, + "schema": { + "type": "string" }, "style": "form", "explode": false, @@ -2716,7 +3043,7 @@ { "name": "id", "in": "path", - "description": "Resource identifier", + "description": "ScreenGroupCampaign identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -2746,10 +3073,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Screen group resource.", @@ -2905,7 +3229,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves collection of campaign resources connected to a screen group.", @@ -3062,44 +3386,6 @@ "ScreenGroups" ], "responses": { - "200": { - "description": "ScreenGroupCampaign resource updated", - "content": { - "application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ScreenGroupCampaign.ScreenGroupCampaign.jsonld" - } - }, - "text/html": { - "schema": { - "$ref": "#/components/schemas/ScreenGroupCampaign.ScreenGroupCampaign" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/ScreenGroupCampaign.ScreenGroupCampaign" - } - } - }, - "links": { - "GetScreenGroupCampaignItem": { - "operationId": "getScreenGroupCampaignItem", - "parameters": { - "id": "$response.body#/id" - }, - "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /v1/screen-groups-campaigns/{id}`." - } - } - }, - "400": { - "description": "Invalid input" - }, - "422": { - "description": "Unprocessable entity" - }, - "404": { - "description": "Resource not found" - }, "201": { "description": "Created", "content": { @@ -3128,7 +3414,7 @@ { "name": "id", "in": "path", - "description": "Resource identifier", + "description": "ScreenGroupCampaign identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -3270,6 +3556,14 @@ "type": "string", "format": "iri-reference" } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" } }, "hydra:search": { @@ -3296,8 +3590,10 @@ "type": "string" }, "property": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "required": { "type": "boolean" @@ -3402,7 +3698,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of Screen resources.", @@ -3649,10 +3945,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Screen resource.", @@ -3806,7 +4099,6 @@ } }, "summary": "Bind screen with BindKey", - "description": "", "parameters": [ { "name": "id", @@ -3833,8 +4125,7 @@ } }, "required": false - }, - "deprecated": false + } }, "parameters": [] }, @@ -3852,7 +4143,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves collection of campaign resources.", @@ -4009,46 +4300,8 @@ "Screens" ], "responses": { - "200": { - "description": "ScreenCampaign resource updated", - "content": { - "application/ld+json": { - "schema": { - "$ref": "#/components/schemas/ScreenCampaign.ScreenCampaign.jsonld" - } - }, - "text/html": { - "schema": { - "$ref": "#/components/schemas/ScreenCampaign.ScreenCampaign" - } - }, - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/ScreenCampaign.ScreenCampaign" - } - } - }, - "links": { - "GetScreenCampaignItem": { - "operationId": "getScreenCampaignItem", - "parameters": { - "id": "$response.body#/id" - }, - "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /v1/screen-campaigns/{id}`." - } - } - }, - "400": { - "description": "Invalid input" - }, - "422": { - "description": "Unprocessable entity" - }, - "404": { - "description": "Resource not found" - }, - "201": { - "description": "Created", + "201": { + "description": "Created", "content": { "application/ld+json": { "schema": { @@ -4075,7 +4328,7 @@ { "name": "id", "in": "path", - "description": "Resource identifier", + "description": "ScreenCampaign identifier", "required": true, "deprecated": false, "allowEmptyValue": false, @@ -4217,6 +4470,14 @@ "type": "string", "format": "iri-reference" } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" } }, "hydra:search": { @@ -4243,8 +4504,10 @@ "type": "string" }, "property": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "required": { "type": "boolean" @@ -4372,17 +4635,11 @@ "200": { "description": "Not used - remove the default 200 response" }, - "400": { - "description": "Invalid input" - }, - "422": { - "description": "Unprocessable entity" + "201": { + "description": "Created" }, "404": { "description": "Not found" - }, - "201": { - "description": "Created" } }, "summary": "Add Playlist resource from screen region.", @@ -4570,6 +4827,14 @@ "type": "string", "format": "iri-reference" } + }, + "example": { + "@id": "string", + "type": "string", + "hydra:first": "string", + "hydra:last": "string", + "hydra:previous": "string", + "hydra:next": "string" } }, "hydra:search": { @@ -4596,8 +4861,10 @@ "type": "string" }, "property": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "required": { "type": "boolean" @@ -4735,15 +5002,6 @@ "examples": null } } - }, - "400": { - "description": "Invalid input" - }, - "422": { - "description": "Unprocessable entity" - }, - "404": { - "description": "Resource not found" } }, "summary": "Update the collection of ScreenGroups on a Screen.", @@ -4850,7 +5108,6 @@ } }, "summary": "Unbind screen from machine", - "description": "", "parameters": [ { "name": "id", @@ -4871,8 +5128,7 @@ "description": "Unbind from machine", "content": {}, "required": false - }, - "deprecated": false + } }, "parameters": [] }, @@ -4890,7 +5146,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of Slide resources.", @@ -5165,10 +5421,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Slide resource.", @@ -5324,7 +5577,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Get the collection of playlist connected to a slide.", @@ -5486,119 +5739,30 @@ "content": { "application/ld+json": { "schema": { - "type": "object", - "properties": { - "hydra:member": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide.jsonld" - } - }, - "hydra:totalItems": { - "type": "integer", - "minimum": 0 - }, - "hydra:view": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "format": "iri-reference" - }, - "@type": { - "type": "string" - }, - "hydra:first": { - "type": "string", - "format": "iri-reference" - }, - "hydra:last": { - "type": "string", - "format": "iri-reference" - }, - "hydra:previous": { - "type": "string", - "format": "iri-reference" - }, - "hydra:next": { - "type": "string", - "format": "iri-reference" - } - } - }, - "hydra:search": { - "type": "object", - "properties": { - "@type": { - "type": "string" - }, - "hydra:template": { - "type": "string" - }, - "hydra:variableRepresentation": { - "type": "string" - }, - "hydra:mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "@type": { - "type": "string" - }, - "variable": { - "type": "string" - }, - "property": { - "type": "string", - "nullable": true - }, - "required": { - "type": "boolean" - } - } - } - } - } - } - }, - "required": [ - "hydra:member" - ] + "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide.jsonld" } }, "text/html": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" - } + "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" } }, "multipart/form-data": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" - } + "$ref": "#/components/schemas/PlaylistSlide.PlaylistSlide" } } }, - "links": { - "GetPlaylistSlideItem": { - "operationId": "getPlaylistSlideItem", - "parameters": { - "id": "$response.body#/id" - }, - "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /v1/playlist-slides/{id}`." - } - } + "links": {} }, "400": { "description": "Invalid input" }, "422": { "description": "Unprocessable entity" + }, + "404": { + "description": "Resource not found" } }, "summary": "Retrieves collection of playlistresources.", @@ -5661,7 +5825,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieve a collection of Template resources.", @@ -5826,10 +5990,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Template resource.", @@ -5870,7 +6031,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieves a collection of tenant resources.", @@ -6017,10 +6178,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a tenant resource.", @@ -6061,7 +6219,7 @@ "examples": null } }, - "headers": {} + "headers": [] } }, "summary": "Retrieve a collection of Theme resources.", @@ -6257,17 +6415,17 @@ "content": { "application/ld+json": { "schema": { - "$ref": "#/components/schemas/Theme.Theme.jsonld" + "$ref": "#/components/schemas/Theme.jsonld" } }, "text/html": { "schema": { - "$ref": "#/components/schemas/Theme.Theme" + "$ref": "#/components/schemas/Theme" } }, "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/Theme.Theme" + "$ref": "#/components/schemas/Theme" } } }, @@ -6322,10 +6480,7 @@ "examples": null } }, - "headers": {} - }, - "404": { - "description": "Resource not found" + "headers": [] } }, "summary": "Retrieve a Theme resource.", @@ -6361,17 +6516,17 @@ "content": { "application/ld+json": { "schema": { - "$ref": "#/components/schemas/Theme.Theme.jsonld" + "$ref": "#/components/schemas/Theme.jsonld" } }, "text/html": { "schema": { - "$ref": "#/components/schemas/Theme.Theme" + "$ref": "#/components/schemas/Theme" } }, "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/Theme.Theme" + "$ref": "#/components/schemas/Theme" } } }, @@ -6472,6 +6627,8 @@ "schemas": { "Collection": { "type": "object", + "description": "", + "deprecated": false, "properties": { "empty": { "readOnly": true, @@ -6481,10 +6638,20 @@ "keys": { "readOnly": true, "description": "Gets all keys/indices of the collection.", - "type": "array", - "items": { - "type": "integer" - } + "anyOf": [ + { + "type": "array", + "items": { + "type": "integer" + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] }, "values": { "readOnly": true, @@ -6501,42 +6668,9 @@ }, "Collection.jsonld": { "type": "object", + "description": "", + "deprecated": false, "properties": { - "@context": { - "readOnly": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "@vocab": { - "type": "string" - }, - "hydra": { - "type": "string", - "enum": [ - "http://www.w3.org/ns/hydra/core#" - ] - } - }, - "required": [ - "@vocab", - "hydra" - ], - "additionalProperties": true - } - ] - }, - "@id": { - "readOnly": true, - "type": "string" - }, - "@type": { - "readOnly": true, - "type": "string" - }, "empty": { "readOnly": true, "description": "Checks whether the collection is empty (contains no elements).", @@ -6545,10 +6679,20 @@ "keys": { "readOnly": true, "description": "Gets all keys/indices of the collection.", - "type": "array", - "items": { - "type": "integer" - } + "anyOf": [ + { + "type": "array", + "items": { + "type": "integer" + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] }, "values": { "readOnly": true, @@ -6566,6 +6710,7 @@ "Feed.Feed": { "type": "object", "description": "", + "deprecated": false, "properties": { "created": { "type": "string", @@ -6582,29 +6727,38 @@ "type": "string" }, "configuration": { - "type": "array", + "type": [ + "array", + "null" + ], "items": { "type": "string" - }, - "nullable": true + } }, "slide": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "feedSource": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "feedUrl": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] } } }, "Feed.Feed.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -6656,30 +6810,43 @@ "type": "string" }, "configuration": { - "type": "array", + "type": [ + "array", + "null" + ], "items": { "type": "string" - }, - "nullable": true + } }, "slide": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "feedSource": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "feedUrl": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] } } }, - "FeedSource.FeedSource": { + "FeedSource": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -6729,21 +6896,165 @@ } } }, - "FeedSource.FeedSource.jsonld": { + "FeedSource.FeedSource": { "type": "object", "description": "", + "deprecated": false, "properties": { - "@id": { - "readOnly": true, + "id": { + "type": "string", + "format": "ulid" + }, + "title": { "type": "string" }, - "@type": { - "readOnly": true, + "description": { "type": "string" }, - "@context": { - "readOnly": true, - "oneOf": [ + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "outputType": { + "type": "string" + }, + "feedType": { + "type": "string" + }, + "secrets": { + "type": "array", + "items": { + "type": "string" + } + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + } + }, + "admin": { + "type": "array", + "items": { + "type": "string" + } + }, + "supportedFeedOutputType": { + "type": "string" + } + } + }, + "FeedSource.FeedSource.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "@id": { + "readOnly": true, + "type": "string" + }, + "@type": { + "readOnly": true, + "type": "string" + }, + "@context": { + "readOnly": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "@vocab": { + "type": "string" + }, + "hydra": { + "type": "string", + "enum": [ + "http://www.w3.org/ns/hydra/core#" + ] + } + }, + "required": [ + "@vocab", + "hydra" + ], + "additionalProperties": true + } + ] + }, + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "outputType": { + "type": "string" + }, + "feedType": { + "type": "string" + }, + "secrets": { + "type": "array", + "items": { + "type": "string" + } + }, + "feeds": { + "type": "array", + "items": { + "type": "string" + } + }, + "admin": { + "type": "array", + "items": { + "type": "string" + } + }, + "supportedFeedOutputType": { + "type": "string" + } + } + }, + "FeedSource.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "@context": { + "readOnly": true, + "oneOf": [ { "type": "string" }, @@ -6768,6 +7079,18 @@ } ] }, + "@id": { + "readOnly": true, + "type": "string" + }, + "@type": { + "readOnly": true, + "type": "string" + }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -6819,7 +7142,13 @@ }, "Media": { "type": "object", + "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -6851,13 +7180,24 @@ "items": { "type": "string" } + }, + "thumbnail": { + "type": [ + "string", + "null" + ] } } }, "Media.Media": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -6889,12 +7229,19 @@ "items": { "type": "string" } + }, + "thumbnail": { + "type": [ + "string", + "null" + ] } } }, "Media.Media.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -6931,6 +7278,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -6962,11 +7313,19 @@ "items": { "type": "string" } + }, + "thumbnail": { + "type": [ + "string", + "null" + ] } } }, "Media.jsonld": { "type": "object", + "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -7003,6 +7362,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7034,13 +7397,90 @@ "items": { "type": "string" } + }, + "thumbnail": { + "type": [ + "string", + "null" + ] + } + } + }, + "Playlist": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "schedules": { + "type": "array", + "items": { + "type": "string" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "slides": { + "type": "string" + }, + "campaignScreens": { + "$ref": "#/components/schemas/Collection" + }, + "campaignScreenGroups": { + "$ref": "#/components/schemas/Collection" + }, + "tenants": { + "$ref": "#/components/schemas/Collection" + }, + "isCampaign": { + "type": "boolean" + }, + "published": { + "default": { + "from": "", + "to": "" + }, + "example": { + "from": "", + "to": "" + }, + "type": "array", + "items": { + "type": "string" + } } } }, "Playlist.Playlist": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7101,6 +7541,7 @@ "Playlist.Playlist.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -7137,6 +7578,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7197,6 +7642,7 @@ "Playlist.PlaylistInput": { "type": "object", "description": "", + "deprecated": false, "properties": { "title": { "type": "string" @@ -7238,12 +7684,55 @@ "Playlist.PlaylistInput.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { - "@context": { - "readOnly": true, - "oneOf": [ - { - "type": "string" + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "schedules": { + "type": "array", + "items": { + "type": "string" + } + }, + "tenants": { + "type": "array", + "items": { + "type": "string" + } + }, + "isCampaign": { + "type": "boolean" + }, + "published": { + "default": { + "from": "0", + "to": "0" + }, + "example": { + "from": "0", + "to": "0" + }, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Playlist.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "@context": { + "readOnly": true, + "oneOf": [ + { + "type": "string" }, { "type": "object", @@ -7274,6 +7763,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7286,23 +7779,43 @@ "type": "string" } }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "slides": { + "type": "string" + }, + "campaignScreens": { + "$ref": "#/components/schemas/Collection.jsonld" + }, + "campaignScreenGroups": { + "$ref": "#/components/schemas/Collection.jsonld" + }, "tenants": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/Collection.jsonld" }, "isCampaign": { "type": "boolean" }, "published": { "default": { - "from": "0", - "to": "0" + "from": "", + "to": "" }, "example": { - "from": "0", - "to": "0" + "from": "", + "to": "" }, "type": "array", "items": { @@ -7314,8 +7827,10 @@ "PlaylistScreenRegion.PlaylistScreenRegion": { "type": "object", "description": "", + "deprecated": false, "properties": { "playlist": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -7327,6 +7842,7 @@ "PlaylistScreenRegion.PlaylistScreenRegion.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -7364,6 +7880,7 @@ ] }, "playlist": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -7375,12 +7892,15 @@ "PlaylistSlide.PlaylistSlide": { "type": "object", "description": "", + "deprecated": false, "properties": { "slide": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "playlist": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -7392,6 +7912,7 @@ "PlaylistSlide.PlaylistSlide.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -7429,10 +7950,12 @@ ] }, "slide": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "playlist": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -7441,10 +7964,15 @@ } } }, - "Screen.Screen": { + "Screen": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7474,6 +8002,12 @@ "layout": { "type": "string" }, + "orientation": { + "type": "string" + }, + "resolution": { + "type": "string" + }, "location": { "type": "string" }, @@ -7488,33 +8022,96 @@ "example": "/v1/screens/{id}/groups", "type": "string" }, - "dimensions": { - "default": { - "width": 0, - "height": 0 - }, - "example": { - "width": 0, - "height": 0 - }, + "screenUser": { + "type": [ + "string", + "null" + ] + }, + "enableColorSchemeChange": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "Screen.Screen": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "size": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "campaigns": { + "type": "string" + }, + "layout": { + "type": "string" + }, + "orientation": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "location": { + "type": "string" + }, + "regions": { "type": "array", "items": { "type": "string" } }, + "inScreenGroups": { + "default": "/v1/screens/{id}/groups", + "example": "/v1/screens/{id}/groups", + "type": "string" + }, "screenUser": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "enableColorSchemeChange": { - "type": "boolean", - "nullable": true + "type": [ + "boolean", + "null" + ] } } }, "Screen.Screen.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -7551,6 +8148,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7580,6 +8181,12 @@ "layout": { "type": "string" }, + "orientation": { + "type": "string" + }, + "resolution": { + "type": "string" + }, "location": { "type": "string" }, @@ -7594,33 +8201,24 @@ "example": "/v1/screens/{id}/groups", "type": "string" }, - "dimensions": { - "default": { - "width": 0, - "height": 0 - }, - "example": { - "width": 0, - "height": 0 - }, - "type": "array", - "items": { - "type": "string" - } - }, "screenUser": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "enableColorSchemeChange": { - "type": "boolean", - "nullable": true + "type": [ + "boolean", + "null" + ] } } }, "Screen.ScreenInput": { "type": "object", "description": "", + "deprecated": false, "properties": { "title": { "type": "string" @@ -7637,29 +8235,58 @@ "location": { "type": "string" }, - "dimensions": { - "default": { - "width": 0, - "height": 0 - }, - "example": { - "width": 0, - "height": 0 - }, - "type": "array", - "items": { - "type": "string" - } + "resolution": { + "type": "string" + }, + "orientation": { + "type": "string" }, "enableColorSchemeChange": { - "type": "boolean", - "nullable": true + "type": [ + "boolean", + "null" + ] } } }, "Screen.ScreenInput.jsonld": { "type": "object", "description": "", + "deprecated": false, + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "size": { + "type": "string" + }, + "layout": { + "type": "string" + }, + "location": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "orientation": { + "type": "string" + }, + "enableColorSchemeChange": { + "type": [ + "boolean", + "null" + ] + } + } + }, + "Screen.jsonld": { + "type": "object", + "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -7696,6 +8323,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7705,41 +8336,89 @@ "size": { "type": "string" }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "campaigns": { + "type": "string" + }, "layout": { "type": "string" }, + "orientation": { + "type": "string" + }, + "resolution": { + "type": "string" + }, "location": { "type": "string" }, - "dimensions": { - "default": { - "width": 0, - "height": 0 - }, - "example": { - "width": 0, - "height": 0 - }, + "regions": { "type": "array", "items": { "type": "string" } }, + "inScreenGroups": { + "default": "/v1/screens/{id}/groups", + "example": "/v1/screens/{id}/groups", + "type": "string" + }, + "screenUser": { + "type": [ + "string", + "null" + ] + }, "enableColorSchemeChange": { - "type": "boolean", - "nullable": true + "type": [ + "boolean", + "null" + ] + } + } + }, + "ScreenCampaign": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "campaign": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + }, + "screen": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" } } }, "ScreenCampaign.ScreenCampaign": { "type": "object", "description": "", + "deprecated": false, "properties": { "campaign": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "screen": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" } @@ -7748,6 +8427,7 @@ "ScreenCampaign.ScreenCampaign.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -7785,19 +8465,115 @@ ] }, "campaign": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "screen": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" } } }, + "ScreenCampaign.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "@context": { + "readOnly": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "@vocab": { + "type": "string" + }, + "hydra": { + "type": "string", + "enum": [ + "http://www.w3.org/ns/hydra/core#" + ] + } + }, + "required": [ + "@vocab", + "hydra" + ], + "additionalProperties": true + } + ] + }, + "@id": { + "readOnly": true, + "type": "string" + }, + "@type": { + "readOnly": true, + "type": "string" + }, + "campaign": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + }, + "screen": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + } + } + }, + "ScreenGroup": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "campaigns": { + "type": "string" + }, + "screens": { + "type": "string" + } + } + }, "ScreenGroup.ScreenGroup": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7829,6 +8605,7 @@ "ScreenGroup.ScreenGroup.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -7865,6 +8642,10 @@ } ] }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -7896,6 +8677,7 @@ "ScreenGroup.ScreenGroupInput": { "type": "object", "description": "", + "deprecated": false, "properties": { "title": { "type": "string" @@ -7908,6 +8690,20 @@ "ScreenGroup.ScreenGroupInput.jsonld": { "type": "object", "description": "", + "deprecated": false, + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "ScreenGroup.jsonld": { + "type": "object", + "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -7944,23 +8740,50 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, "description": { "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "campaigns": { + "type": "string" + }, + "screens": { + "type": "string" } } }, "ScreenGroupCampaign.ScreenGroupCampaign": { "type": "object", "description": "", + "deprecated": false, "properties": { "campaign": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "screenGroup": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" } @@ -7969,6 +8792,7 @@ "ScreenGroupCampaign.ScreenGroupCampaign.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -8006,19 +8830,57 @@ ] }, "campaign": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, "screenGroup": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" } } }, + "ScreenLayout": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "grid": { + "default": { + "rows": 1, + "columns": 1 + }, + "example": { + "rows": 1, + "columns": 1 + }, + "type": "array", + "items": { + "type": "string" + } + }, + "regions": { + "$ref": "#/components/schemas/Collection" + } + } + }, "ScreenLayout.ScreenLayout": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8044,6 +8906,7 @@ "ScreenLayout.ScreenLayout.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -8080,6 +8943,10 @@ } ] }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8102,13 +8969,95 @@ } } }, - "ScreenLayoutRegions.ScreenLayoutRegions-read": { + "ScreenLayout.jsonld": { "type": "object", - "description": "" + "description": "", + "deprecated": false, + "properties": { + "@context": { + "readOnly": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "@vocab": { + "type": "string" + }, + "hydra": { + "type": "string", + "enum": [ + "http://www.w3.org/ns/hydra/core#" + ] + } + }, + "required": [ + "@vocab", + "hydra" + ], + "additionalProperties": true + } + ] + }, + "@id": { + "readOnly": true, + "type": "string" + }, + "@type": { + "readOnly": true, + "type": "string" + }, + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "grid": { + "default": { + "rows": 1, + "columns": 1 + }, + "example": { + "rows": 1, + "columns": 1 + }, + "type": "array", + "items": { + "type": "string" + } + }, + "regions": { + "$ref": "#/components/schemas/Collection.jsonld" + } + } }, - "ScreenLayoutRegions.ScreenLayoutRegions.jsonld-read": { + "ScreenLayoutRegions.ScreenLayoutRegions": { "type": "object", "description": "", + "deprecated": false, + "properties": { + "title": { + "type": "string" + }, + "gridArea": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + } + } + }, + "ScreenLayoutRegions.ScreenLayoutRegions.jsonld": { + "type": "object", + "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -8144,13 +9093,119 @@ "additionalProperties": true } ] + }, + "title": { + "type": "string" + }, + "gridArea": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + } + } + }, + "Slide": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "templateInfo": { + "default": { + "@id": "", + "options": [] + }, + "example": { + "@id": "", + "options": [] + }, + "type": "array", + "items": { + "type": "string" + } + }, + "theme": { + "type": "string" + }, + "onPlaylists": { + "$ref": "#/components/schemas/Collection" + }, + "duration": { + "type": [ + "integer", + "null" + ] + }, + "published": { + "default": { + "from": 0, + "to": 0 + }, + "example": { + "from": 0, + "to": 0 + }, + "type": "array", + "items": { + "type": "string" + } + }, + "media": { + "$ref": "#/components/schemas/Collection" + }, + "content": { + "type": "array", + "items": { + "type": "string" + } + }, + "feed": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } } } }, "Slide.Slide": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8192,8 +9247,10 @@ "$ref": "#/components/schemas/Collection" }, "duration": { - "type": "integer", - "nullable": true + "type": [ + "integer", + "null" + ] }, "published": { "default": { @@ -8219,17 +9276,20 @@ } }, "feed": { - "type": "array", + "type": [ + "array", + "null" + ], "items": { "type": "string" - }, - "nullable": true + } } } }, "Slide.Slide.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -8266,6 +9326,10 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8307,8 +9371,10 @@ "$ref": "#/components/schemas/Collection.jsonld" }, "duration": { - "type": "integer", - "nullable": true + "type": [ + "integer", + "null" + ] }, "published": { "default": { @@ -8334,17 +9400,20 @@ } }, "feed": { - "type": "array", + "type": [ + "array", + "null" + ], "items": { "type": "string" - }, - "nullable": true + } } } }, "Slide.SlideInput": { "type": "object", "description": "", + "deprecated": false, "properties": { "title": { "type": "string" @@ -8374,8 +9443,10 @@ "type": "string" }, "duration": { - "type": "integer", - "nullable": true + "type": [ + "integer", + "null" + ] }, "published": { "default": { @@ -8392,11 +9463,94 @@ } }, "feed": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "media": { + "type": "array", + "items": { + "type": "string" + } + }, + "content": { + "default": { + "text": "Test text" + }, + "example": { + "text": "Test text" + }, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Slide.SlideInput.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "templateInfo": { + "default": { + "@id": "", + "options": { + "fade": false + } + }, + "example": { + "@id": "", + "options": { + "fade": false + } + }, "type": "array", "items": { "type": "string" + } + }, + "theme": { + "type": "string" + }, + "duration": { + "type": [ + "integer", + "null" + ] + }, + "published": { + "default": { + "from": 0, + "to": 0 + }, + "example": { + "from": 0, + "to": 0 }, - "nullable": true + "type": "array", + "items": { + "type": "string" + } + }, + "feed": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } }, "media": { "type": "array", @@ -8418,9 +9572,10 @@ } } }, - "Slide.SlideInput.jsonld": { + "Slide.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -8457,24 +9612,38 @@ "readOnly": true, "type": "string" }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, "description": { "type": "string" }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, "templateInfo": { "default": { "@id": "", - "options": { - "fade": false - } + "options": [] }, "example": { "@id": "", - "options": { - "fade": false - } + "options": [] }, "type": "array", "items": { @@ -8484,9 +9653,14 @@ "theme": { "type": "string" }, + "onPlaylists": { + "$ref": "#/components/schemas/Collection.jsonld" + }, "duration": { - "type": "integer", - "nullable": true + "type": [ + "integer", + "null" + ] }, "published": { "default": { @@ -8502,26 +9676,56 @@ "type": "string" } }, - "feed": { + "media": { + "$ref": "#/components/schemas/Collection.jsonld" + }, + "content": { "type": "array", "items": { "type": "string" - }, - "nullable": true + } }, - "media": { - "type": "array", + "feed": { + "type": [ + "array", + "null" + ], "items": { "type": "string" } + } + } + }, + "Template": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "id": { + "type": "string", + "format": "ulid" }, - "content": { - "default": { - "text": "Test text" - }, - "example": { - "text": "Test text" - }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "resources": { "type": "array", "items": { "type": "string" @@ -8532,7 +9736,12 @@ "Template.Template": { "type": "object", "description": "", + "deprecated": false, "properties": { + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8564,6 +9773,7 @@ "Template.Template.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -8600,6 +9810,82 @@ } ] }, + "id": { + "type": "string", + "format": "ulid" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "modifiedBy": { + "type": "string" + }, + "createdBy": { + "type": "string" + }, + "resources": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Template.jsonld": { + "type": "object", + "description": "", + "deprecated": false, + "properties": { + "@context": { + "readOnly": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "@vocab": { + "type": "string" + }, + "hydra": { + "type": "string", + "enum": [ + "http://www.w3.org/ns/hydra/core#" + ] + } + }, + "required": [ + "@vocab", + "hydra" + ], + "additionalProperties": true + } + ] + }, + "@id": { + "readOnly": true, + "type": "string" + }, + "@type": { + "readOnly": true, + "type": "string" + }, + "id": { + "type": "string", + "format": "ulid" + }, "title": { "type": "string" }, @@ -8631,6 +9917,7 @@ "Tenant": { "type": "object", "description": "", + "deprecated": false, "properties": { "tenantKey": { "type": "string" @@ -8642,8 +9929,10 @@ } }, "fallbackImageUrl": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "title": { "type": "string" @@ -8678,6 +9967,7 @@ "Tenant.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@id": { "readOnly": true, @@ -8724,8 +10014,10 @@ } }, "fallbackImageUrl": { - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "title": { "type": "string" @@ -8757,124 +10049,87 @@ } } }, - "Theme.Theme": { + "Theme": { "type": "object", "description": "", + "deprecated": false, "properties": { + "cssStyles": { + "type": "string" + }, + "logo": { + "owl:maxCardinality": 1, + "type": [ + "string", + "null" + ], + "format": "iri-reference" + }, + "slides": { + "type": "array", + "items": { + "type": "string", + "format": "iri-reference" + } + }, "title": { "type": "string" }, "description": { "type": "string" }, - "onNumberOfSlides": { - "type": "integer" + "tenant": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" }, - "created": { + "id": { + "readOnly": true, + "description": "Get the Ulid.", "type": "string", - "format": "date-time" + "format": "ulid" }, - "modified": { + "createdAt": { + "readOnly": true, "type": "string", "format": "date-time" }, - "modifiedBy": { - "type": "string" + "modifiedAt": { + "readOnly": true, + "type": "string", + "format": "date-time" }, "createdBy": { "type": "string" }, - "logo": { - "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/Media" - } - ] - }, - "css": { + "modifiedBy": { "type": "string" } } }, - "Theme.Theme.jsonld": { + "Theme.ThemeInput": { "type": "object", "description": "", + "deprecated": false, "properties": { - "@context": { - "readOnly": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "@vocab": { - "type": "string" - }, - "hydra": { - "type": "string", - "enum": [ - "http://www.w3.org/ns/hydra/core#" - ] - } - }, - "required": [ - "@vocab", - "hydra" - ], - "additionalProperties": true - } - ] - }, - "@id": { - "readOnly": true, - "type": "string" - }, - "@type": { - "readOnly": true, - "type": "string" - }, "title": { "type": "string" }, "description": { "type": "string" }, - "onNumberOfSlides": { - "type": "integer" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "modified": { - "type": "string", - "format": "date-time" - }, - "modifiedBy": { - "type": "string" - }, - "createdBy": { - "type": "string" - }, "logo": { - "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/Media.jsonld" - } - ] + "type": "string" }, "css": { "type": "string" } } }, - "Theme.ThemeInput": { + "Theme.ThemeInput.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "title": { "type": "string" @@ -8890,9 +10145,10 @@ } } }, - "Theme.ThemeInput.jsonld": { + "Theme.jsonld": { "type": "object", "description": "", + "deprecated": false, "properties": { "@context": { "readOnly": true, @@ -8929,27 +10185,68 @@ "readOnly": true, "type": "string" }, + "cssStyles": { + "type": "string" + }, + "logo": { + "owl:maxCardinality": 1, + "type": [ + "string", + "null" + ], + "format": "iri-reference" + }, + "slides": { + "type": "array", + "items": { + "type": "string", + "format": "iri-reference" + } + }, "title": { "type": "string" }, "description": { "type": "string" }, - "logo": { + "tenant": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + }, + "id": { + "readOnly": true, + "description": "Get the Ulid.", + "type": "string", + "format": "ulid" + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "modifiedAt": { + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "createdBy": { "type": "string" }, - "css": { + "modifiedBy": { "type": "string" } } }, "User": { "type": "object", + "description": "", + "deprecated": false, "properties": { "email": { "format": "email", "externalDocs": { - "url": "http://schema.org/email" + "url": "https://schema.org/email" }, "type": "string" }, @@ -8960,10 +10257,6 @@ "description": "The hashed password", "type": "string" }, - "activeTenant": { - "type": "string", - "format": "iri-reference" - }, "userRoleTenants": { "type": "array", "items": { @@ -8973,6 +10266,11 @@ "provider": { "type": "string" }, + "activeTenant": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + }, "userIdentifier": { "readOnly": true, "description": "A visual identifier that represents this user.", @@ -8996,8 +10294,10 @@ "salt": { "readOnly": true, "description": "Returning a salt is only needed, if you are not using a modern\nhashing algorithm (e.g. bcrypt or sodium) in your security.yaml.", - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "roleTenant": { "writeOnly": true, @@ -9006,13 +10306,6 @@ "type": "string" } }, - "userRoleTenant": { - "writeOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRoleTenant" - } - }, "id": { "readOnly": true, "description": "Get the Ulid.", @@ -9042,46 +10335,13 @@ }, "User.jsonld": { "type": "object", + "description": "", + "deprecated": false, "properties": { - "@context": { - "readOnly": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "@vocab": { - "type": "string" - }, - "hydra": { - "type": "string", - "enum": [ - "http://www.w3.org/ns/hydra/core#" - ] - } - }, - "required": [ - "@vocab", - "hydra" - ], - "additionalProperties": true - } - ] - }, - "@id": { - "readOnly": true, - "type": "string" - }, - "@type": { - "readOnly": true, - "type": "string" - }, "email": { "format": "email", "externalDocs": { - "url": "http://schema.org/email" + "url": "https://schema.org/email" }, "type": "string" }, @@ -9092,10 +10352,6 @@ "description": "The hashed password", "type": "string" }, - "activeTenant": { - "type": "string", - "format": "iri-reference" - }, "userRoleTenants": { "type": "array", "items": { @@ -9105,6 +10361,11 @@ "provider": { "type": "string" }, + "activeTenant": { + "owl:maxCardinality": 1, + "type": "string", + "format": "iri-reference" + }, "userIdentifier": { "readOnly": true, "description": "A visual identifier that represents this user.", @@ -9128,8 +10389,10 @@ "salt": { "readOnly": true, "description": "Returning a salt is only needed, if you are not using a modern\nhashing algorithm (e.g. bcrypt or sodium) in your security.yaml.", - "type": "string", - "nullable": true + "type": [ + "string", + "null" + ] }, "roleTenant": { "writeOnly": true, @@ -9138,13 +10401,6 @@ "type": "string" } }, - "userRoleTenant": { - "writeOnly": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRoleTenant.jsonld" - } - }, "id": { "readOnly": true, "description": "Get the Ulid.", @@ -9174,11 +10430,14 @@ }, "UserRoleTenant": { "type": "object", + "description": "", + "deprecated": false, "properties": { "user": { "$ref": "#/components/schemas/User" }, "tenant": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -9214,46 +10473,14 @@ }, "UserRoleTenant.jsonld": { "type": "object", + "description": "", + "deprecated": false, "properties": { - "@context": { - "readOnly": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "@vocab": { - "type": "string" - }, - "hydra": { - "type": "string", - "enum": [ - "http://www.w3.org/ns/hydra/core#" - ] - } - }, - "required": [ - "@vocab", - "hydra" - ], - "additionalProperties": true - } - ] - }, - "@id": { - "readOnly": true, - "type": "string" - }, - "@type": { - "readOnly": true, - "type": "string" - }, "user": { "$ref": "#/components/schemas/User.jsonld" }, "tenant": { + "owl:maxCardinality": 1, "type": "string", "format": "iri-reference" }, @@ -9300,6 +10527,11 @@ "readOnly": true, "example": "ABCDEFGHIJKLMNOPQRSTUVWXYZ" }, + "refresh_token_expiration": { + "type": "int", + "readOnly": true, + "example": "1678802283" + }, "tenants": { "type": "array", "items": { @@ -9342,7 +10574,7 @@ "email": { "type": "string", "readOnly": true, - "example": "johndoe@example.com" + "example": "john@example.com" } } } @@ -9377,7 +10609,7 @@ "properties": { "email": { "type": "string", - "example": "johndoe@example.com" + "example": "john@example.com" }, "password": { "type": "string",