Regarding commit "Resolve inconsistencies in routing configuration"

[pubmikeb]

OpenUI5 version: 1.98.0

Does the commit [INTERNAL] samples: Resolve inconsistencies in routing configuration mean that starting the 1.98.0 version, the structure of manifest.json will be changed?

E.g.:
viewId → id
viewLevel → level
viewName → name
viewPath → path

What about the backward compatibility?
Should any project, which is currently running on a version below the 1.98.0, adjust its manifest.json to be able upgrading to 1.98.0?

[flovogt]

Hi @pubmikeb ,
in the past the routing configuration was tightly coupled to views. Nowadays, the routing feature is able to use also components as routing targets. With that the former manifest properties don't match anymore. Therefore we introduced new properties with general names. The new properties will be promoted in the documentation but the former ones will still work for compatibility reasons. So, the best practice is using the new properties in projects using 1.98 and above. Projects below 1.98 should use the old properties.

[codeworrior]

One minor addition:
Apps that use the new names should also specify a minUI5Version of 1.98 (or higher) for consistency. The runtime does not check this information, but administrative tools might check it and report an issue when such an app is deployed on an older runtime (where the new property names wouldn't be understood).

[pubmikeb]

So, the best practice is using the new properties in projects using 1.98 and above. Projects below 1.98 should use the old properties.

BTW, I've tested the new manifest.json format with OpenUI5 1.98.0 and "minUI5Version": "1.98.0" but it doesn't work, I get the following error instead:

Uncaught (in promise) Error: Neither view name/content nor an XML node is given. One of them is required.

Is it a bug or should we just wait until the release of 1.98.0?

[stopcoder]

Hi @pubmikeb,

from the error message, it seems like you applied the renaming viewName → name to the viewName property under sap.ui5/rootView in manifest.json. The renaming that is done within the change ef476f1 only concerns the configurations under sap.ui5/routing and other properties out of this path should be kept unchanged.

Best regards,
Jiawei