iTwin / itwinjs-core

Monorepo for iTwin.js Library
https://www.itwinjs.org
MIT License
591 stars 211 forks source link

Documentation Issue: Missing details for "CustomAttributeClassProps.appliesTo" property #6930

Open diegoalexdiaz opened 1 month ago

diegoalexdiaz commented 1 month ago

No documentation on the accepted / expected values for the "appliesTo" property.

Found on page https://www.itwinjs.org/reference/ecschema-metadata/metadata/customattributeclassprops - "undefined"

ben-polinsky commented 1 month ago

Thanks, who would be able to provide that comment?

ColinKerr commented 1 month ago

It is technically documented in the EC spec docs though poorly: https://www.itwinjs.org/bis/ec/ec-custom-attribute-class/

It's also referenced in the actual class docs but inexplicably the appliesTo property is just listed as containerType in the actual class: https://www.itwinjs.org/reference/ecschema-metadata/metadata/customattributeclass/

I think the actual class should use appliesTo instead of containerType to match the props and the interfaces need some actual documentation

ColinKerr commented 1 month ago

This PR improves the docs and updates the class API to match the xml, json and interfaces: https://github.com/iTwin/itwinjs-core/pull/6946