Planned Deprecations

Table of Contents

Current deprecations
- All Services
- Identity Service
Past deprecations

If you are a developer who integrates with Mosaic Services please review the below changes to keep your integrations up and running.

We implement changes in the APIs and for messaging always in a backward-compatible way. To ensure a clean API we need to remove deprecated fields and functionality after a few months though.

Changelog

Date Affected Service Changes

Date	Affected Service	Changes
2024-02-12	All	added planned deprecation for old GraphQL error formats.
2024-02-12	All	moved deprecations that are finished to the `Past Deprecations` section.
2024-01-16	All	Update planned deprecation dates for all deprecations.
2023-12-12	All	Messages require (and contain) an `aggregate_id` (e.g. the database ID) and the `aggregate_type` (e.g. `movie` or `user`)
2023-12-12	Identity	The event `UserDeleted` was renamed to `UserDeleteFinished`, `UserRoleDeleted` was renamed to `UserRoleDeleteFinished`, and the `ServiceAccountDeleted` was renamed to `ServiceAccountDeleteFinished`.
2023-10-09	Video	Added deprecations for `drmKeyIds`, `qualityLevels` and `durationInSeconds` on `Videos` as well as `bandwidthInBps` and `initialFile` parameters on `VideoStreams` for Video Service.
2023-10-09	Identity, Video	Added deprecation caused by renaming of `Mosaic Encoding Service` to `Mosaic Video Service` for Identity and Video Service.
2023-10-09	Admin, AxAuth, Billing, Channel, Hosting, Identity, Image, Management System, Monetization, Monetization-Grants, User, Video	Added deprecation of `*NodeId` endpoints to all affected services.

2024-02-12

All

added planned deprecation for old GraphQL error formats.

2024-02-12

All

moved deprecations that are finished to the Past Deprecations section.

2024-01-16

All

Update planned deprecation dates for all deprecations.

2023-12-12

All

Messages require (and contain) an aggregate_id (e.g. the database ID) and the aggregate_type (e.g. movie or user)

2023-12-12

Identity

The event UserDeleted was renamed to UserDeleteFinished, UserRoleDeleted was renamed to UserRoleDeleteFinished, and the ServiceAccountDeleted was renamed to ServiceAccountDeleteFinished.

2023-10-09

Video

Added deprecations for drmKeyIds, qualityLevels and durationInSeconds on Videos as well as bandwidthInBps and initialFile parameters on VideoStreams for Video Service.

2023-10-09

Identity, Video

Added deprecation caused by renaming of Mosaic Encoding Service to Mosaic Video Service for Identity and Video Service.

2023-10-09

Admin, AxAuth, Billing, Channel, Hosting, Identity, Image, Management System, Monetization, Monetization-Grants, User, Video

Added deprecation of *NodeId endpoints to all affected services.

Current deprecations

Here are the planned deprecations for each service:

All Services

API/Message Details Planned removal

API/Message	Details	Planned removal
All RabbitMQ Messages	Messages require an `aggregate_id` (e.g. the database ID) and the `aggregate_type` (e.g. `movie` or `user`). Backward compatibility for old messages will be removed. See release notes R85 for more details.	2024-04
GraphQL Error format	see release notes R90	2024-05

All RabbitMQ Messages

Messages require an aggregate_id (e.g. the database ID) and the aggregate_type (e.g. movie or user). Backward compatibility for old messages will be removed. See release notes R85 for more details.

2024-04

GraphQL Error format

see release notes R90

2024-05

Identity Service

API/Message Details Planned removal

API/Message	Details	Planned removal
These three id-service events will be removed from messages lib. `UserDeleted`, `UserRoleDeleted`, `ServiceAccountDeleted`	Introduced six new events instead of those three events, and consumers shall start using these new events. `UserDeleteFinished`, `UserDeleteFailed`, `UserRoleDeleteFinished`, `UserRoleDeleteFailed`, `ServiceAccountDeleteFinished`, `ServiceAccountDeleteFailed`	2024-03

These three id-service events will be removed from messages lib. UserDeleted, UserRoleDeleted, ServiceAccountDeleted

Introduced six new events instead of those three events, and consumers shall start using these new events.

UserDeleteFinished, UserDeleteFailed, UserRoleDeleteFinished, UserRoleDeleteFailed, ServiceAccountDeleteFinished, ServiceAccountDeleteFailed

2024-03

Past deprecations

Service API/Message Details Removal

