Bug 1011484

Summary: API documentation for systemgroup.scheduleApplyErrataToActive (variant without date) says it returns 1 on success, but it returns array of action IDs
Product: Red Hat Satellite 5 Reporter: Jan Hutař <jhutar>
Component: APIAssignee: Tomas Lestach <tlestach>
Status: CLOSED DUPLICATE QA Contact: Red Hat Satellite QA List <satqe-list>
Severity: low Docs Contact:
Priority: unspecified    
Version: 560   
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-09-24 12:18:44 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 924189    

Description Jan Hutař 2013-09-24 12:10:13 UTC
Description of problem:
API documentation for systemgroup.scheduleApplyErrataToActive (variant without date) says it returns 1 on success, but it returns array of action IDs.


Version-Release number of selected component (if applicable):
spacewalk-java-2.0.2-39.el6sat.noarch


How reproducible:
always


Steps to Reproduce:
1. Check documentation:
   Method: scheduleApplyErrataToActive
   Description:
     Schedules an action to apply errata updates to active systems from a group.
   [...]
   Returns: 
     int - 1 on success, exception thrown otherwise.
2. $ python
Python 2.7.5 (default, Aug 22 2013, 09:31:58) 
[GCC 4.8.1 20130603 (Red Hat 4.8.1-1)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> SERVER="https://<fqdn>/rpc/api"
>>> USER='<username>'
>>> PASS='<password>'
>>> import xmlrpclib
>>> client = xmlrpclib.Server(SERVER, verbose=0)
>>> key = client.auth.login(USER, PASS)
>>> client.systemgroup.scheduleApplyErrataToActive(key, 'jhutar-APIcheck', [2025])
[39]


Actual results:
Documentation and API calls are not in sync.


Expected results:
Either documentation or API call should be changed.


Additional info:
IMO not a blocker for 560 release.