Project

Profile

Help

Story #209

[RFE] real-world use-cases should accompany the REST API reference

Added by mkovacik@redhat.com almost 7 years ago. Updated over 1 year ago.

Status:
CLOSED - WONTFIX
Priority:
Low
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

++ This bug was initially created as a clone of Bugzilla Bug #1018292 ++

Description of problem:

Description of problem:
Given the abstract nature of the REST API reference[1] it is hard to infer a concrete application.
For example, there are no steps to follow to create a yum repo nor to associate a consumer with a repo.
As a result, the easiest way to integrate Pulp via API is to follow the calls what the CLI tools make[2].

[1] https://pulp-dev-guide.readthedocs.org/en/pulp-2.2/integration/rest-api/index.html
[2] ~/.pulp/server_calls.log

Version-Release number of selected component (if applicable):
2.2

Expected Results:
real-life use-cases and examples should accompany the API reference involving particular plugins (either rpm, errata or puppet)

--- Additional comment from at 10/07/2014 18:53:01 ---

This is a good idea, however, the REST api will most likely be changing in the future. After these changes take effect, we should write up some recipes. Let's keep this open till that time.

Associated revisions

Revision 51554deb View on GitHub
Added by Fabricio Aguiar 2 months ago

Lint everything

closes #209

History

#1 Updated by bmbouter over 6 years ago

  • Category deleted (1)
  • Tags Documentation added

Documentation is now a Tag not a Category.

#2 Updated by bmbouter over 2 years ago

  • Status changed from NEW to CLOSED - WONTFIX

#3 Updated by bmbouter over 2 years ago

Pulp 2 is approaching maintenance mode, and this Pulp 2 ticket is not being actively worked on. As such, it is being closed as WONTFIX. Pulp 2 is still accepting contributions though, so if you want to contribute a fix for this ticket, please reopen or comment on it. If you don't have permissions to reopen this ticket, or you want to discuss an issue, please reach out via the developer mailing list.

#4 Updated by bmbouter over 2 years ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF