Bug 1018292 - [RFE] real-world use-cases should accompany the REST API reference
Summary: [RFE] real-world use-cases should accompany the REST API reference
Keywords:
Status: CLOSED UPSTREAM
Alias: None
Product: Pulp
Classification: Retired
Component: documentation
Version: 2.2
Hardware: Unspecified
OS: Unspecified
low
unspecified
Target Milestone: ---
: ---
Assignee: pulp-bugs
QA Contact: pulp-qe-list
URL: https://pulp-dev-guide.readthedocs.or...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-10-11 15:52 UTC by mkovacik
Modified: 2015-02-28 23:41 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-02-19 01:12:01 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Pulp Redmine 209 0 None None None Never

Description mkovacik 2013-10-11 15:52:03 UTC
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)

Comment 1 Dennis Kliban 2014-10-07 18:53:01 UTC
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.

Comment 2 Brian Bouterse 2015-02-19 01:12:01 UTC
Moved to https://pulp.plan.io/issues/209


Note You need to log in before you can comment on or make changes to this bug.