[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [Pulp-list] Documenting REST APIs



Thanks for pointing this out. The CLI did not exist for this API when this doc was written (last sprint). Also, what the distributor looked like was still TBD. Both the CLI and API were finalized this sprint and I'll get this updated today.

On 05/31/2012 04:04 PM, Jay Dobies wrote:
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) :)





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]