This service will be undergoing maintenance at 00:00 UTC, 2016-08-01. It is expected to last about 1 hours

Bug 722920

Summary: Improve documentation of all objects accessible in CLI
Product: [Other] RHQ Project Reporter: Ondřej Žižka <ozizka>
Component: DocumentationAssignee: Deon Ballard <dlackey>
Status: CLOSED CURRENTRELEASE QA Contact: Mike Foley <mfoley>
Severity: high Docs Contact:
Priority: high    
Version: 3.0.1CC: asantos, hrupp
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-09-01 15:19:05 EDT Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Bug Depends On:    
Bug Blocks: 678340    

Description Ondřej Žižka 2011-07-18 09:29:58 EDT
Especially Managers are quite undocumented.

There are some examples in

But complete reference is missing.

For example, an information that ResourceManager.findResourcesByCriteria(criteria)
does not  return anything if the resource type is not specified must be found by user by triage/error method.
Comment 1 Ondřej Žižka 2011-07-18 10:32:25 EDT
There's also javadocs for the API, but mostly lacks any info beyond method signatures.
Comment 2 Mike Foley 2011-12-02 14:22:53 EST
also ... the proxy object has methods that are in addition to the remote interfaces of the SLSBs that are not contained in the javadoc.  example see bz which has examples of methods on the proxy object that are not in the javadoc.
Comment 3 Deon Ballard 2012-06-28 16:24:09 EDT
This is a tall order, but I have new chapters to the CLI doc that cover what the CLI is, what the different APIs are (at a very high level), and tasks that can be performed, with examples:

Hopefully, this works to make the CLI and JON scripts more understandable.
Comment 4 Heiko W. Rupp 2013-09-01 15:19:05 EDT
Bulk closing of BZs that have no target version set, but which are ON_QA for more than a year and thus are in production for a long time.