Service	API/Message	Details	Removal
Admin Service	GraphQL `NodeId` based fields `deletedApplicationNodeId`, `deletedEmailWhitelistPatternNodeId`, `deletedEmailWhitelistPatternRoleNodeId`, `deletedIdpConfigurationNodeId`, `deletedServiceAccountNodeId`, `deletedServiceAccountPermissionNodeId`, and `deletedTenantAdministratorNodeId`	Will be removed as the API is not using NodeIds	2024-02
AxAuth Service	GraphQL `NodeId` based fields `deletedIdpUserNodeId` and `deletedIdpUserStoreNodeId`	Will be removed as the API is not using NodeIds	2024-02
Billing Service	GraphQL `NodeId` based fields `deletedPaymentProviderNodeId` and `deletedPaypalSettingNodeId`	Will be removed as the API is not using NodeIds	2024-02
Channel Service	GraphQL `NodeId` based fields `deletedChannelImageNodeId`, `deletedChannelNodeId`, `deletedCuePointScheduleNodeId`, `deletedPlaylistNodeId`, `deletedProgramCuePointNodeId`, and `deletedProgramNodeId`	Will be removed as the API is not using NodeIds	2024-02
Hosting Service	GraphQL `NodeId` based field `deletedContainerRegistryConnectionNodeId`, `deletedServiceDefinitionNodeId`, `deletedServiceDeploymentConfigurationNodeId`, and `deletedServicePiletArtifactNodeId`	Will be removed as the API is not using NodeIds	2024-02
Identity Service	Permissions: the Mosaic Encoding Service was renamed to Mosaic Video Service. The service ID changed therefore from `ax-encoding-service` to `ax-video-service`	If you manually check the JWT permissions in your code, change the service ID from `ax-encoding-service` to `ax-video-service`.	2024-01
Identity Service	GraphQL `NodeId` based fields `deletedUserNodeId`, `deletedUserRoleNodeId`, `deletedUserRoleAssignmentNodeId`, `deletedUserRoleParentNodeId`, `deletedUserRolePermissionNodeId`, and `deletedUserRoleTagNodeId`	Will be removed as the API is not using NodeIds	2024-02
Image Service	GraphQL `NodeId` based field `deletedImagesTagNodeId`	Will be removed as the API is not using NodeIds	2024-02
Management System Service	GraphQL `NodeId` based field `deletedSubdomainBlacklistPatternNodeId`	Will be removed as the API is not using NodeIds	2024-02
Monetization Service	GraphQL `NodeId` based fields `deletedPaymentPlanPriceNodeId`, `deletedPaymentPlanProviderConfigNodeId`, `deletedPaymentPlanNodeId`, `deletedSubscriptionPlanClaimSetNodeId`, `deletedSubscriptionPlanImageNodeId`, `deletedSubscriptionPlanProviderConfigNodeId`, and `deletedSubscriptionPlanNodeId`	Will be removed as the API is not using NodeIds	2024-02
Monetization-Grants Service	GraphQL `NodeId` based fields `deletedClaimSetClaimNodeId`, and `deletedClaimSetNodeId`	Will be removed as the API is not using NodeIds	2024-02
User Service	GraphQL `NodeId` based fields `deletedApplicationNodeId` `deletedApplicationIdpConnectionNodeId`, `deletedIdpConnectionNodeId`, `deletedUserNodeId` `deletedUserIdpDatumNodeId`, and `deletedUserProfileNodeId`	Will be removed as the API is not using NodeIds	2024-02
Video Service	URL https://encoding.service.eu.axinom.net/	Replaced with https://video.service.eu.axinom.net/ as the Mosaic Encoding Service got renamed to Mosaic Video Service	2024-01
Video Service	Messaging: the Mosaic Encoding Service was renamed to Mosaic Video Service.	Make sure to upgrade to the latest `@axinom/mosaic-messages` library to be subscribed to the new routing keys.	2024-01
Video Service	Permissions: the Mosaic Encoding Service was renamed to Mosaic Video Service. The service ID changed therefore from `ax-encoding-service` to `ax-video-service`	If you manually check the JWT permissions in your code, change the service ID from `ax-encoding-service` to `ax-video-service`.	2024-01
Video Service	GraphQL `NodeId` based fields `deletedCuePointNodeId` `deletedEncodingProcessingProfileNodeId`, `deletedEncodingVideoRepresentationNodeId`, `deletedVideoStreamNodeId`, and `deletedVideosTagNodeId`	Will be removed as the API is not using NodeIds	2024-02
Video Service	GraphQL type `Video` array `drmKeyIds`	Replaced with the `keyId` field in the `videoStreams` type	2024-02
Video Service	GraphQL type `Video` array `qualityLevels`	Replaced with corresponding field in the `videoStreams` type	2024-02
Video Service	GraphQL type `Video` field `durationInSeconds`	Replaced with the `lengthInSeconds` field	2024-02
Video Service	GraphQL type `VideoStream` field `bandwidthInBps`	Replaced with the `bitrateInKbps` field	2024-02
Video Service	GraphQL type `VideoStream` field `initialFile`	Replaced with the `file` field	2024-02

