Bug #788

API documentation need to be improved

Added by Oded Ramraz over 7 years ago. Updated almost 6 years ago.

Status:Resolved
Priority:Normal
Assignee:Ohad Levy
Category:API
Target version:1.1
Difficulty: Team Backlog:
Triaged: Fixed in Releases:
Bugzilla link: Found in Releases:
Pull request:

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 almost 6 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