Project

General

Profile

Actions
Copy link

Bug #788

closed

API documentation need to be improved

Added by Oded Ramraz over 13 years ago. Updated over 12 years ago.

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

Description

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

Actions
Copy link
 #1

Updated by Ohad Levy over 12 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

Actions
Copy link

Also available in: Atom PDF