Bug #788

API documentation need to be improved

Added by Oded Ramraz about 2 years ago. Updated 10 months ago.

Status:Resolved Start:03/24/2011
Priority:Normal Due date:
Assigned to:Ohad Levy % Done:

0%
Category:API
Target version:1.1
Backlog:No Difficulity:
Votes: 0

Description

Foreman API documentation should be improved : * The functions parameters description should be detailed * Mark mandatory / non mandatory parameters * Add more usage examples

History

Updated by Ohad Levy 10 months ago

  • Status changed from New to Resolved
  • Target version set to 1.1

this is now actually resolved as we started to use the apipie gem to auto generate API/SDK/CLI

Also available in: Atom PDF