Use metadata files instead of docs to build autocomplete repo

[TimoStaudinger]

With release 1.36, OpenUI5 will publish its API metadata as JSON files, e.g.:

https://openui5.hana.ondemand.com/test-resources/sap/ui/core/designtime/api.json
https://openui5.hana.ondemand.com/test-resources/sap/m/designtime/api.json

As soon as this feature is stable, we should use these metadata files to build the autocomplete repo instead of crawling the API docs.

[codeworrior]

Please be aware that the api.json are NOT stable yet, their structure will change over time (it just changed in the last days). Nevertheless, using them instead of parsing the API docs is definitely the better way to go.

In the openui5/sap.ui.demokit lib, there is a small helper module that loads the different api.json from a freely configurable location. Unfortunately, it currently only provides a method that automatically converts the content of api.json to some other format (used by the Explored app from the SDK).

Maybe I should add another method to retrieve the raw format and allow enumeration of symbols.

There's also a JSON schema for the api.json, but it's currently stored in a SAP internal repository. I'll look for a suitable location in openui5 and place it there.

Best Regards, cw

Thank you TimoSta, your tool is very useful.

OpenUI5 API https://openui5.hana.ondemand.com/#/api is based on api.json to
dynamically generate documentation.

I have developed an online generator in java https://tern-openui5.appspot.com/
the project in GitHub : https://github.com/request92/tern-openui5-generator/

Can you see if my Pull request is well generated ?

Regards.