Table of Contents

...

An investigation (

Jira Legacy
server System JiraJIRA serverId 01505d01-b853-3c2e-90f1-ee9b165564fc key FOLIO-2875

) was conducted into the feasibility of using OKAPI "multiple" interfaces and "scope" to handle request routing for distributed configuration.  This page serves as a place capture the findings of that spike.

...

• Apparently it's not possible to specify a dependency on a multiple interface, so clients will need to. 
• It might be helpful to extend/enhance some of the OKAPI APIs for querying interfaces
  • Extending the provides query to allow the specification of a version could be helpful, e.g. /_/proxy/modules?provide=distributed_configuration:2.0&scope=orders Possible JIRA needed 
  • Extending /_/proxy/tenants/{tenant}/interfaces may also make sense Possible JIRA needed
• If the interface is being changed often it could become a pain for modules which require the distributed_configuration interface.  As a point of reference, mod-configuration's configuration interface has been at 2.0 for 4 years now, so it seems unlikely that we'll need to change this frequently.

...

• A naming convention will likely help here.  
  • scope is an array, so maybe it should be a list of the interfaces provided by the module, or at least those which store configuration
• Should a uniqueness constraint be placed upon "scope"?  How should clients handle the case when multiple module IDs are returned from a query using scope?

What about business logic modules?

...

JIRAs

• Jira Legacy
  server System JiraJIRA serverId 01505d01-b853-3c2e-90f1-ee9b165564fc key FOLIO-2875