itwinjs-core icon indicating copy to clipboard operation
itwinjs-core copied to clipboard

Clean up EntityMetaData and fix incorrect release tags

Open pmconne opened this issue 1 year ago • 4 comments

Part of https://github.com/iTwin/itwinjs-backlog/issues/1103.

This was one of the very first APIs ever created for iTwin.js and boy does it show. Despite still being tagged as @beta after all these years, it has always been de facto part of the @public API due to its use in @public methods like Entity.forEachProperty and Element.getClassMetaData. (api-extractor does not check ae-incompatible-release-tags across package boundaries).

I tried to do minimal cleanup without introducing breaking changes and add/clarify documentation. Mostly I preferred to link to the learning articles in docs/bis/ec; those need some separate cleanup, though.

pmconne avatar Aug 02 '24 11:08 pmconne

@khanaffan @ColinKerr @diegoalexdiaz please fact-check my documentation.

pmconne avatar Aug 02 '24 11:08 pmconne

Can we take a look at how this stuff is actually used before we promote to public?

ColinKerr avatar Aug 02 '24 12:08 ColinKerr

Can we take a look at how this stuff is actually used before we promote to public?

We can, but I want to reiterate: it is already public and has been for years, beta tag notwithstanding. Booster's usage.

pmconne avatar Aug 02 '24 12:08 pmconne

This pull request is now in conflicts. Could you fix it @pmconne? 🙏 To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

mergify[bot] avatar Aug 06 '24 14:08 mergify[bot]