Bug #788

API documentation need to be improved

Added by Oded Ramraz over 5 years ago. Updated about 4 years ago.

Status:Resolved
Priority:Normal
Assigned To:Ohad Levy
Category:API
Target version:1.1
Difficulty: Bugzilla link:
Found in release: Pull request:
Story points-
Velocity based estimate-

Description

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

History

#1 Updated by Ohad Levy about 4 years 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