Add an API to retrieve NameTemplate by id
Description
Activity
xprlgjf March 27, 2025 at 1:33 PMEdited
All done, @Daniel Kayiwa . This issue can now be closed.
Daniel Kayiwa March 26, 2025 at 9:58 AM
Daniel Kayiwa March 26, 2025 at 9:57 AM
@xprlgjf for global did you mean to say layout.name.format?
Daniel Kayiwa March 23, 2025 at 7:53 PM
The refactoring pull request has been merged at https://github.com/openmrs/openmrs-module-webservices.rest/commit/5ab2a24cc62c1b3eb81812b591420336ca8d9098
Thanks @xprlgjf
xprlgjf March 17, 2025 at 9:36 PMEdited
@Daniel Kayiwa is suggesting in the pull request review comments that it would be better to break backwards compatibility in this case, rather than introduce a new controller for /nametemplates to list all known name templates.
If this is acceptable, I would propose to change the /nametemplate (singular) endpoint from a custom ‘controller’ endpoint as it is currently implemented to a 'normal' API resource endpoint (although with only a default representation; there is no need for full or reference representations). The benefit of this is that it would be picked up by the swagger documentation.
The API would therefore be:
GET /openmrs/ws/rest/v1/nametemplate - (breaking change!!) list all known name templates
GET /openmrs/ws/rest/v1/nametemplate/{codename} - (new) get a specific name template
GET /openmrs/ws/rest/v1/nametemplate/layout.name.format- (new) get the currently configured global name template
The slight oddity in this API would be the use of the specific id 'layout.name.format' for the currently configured global name template. It is unfortunate that there is no way to document this in the swagger API.
@Mark Goodrich , @Ian Bacher do you have any comment on this?
At present there exists an API to get the currently configured global name template via GET /openmrs/ws/rest/v1/nametemplate, as implemented by https://openmrs.atlassian.net/browse/RESTWS-916
However, in order to support i18n layout in the O3 Patient Registration form, it would be better if we could retrieve an arbitrary NameTemplate by id. (In the case of NameTemplates, the
codenameis the unique identifier.)In order to avoid breaking changes with the existing api, new API endpoints should be added, resulting in:
GET /openmrs/ws/rest/v1/nametemplate - (unchanged) get the currently configured global name template.
GET /openmrs/ws/rest/v1/nametemplates - (new) list all known name templates
GET /openmrs/ws/rest/v1/nametemplate/{codename} - (new) get a specific name template
GET /openmrs/ws/rest/v1/nametemplate/layout.name.format- (new) get the currently configured global name template. (duplication of existing functionality, but may allow the existing endpoint to be deprecated/retired in future)
It is inconvenient needing to use ‘nametemplates’ for listing all known templates, as opposed to the more conventional ‘nametemplate’, but it is more important to avoid breaking the existing API.