Project

Profile

Help

Story #209

closed

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

Added by mkovacik@redhat.com about 9 years ago. Updated almost 4 years 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.

Also available in: Atom PDF