[FOLIO-973] Allow UI to query admin interface offered by RMB Created: 07/Dec/17  Updated: 11/Mar/21  Resolved: 11/Mar/21

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: New Feature Priority: P3
Reporter: Adam Dickmeiss Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: core
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to OKAPI-337 Multiple instances with same interface Closed
relates to OKAPI-418 Separate interfaces from module imple... Closed
Sprint:
Development Team: Core: Platform

 Comments   
Comment by Adam Dickmeiss [ 07/Dec/17 ]

RMB has for a long time offered an admin interface. It would be great it we could access individual modules admin interface from the outside for checking system information , such as memory usage.

Comment by Adam Dickmeiss [ 07/Dec/17 ]

We don't need a special Okapi module to do this, but eventually if Okapi can use the information to , for example, route differently due to health issues for modules, the admin module might come in handy.. But suppose we want to access admin from the outside (UI component).

1. RMB modules should specify in the module descriptors that they offer the admin interface.

 {
  "id": "${artifactId}-${version}",
  ..
  "provides" : [
  ...
     {
      "id": "admin",
      "version": "1.0",
      "interfaceType": "multiple",
      "handlers": [
        {
          "methods": [
            "POST"
          ],
          "pathPattern": "/admin"
        },
        {
          "methods": [
            "POST"
          ],
          "pathPattern": "/admin/importSQL"
        },
  ...

permission sets must be defined too!

All modules with the interface can now be listed with

_/proxy/tenants/<tenant>/interfaces/admin

Each module in turn must be queried with header X-Okapi-Module-Id:module .

Comment by Adam Dickmeiss [ 07/Dec/17 ]

OKAPI-418 Closed would be nice to have for this.

Generated at Thu Feb 08 23:09:53 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.