Bug 752805 - API Documentation: Provide response examples
Summary: API Documentation: Provide response examples
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Pulp
Classification: Retired
Component: documentation
Version: 1.0.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: Sprint 30
Assignee: Sayli Karmarkar
QA Contact: Preethi Thomas
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2011-11-10 13:19 UTC by Peter Meier
Modified: 2015-03-23 01:11 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-02-24 20:16:25 UTC

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Peter Meier 2011-11-10 13:19:14 UTC 
It is nice how the API documentation provide response examples: https://fedorahosted.org/pulp/wiki/UGREST-Distributions

It would be nice to have that also for all the other objects. It doesn't need to be always a full example, but already indicating how the response will look like would be nice.

Thanks!
Comment 1 Jay Dobies 2011-11-10 13:28:08 UTC 
This is another initiative we're taking on as part of our API cleanup. Distributions is one of the first that's been revisited. Thanks for the feedback; I'm glad to see the response examples are being well received.
Comment 2 Sayli Karmarkar 2012-01-15 06:18:22 UTC 
Moving to on_qa. We have added response examples to all relevant api documentation.
Comment 3 Preethi Thomas 2012-01-16 16:18:11 UTC 
verified
https://fedorahosted.org/pulp/wiki/UGRESTAPI
Comment 4 Preethi Thomas 2012-02-24 20:16:25 UTC 
Pulp v1.0 is released
Closed Current Release.
Comment 5 Preethi Thomas 2012-02-24 20:17:48 UTC 
Pulp v1.0 is released.
Note You need to log in before you can comment on or make changes to this bug.