The new incremental model update notifications in API v2 that provide a description of changes as JSON Patches are great. However, the path of each operation is supplied as a JSON Pointer. For many applications, this is great and convenient for non-EMFish processing of models.
In my Theia application I use UUIDs exclusively in my EMF resources because in editing scenarios the default path-based URI fragments can change radically even for objects that are not otherwise affected by an edit operation. And throughout the application, various components keep track of objects by their IDs, which being UUIDs are stable. And all of these components have information only about the specific objects that they track ("selections", such as in a Properties view). They do not have the whole model in which the JSON Pointers in patches can be resolved relative to the model root object to find the objects that were changed.
This makes it difficult in a component of my application that is subscribed to model updates to detect when an update includes changes in the "selection" in that component. It would be very easy if the operations in the patch referenced objects not by JSON Pointer but by the "custom path" that the Model Server supports in patches sent in /api/v2/modelsPATCH requests. That "custom path" being the object's URI fragment plus the feature and optional index.
So, this feature request asks for a new subscription option that instructs the server to provide JSON Patches in which the operations' path properties are URI-fragment-based paths and not standard JSON Pointers. I propose a new URL query parameter paths with two recognized case-insensitive values:
jsonPointer for standard JSON Pointer paths (the default if no paths parameter is supplied)
uriFragments for the "custom" URI-fragment-based paths
The new incremental model update notifications in API v2 that provide a description of changes as JSON Patches are great. However, the
pathof each operation is supplied as a JSON Pointer. For many applications, this is great and convenient for non-EMFish processing of models.In my Theia application I use UUIDs exclusively in my EMF resources because in editing scenarios the default path-based URI fragments can change radically even for objects that are not otherwise affected by an edit operation. And throughout the application, various components keep track of objects by their IDs, which being UUIDs are stable. And all of these components have information only about the specific objects that they track ("selections", such as in a Properties view). They do not have the whole model in which the JSON Pointers in patches can be resolved relative to the model root object to find the objects that were changed.
This makes it difficult in a component of my application that is subscribed to model updates to detect when an update includes changes in the "selection" in that component. It would be very easy if the operations in the patch referenced objects not by JSON Pointer but by the "custom path" that the Model Server supports in patches sent in
/api/v2/modelsPATCHrequests. That "custom path" being the object's URI fragment plus the feature and optional index.So, this feature request asks for a new subscription option that instructs the server to provide JSON Patches in which the operations'
pathproperties are URI-fragment-based paths and not standard JSON Pointers. I propose a new URL query parameterpathswith two recognized case-insensitive values:jsonPointerfor standard JSON Pointer paths (the default if nopathsparameter is supplied)uriFragmentsfor the "custom" URI-fragment-based paths