uiSchema params for overview property are overwritten by ui code

[JC-wk]

Resolves #4861

What is being addressed

• uiSchema params for overview property are overwritten by ui code in ui/app/src/components/shared/create-update-resource/ResourceForm.tsx

How is this addressed

• fix uiSchema params for overview property are overwritten by ui code
• Update CHANGELOG.md
• Increment ui version

[github-actions]

Unit Test Results

241 tests   241 ✅  27s ⏱️
 27 suites    0 💤
  1 files      0 ❌

Results for commit 6922152.

♻️ This comment has been updated with latest results.

[marrobi]

@JC-wk good catch.

Looking at this more closely, I'm wondering if the UI should be forcing overview to be a textarea at all. The overview field is already defined in the template schemas, and templates can specify their own uiSchema settings. Rather than having the UI override (and potentially clobber) template-defined settings, perhaps the cleaner solution would be to add "overview": { "ui:widget": "textarea" } to the uiSchema in each template that uses the overview field?

This keeps the control with the template authors, avoids unexpected overwrites, and removes the need for special-case handling in the UI code. What do you think about updating the templates instead and removing this override entirely?

Maybe we should do both for now, and remove the UI fix later.

[JC-wk]

@marrobi I'm fine with it being in the templates, it could also be made conditional to avoid the clobber and it remove later, it's a mildly breaking change for people to update their custom templates.

[marrobi]

@JC-wk can we update the templates too, then remove the UI fix later given its a breaking change? Maybe add a "TODO:" comment.

[JC-wk]

@marrobi Templates now updated

[marrobi]

@tamirkamara what are your thoughts on this? Maybe it needs adding in api_app/schemas rather than the individual templates, think they are merged.

Sorry @JC-wk