Bug #31521

make /api/statuses output more structured data about plugins

Added by Evgeni Golov over 2 years ago. Updated about 2 years ago.

Target version:
Bugzilla link:
Fixed in Releases:
Found in Releases:
Red Hat JIRA:


currently, the data returned about plugins is a string, which makes it really cumbersome to look up information (like versions) of a plugin:

{"results":{"foreman":{"version":"2.2.1","api":{"version":"v2"},"plugins":["Foreman plugin: foreman-tasks, 3.0.1, Ivan Nečas, The goal of this plugin is to unify the way of showing task statuses across the Foreman instance.\nIt defines Task model for keeping the information about the tasks and Lock for assigning the tasks\nto resources. The locking allows dealing with preventing multiple colliding tasks to be run on the\nsame resource. It also optionally provides Dynflow infrastructure for using it for managing the tasks.\n","Foreman plugin: foreman_ansible, 6.0.0, Daniel Lobato Garcia, Ansible integration with Foreman","Foreman plugin: foreman_remote_execution, 4.1.0, Foreman Remote Execution team, A plugin bringing remote execution to the Foreman, completing the config management functionality with remote management functionality.","Foreman plugin: katello, 3.17.0, N/A, Katello adds Content and Subscription Management to Foreman. For this it relies on Candlepin and Pulp."],"smart_proxies":[{"name":"","status":"ok","duration_ms":"410","version":"2.2.1","features":{"pulp":"2.1.0","pulpcore":"2.1.0","puppetca":"2.2.1","puppet":"2.2.1","logs":"2.2.1"},"failed_features":{}}],"compute_resources":[],"database":{"active":true,"duration_ms":"0"}},"katello":{"version":"3.17.0","timeUTC":"2020-12-16 11:51:21 UTC","services":{"candlepin":{"status":"ok","duration_ms":"87"},"candlepin_auth":{"status":"ok","duration_ms":"56"},"foreman_tasks":{"status":"ok","duration_ms":"10"},"katello_events":{"status":"ok","message":"0 Processed, 0 Failed","duration_ms":"0"},"candlepin_events":{"status":"ok","message":"0 Processed, 0 Failed","duration_ms":"0"},"pulp3":{"status":"ok","duration_ms":"132"},"pulp":{"status":"ok","duration_ms":"224"},"pulp_auth":{"status":"ok","duration_ms":"129"}},"status":"ok"}}}

I'd prefer if the plugin information would be a hash with information.

Related issues

Related to Foreman - Tracker #27680: API bugs that need workarounds in foreman-ansible-modulesNew

Related to Hammer CLI - Feature #31570: support new structured plugin data in statuses apiClosed

Associated revisions

Revision 2bc006f9 (diff)
Added by Evgeni Golov about 2 years ago

Fixes #31521 - structured plugin information in statuses API


#1 Updated by Evgeni Golov over 2 years ago

  • Related to Tracker #27680: API bugs that need workarounds in foreman-ansible-modules added

#2 Updated by The Foreman Bot over 2 years ago

  • Assignee set to Evgeni Golov
  • Status changed from New to Ready For Testing
  • Pull request added

#3 Updated by Evgeni Golov about 2 years ago

  • Related to Feature #31570: support new structured plugin data in statuses api added

#4 Updated by The Foreman Bot about 2 years ago

  • Fixed in Releases 2.4.0 added

#5 Updated by Evgeni Golov about 2 years ago

  • Status changed from Ready For Testing to Closed

Also available in: Atom PDF