openui5 icon indicating copy to clipboard operation
openui5 copied to clipboard

No mention of `sap.ui.Global` in the API reference

Open pubmikeb opened this issue 4 years ago • 8 comments

In the JavaScript Code Issues is written:

Commonly used names (However they can also be used as AMD references via sap/ui/Global)

However, when I try to check an API reference of sap/ui/Global or sap.ui.Global, I get «Not found».

P.S. It's a cross-posting of https://github.com/SAP/openui5-docs/issues/64. Where should I open an API reference/documentation related tickets: https://github.com/SAP/openui5 or https://github.com/SAP/openui5-docs?

pubmikeb avatar Nov 13 '21 16:11 pubmikeb

Hello @pubmikeb ,

Documentation, regarding sap/ui/Global can be found under the sap namespace: https://openui5nightly.hana.ondemand.com/api/sap

Regards, Iliana

IlianaB avatar Nov 15 '21 09:11 IlianaB

@IlianaB I think this issue can be seen as an enhancement request. IMHO, the search field in the API reference page should also consider Module: ... when applying the filter.

Expected

sap-ui5-api-reference-filter-sapuiglobal expected

Current state

sap-ui5-api-reference-filter-sapuiglobal current


@pubmikeb @IlianaB Would you agree?

boghyon avatar Nov 15 '21 14:11 boghyon

@pubmikeb Would you agree?

Right, if I type sap/ui/Global or sap.ui.Global, I expect to get some results if there is such data.

No data, please try with the global search means for me that sap/ui/Global or sap.ui.Global don't appear in the API reference at all, which is wrong.

pubmikeb avatar Nov 15 '21 14:11 pubmikeb

Hello @pubmikeb and @boghyon ,

I have synced this suggestion with the DemoKit team and created Internal Incident 2170324208 for enhancement request, in order to track the progress. The status of this issue will be updated here in GitHub.

Regards, Iliana

IlianaB avatar Nov 16 '21 17:11 IlianaB

Backlog Item is created BGSOFUIPIRIN-5529.

flovogt avatar Jan 25 '22 09:01 flovogt

@kgogov Thanks for the change. Unfortunately, the change doesn't really address the issue discussed here. E.g. from https://github.com/SAP/openui5/issues/3384#issuecomment-968965908:

[...] consider Module: ... when applying the filter.

It is still not possible to filter by "sap/ui/Global" since the filter doesn't take the Module: sap/ui/Global information into account.

On the other hand, now with the above change, searching by pseudo module IDs such as the sap/m/ButtonType (real module ID: sap/m/library) is unexpectedly showing the result in the tree, because the filter doesn't take the real Module: ... information into account.

boghyon avatar Mar 27 '24 10:03 boghyon

Backlog Item is created BGSOFUIPIRIN-5529.

Follow-up BLI: BGSOFUIPIRIN-6532

50gY avatar May 13 '24 10:05 50gY