3.12.0 Migration Guide¶
This release includes several API cleanups, refactorings and changes which will be addressed in the following. This document includes general information about the changes necessary for the migration and a detailed list of API changes.
Changed Security Defaults¶
This release enables stricter permission settings for running containers by
default. You will have issues upgrading to this release if your environment
previously ran containers without a set security context. To resolve this, you
may restore the more lax behavior by explicitly disabling the security context
in your values.yaml as shown below.
securityContext:
enabled: false
We recommend enabling the security context and adjusting your environment to adhere to the stricter security settings. You may need to clear previously used persistent volumes to resolve permission issues if the previous installation did not use a security context.
3D Space API (Experimental)¶
This release changes the experimental 3D Space API based on further development
on the product story behind collaborative 3D spaces. The deprecated base path
/space has been removed. The API no longer provides the capability to freely
choose the space ID or namespace. Previously, it was possible to call add or
setProperty on a chosen space and the space would be created implicitly. It
is now required to create a space before add and setProperty calls are
made, otherwise the operation will be rejected.
-
POST /space
-
POST /space/{namespace}
-
POST /space/{namespace}/{id}
-
GET /space/{namespace}/{id}
-
POST /space/{namespace}/{id}/add
-
POST /space/{namespace}/{id}/setProperty
-
POST /api/space/v1/{namespace}
-
POST /api/space/v1/{namespace}/{id}
-
POST /api/space/v1/{namespace}/{id}/add
-
POST /api/space/v1/{namespace}/{id}/setProperty
API Changes
The following list contain API additions, changes and removals which might be subject for migration efforts. Most alterations were performed to provide a more streamlined experience when working with the API and come only with minimal need for manual intervention from application developers.
ContextAPI
- cloneIntoNewSpace
- deleteMemberProfileEntry
- getMemberName
- getMembers
- measureNormal
- openSpace
- requestMemberActions
- requestMemberProperties
- requestNeighboringEdges
- requestNeighboringFaces
- requestSpaceHandle
- setMemberName
- setMemberProfileEntry
- useMemberAction
-
addToCollection
-
createCollection
-
getCollection
-
getCollectionElements
-
getCollectionNodeCount
-
removeCollection
-
removeFromCollection
-
searchByVolumereplaced by requestNodeIdsByBoxVolume
-
selectCollectionreplaced by setSelection
ViewerAPI
- addPointsToSet
- changePointsInSet
- changePOISet
- changePOIStyle
- clearBackground
- createPOISet
- createPOIStyle
- followMember
- getPOISetData
- getPOISets
- getPOIStyleData
- getPOIStyles
- publishCameraStream
- removePointsFromSet
- removePOISet
- removePOIStyle
- unfollowMember
- unpublishCameraStream
Events
- MemberActionAddedEvent
- MemberActionRemovedEvent
- MemberActionUsedEvent
- MemberChangedEvent
- MemberCreatedEvent
- MemberRemovedEvent
- SpaceOpenedEvent
- ViewerPOIClickedEvent
- ViewerPOIPointerEnterEvent
- ViewerPOIPointerOutEvent
- ViewerPOISetChangedEvent
- ViewerPOISetCreatedEvent
- ViewerPOISetPointsAddedEvent
- ViewerPOISetPointsChangedEvent
- ViewerPOISetPointsRemovedEvent
- ViewerPOISetRemovedEvent
- ViewerPOIStyleChangedEvent
- ViewerPOIStyleCreatedEvent
- ViewerPOIStyleRemovedEvent
Types
Enums
EventType
- MEMBER_ACTION_ADDED
- MEMBER_ACTION_REMOVED
- MEMBER_ACTION_USED
- MEMBER_CHANGED
- MEMBER_CREATED
- MEMBER_REMOVED
- SPACE_OPENED
- VIEWER_POI_CLICKED
- VIEWER_POI_POINTER_ENTER
- VIEWER_POI_POINTER_OUT
- VIEWER_POI_SET_CHANGED
- VIEWER_POI_SET_CREATED
- VIEWER_POI_SET_POINTS_ADDED
- VIEWER_POI_SET_POINTS_CHANGED
- VIEWER_POI_SET_POINTS_REMOVED
- VIEWER_POI_SET_REMOVED
- VIEWER_POI_STYLE_CHANGED
- VIEWER_POI_STYLE_CREATED
- VIEWER_POI_STYLE_REMOVED
Property
SettingStrings
- USAGE_GROUP
-
INITIAL_STATE_ACTIVATION
-
MAX_CONCURRENT_DOWNLOADS
-
MEASUREMENT_MATERIAL_DENSITIES
ViewerSettingStrings
-
SHOW_AUX_ON_NAVIGATION