Admin Service

GraphQL NodeId based fields deletedApplicationNodeId, deletedEmailWhitelistPatternNodeId, deletedEmailWhitelistPatternRoleNodeId, deletedIdpConfigurationNodeId, deletedServiceAccountNodeId, deletedServiceAccountPermissionNodeId, and deletedTenantAdministratorNodeId

Will be removed as the API is not using NodeIds

2024-02

AxAuth Service

GraphQL NodeId based fields deletedIdpUserNodeId and deletedIdpUserStoreNodeId

Will be removed as the API is not using NodeIds

2024-02

Billing Service

GraphQL NodeId based fields deletedPaymentProviderNodeId and deletedPaypalSettingNodeId

Will be removed as the API is not using NodeIds

2024-02

Channel Service

GraphQL NodeId based fields deletedChannelImageNodeId, deletedChannelNodeId, deletedCuePointScheduleNodeId, deletedPlaylistNodeId, deletedProgramCuePointNodeId, and deletedProgramNodeId

Will be removed as the API is not using NodeIds

2024-02

Hosting Service

GraphQL NodeId based field deletedContainerRegistryConnectionNodeId, deletedServiceDefinitionNodeId, deletedServiceDeploymentConfigurationNodeId, and deletedServicePiletArtifactNodeId

Will be removed as the API is not using NodeIds

2024-02

Identity Service

Permissions: the Mosaic Encoding Service was renamed to Mosaic Video Service. The service ID changed therefore from ax-encoding-service to ax-video-service

If you manually check the JWT permissions in your code, change the service ID from ax-encoding-service to ax-video-service.

2024-01

Identity Service

GraphQL NodeId based fields deletedUserNodeId, deletedUserRoleNodeId, deletedUserRoleAssignmentNodeId, deletedUserRoleParentNodeId, deletedUserRolePermissionNodeId, and deletedUserRoleTagNodeId

Will be removed as the API is not using NodeIds

2024-02

Image Service

GraphQL NodeId based field deletedImagesTagNodeId

Will be removed as the API is not using NodeIds

2024-02

Management System Service

GraphQL NodeId based field deletedSubdomainBlacklistPatternNodeId

Will be removed as the API is not using NodeIds

2024-02

Monetization Service

GraphQL NodeId based fields deletedPaymentPlanPriceNodeId, deletedPaymentPlanProviderConfigNodeId, deletedPaymentPlanNodeId, deletedSubscriptionPlanClaimSetNodeId, deletedSubscriptionPlanImageNodeId, deletedSubscriptionPlanProviderConfigNodeId, and deletedSubscriptionPlanNodeId

Will be removed as the API is not using NodeIds

2024-02

Monetization-Grants Service

GraphQL NodeId based fields deletedClaimSetClaimNodeId, and deletedClaimSetNodeId

Will be removed as the API is not using NodeIds

2024-02

User Service

GraphQL NodeId based fields deletedApplicationNodeId deletedApplicationIdpConnectionNodeId, deletedIdpConnectionNodeId, deletedUserNodeId deletedUserIdpDatumNodeId, and deletedUserProfileNodeId

Will be removed as the API is not using NodeIds

2024-02

Video Service

URL https://encoding.service.eu.axinom.net/

Replaced with https://video.service.eu.axinom.net/ as the Mosaic Encoding Service got renamed to Mosaic Video Service

2024-01

Video Service

Messaging: the Mosaic Encoding Service was renamed to Mosaic Video Service.

Make sure to upgrade to the latest @axinom/mosaic-messages library to be subscribed to the new routing keys.

2024-01

Video Service

Permissions: the Mosaic Encoding Service was renamed to Mosaic Video Service. The service ID changed therefore from ax-encoding-service to ax-video-service

If you manually check the JWT permissions in your code, change the service ID from ax-encoding-service to ax-video-service.

2024-01

Video Service

GraphQL NodeId based fields deletedCuePointNodeId deletedEncodingProcessingProfileNodeId, deletedEncodingVideoRepresentationNodeId, deletedVideoStreamNodeId, and deletedVideosTagNodeId

Will be removed as the API is not using NodeIds

2024-02

Video Service

GraphQL type Video array drmKeyIds

Replaced with the keyId field in the videoStreams type

2024-02

Video Service

GraphQL type Video array qualityLevels

Replaced with corresponding field in the videoStreams type

2024-02

Video Service

GraphQL type Video field durationInSeconds

Replaced with the lengthInSeconds field

2024-02

Video Service

GraphQL type VideoStream field bandwidthInBps

Replaced with the bitrateInKbps field

2024-02

Video Service

GraphQL type VideoStream field initialFile

Replaced with the file field

2024-02