On today’s design call, we discussed AF-46, and we came up with a proposed convention. Opinions welcome!
We (@burke, @darius, with @wyclif dissenting) propose that modules should generally publish their REST resources at the top level, alongside the core resource. E.g. the appframework module would create two resources “app” and “extension” alongside the core ones like “concept” and “patient”.
We think it will be more intuitive for REST consumers who are not in the weeds of OpenMRS to see a URI like “app”, rather than “appframework/app”. And Burke further thinks that it’s better to manage any potential name conflicts socially and by conversation, rather than enforcing namespacing in our standard conventions.
(Personally I’d point out that modules are still allowed to put their REST resources in their own namespace.)
Thoughts? This change will happen (for the App Framework module) in the next week or less if nobody convinces us otherwise.