This issue tracks the work on an initial implementation of comId. comId is a set of features which enable a studio to have its own branding and configuration. For now, the goal is to support more custom branding features and focus on providing organizations more options for managing teams and projects.
Backend Implementation Details
[x] A studio can have a comId
[x] A studio can have a parent studio (referenced by comId)
[x] A studio can have a player config
[x] A studio can have a logo URL
[x] Endpoints
[x] POST /api/v2/studios - create in comId
[x] GET /api/v2/studios/list?comId - list by comId
[x] GET /api/v2/studios - Get studio
[x] GET /api/v2/player/config?comId - get config for comId
[x] PUT /api/v2/studios - update a studio
[x] POST /api/v2/studios/requestComId - request a comId change
[x] Configuration
[x] Allow comId for a subscription
[x] Max studios for a comId
[x] Who is allowed to create a studio in a comId
Player Implementation Details
[x] The player should be able to request /api/v2/player/config with a comId to get a comId player config
[x] It should merge the returned config with the regular player config.
[x] os.listUserStudios() should automatically include the current comId so that only studios within that comId are returned
[x] The loading popup should display the logo URL that was configured for the comId
Auth Implementation Details
[x] If a comId is specified:
[x] The comId logo should be displayed in the top app bar instead of the site title
[x] Only studios that belong to the comId should be listed
[x] There should be a link in the footer to take the user to the main website
[x] Studios that have the comId features enabled should be able to:
[x] request a comId for studio (sends a notification like report inst)
[x] set a custom URL as the place for the comId logo
This issue tracks the work on an initial implementation of comId. comId is a set of features which enable a studio to have its own branding and configuration. For now, the goal is to support more custom branding features and focus on providing organizations more options for managing teams and projects.
Backend Implementation Details
POST /api/v2/studios
- create in comIdGET /api/v2/studios/list?comId
- list by comIdGET /api/v2/studios
- Get studioGET /api/v2/player/config?comId
- get config for comIdPUT /api/v2/studios
- update a studioPOST /api/v2/studios/requestComId
- request a comId changePlayer Implementation Details
/api/v2/player/config
with a comId to get a comId player configos.listUserStudios()
should automatically include the current comId so that only studios within that comId are returnedAuth Implementation Details
ab1BootstrapUrl
jitsiAppName
what3WordsApiKey
allowedBiosOptions
defaultBiosOption
automaticBiosOption
arcGisApiKey