feat(#10341): remove chtPermissionsSettings param#2209
Conversation
There was a problem hiding this comment.
Approved. One question I wanted to ask, no problem either way.
Since chtPermissionsSettings is technically still accepted (you've framed it as deprecated in the index.ts docs) and cht-docs isn't version pinned, would a small marker on these two rows help users on CHT < 5.2.0? Something like:
_Updated in v5.2.0: chtPermissionsSettings is no longer required._
in line with the existing _Introduced in v4.11.0_ pattern on analytics.getTargetDocs(). Curious what you think.
Also a tiny nit: stray <br> left at the end of the userRoles description on the hasAnyPermission row.
|
Thanks @sugat009! I ended up going for a bit extra completion here. The |
Description
As a part of resolving medic/cht-core#10341, medic/cht-core#10795 has removed the need for every passing the
chtPermissionsSettingsparameter when callinghasPermissionsorhasAnyPermissionson the cht-datasource api (from tasks/targets/contact-summary/purging config code). Previously this parameter was optional for tasks/targets/contact-summary since the webapp would automatically supply it if it was missing. However, it was required for purging config. Now it is not required at all and there is no situation where thechtPermissionsSettingsparameter should ever be provided. (Though we still accept it for backwards compatibility.)I am removing documentation for this parameter since it should no longer be relevant (even for purging config).
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.