Project

Profile

Help

Story #3028

As a REST API user, I can see which plugins are installed.

Added by amacdona@redhat.com about 2 years ago. Updated 6 months ago.

Status:
CLOSED - DUPLICATE
Priority:
Normal
Assignee:
-
Category:
API
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

In Pulp 2, users can get a list of installed plugins at the `/pulp/api/v2/plugins/types/` endpoint.
http://docs.pulpproject.org/dev-guide/integration/rest-api/server_plugins.html

For Pulp 3, it probably makes more sense to add this to the `v3/status/` endpoint, possibly only in "verbose" mode.

Currently, this feature is listed as 3.1+, but I think this feature would be very helpful as a sanity check for plugin writers to test the discovery of a bootstrapped plugin (ideally, freshly generated by our plugin template).
https://pulp.plan.io/projects/pulp/wiki/31+_Ideas_(post_MVP)#Status-API

Another reason to do this soon is to write reusable code that would be helpful in filling out the REST API with views for master ViewSets. For example, there is no endpoint at `v3/repositories/myrepo/importers/`, but it would be nice to see what importer types are available. I'm marking #2948 as related for this reason.

One idea for how an implantation might work is to keep a list of plugin_configs in our settings.py, similar to the INSTALLED_APPS list: https://github.com/pulp/pulp/blob/3.0-dev/platform/pulpcore/app/settings.py#L63.


Related issues

Related to Pulp - Task #2948: Decide how to handle missing endpoints due to master/detail model limitation CLOSED - WONTFIX Actions
Duplicates Pulp - Story #2867: As a user I can view plugin versions via the status API MODIFIED Actions

History

#1 Updated by amacdona@redhat.com about 2 years ago

  • Related to Task #2948: Decide how to handle missing endpoints due to master/detail model limitation added

#2 Updated by amacdona@redhat.com about 2 years ago

  • Description updated (diff)

#3 Updated by amacdona@redhat.com about 2 years ago

I imagine that this feature could also be very helpful for QE. Testing the output of this endpoint would make a great first assertion for tests of all plugins. It might also be possible to use this output to create a single set of smoketests that should work for each installed plugin.

#4 Updated by dalley over 1 year ago

  • Status changed from NEW to CLOSED - DUPLICATE

#5 Updated by dalley over 1 year ago

  • Duplicates Story #2867: As a user I can view plugin versions via the status API added

#6 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#7 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF