Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Doesn't require use of additional X-Okapi-* headers
  • Allows modules to depend on the interface
  • It's use is completely optional
  • Clients are not required to know/determine the module Id in order to call a specific implementation of the interface.

Cons

  • More complex OKAPI logic?logic that Okapi, front-end and back-end need to support
  • Using namespace
      "id": "distributed_configuration","namespace": "foo","pathPattern": "/configurations/entries"
    doesn't have advantages over the existing path solution
      "id": "foo_configuration","pathPattern": "/foo/configurations/entries"

Other Considerations

  1. Do we want/need to incorporate version into the discriminator too?  This is something that came up in the JIRA comments here.
  2. Do we even want to support RAML?  If OpenAPI is the way forward, maybe we skip defining it in RAML...
    1. Has a way of sharing common API definitions/traits been sorted out yet on the OpenAPI side of things?
    2. Is the expectation that all modules will eventually move towards OpenAPI?  Even those which currently use RAML?

JIRAs

  • Jira Legacy
    serverSystem JiraJIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyUXPROD-3018
  • Jira Legacy
    serverSystem JiraJIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyFOLIO-3105
  • Jira Legacy
    serverSystem JiraJIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyFOLIO-2875
  • At least one user story for the OKAPI and ModuleDescriptor work
  • One story for the RAML/OpenAPI work
  • One story for the RMB work
  • One story for the folio-spring-base work.
  • One story for stripes-smart-components work.
  • One story for a module to make use of this (Provider/BE)
  • One story for a module to make use of this (Consumer/FE)
  • Jira Legacy
    serverSystem JIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyFOLIO-3121
  • Jira Legacy
    serverSystem JIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyFOLSPRINGB-18
  • Jira Legacy
    serverSystem JIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyOKAPI-1008
  • Jira Legacy
    serverSystem JIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keyRMB-827
  • Jira Legacy
    serverSystem JIRA
    serverId01505d01-b853-3c2e-90f1-ee9b165564fc
    keySTSMACOM-499