Should the UPDATE_VERSION.data in the openEHR REST API be required?

Specifications ITS
1

OpenAPI validation file for UPDATE_VERSION has the data property as required. I assumed that the data property can be empty for UPDATE_VERSION.commit_audit.change_type=523 (deleted). For example in the case of Delete COMPOSITION, there is no payload.

The resource to be deleted is identified with UPDATE_VERSION.preceding_version_uid (as per Delete COMPOSITION).

If data is required, it must be UMComposition. Should the user send such UMComposition with only its required properties set?

By making the UPDATE_VERSION.data optional, we could omit it when deleting resources. Otherwise we have to construct a “dummy” data property. None of the required properties would identify the resource to delete (uid is optional).

2

I think you are right in principle, but probably we need to think how to specify in REST/schema terms that if data is empty then change_type must be deleted, or at least document the behaviour.
As for other suggestions, idealy we’ll need a SPECITS or SPECPR jira issue to track this bug.

3