[Pulp-list] Documenting REST APIs

Jay Dobies jason.dobies at redhat.com
Thu May 31 21:04:38 UTC 2012

When documenting REST APIs, please use the client's ability to log the 
REST calls and copy/paste the actual body. Sample responses like...

    "consumer_id":"A consumer ID",
    "repo_id":"A repository ID",
    "distributor_id":"A repostory distributor ID",
    "distributor":"A distributor object"

... kinda defeat the whole purpose of a sample response since it doesn't 
actually show what the distributor object looks like.

Additionally, please double check spelling while you're at it 
("repostory" in line three of that sample) :)

Jay Dobies
Freenode: jdob @ #pulp
http://pulpproject.org | http://blog.pulpproject.org

More information about the Pulp-list mailing list