Note: This is a beta release of Red Hat Bugzilla 5.0. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Also email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback here.
Bug 1011484 - API documentation for systemgroup.scheduleApplyErrataToActive (variant without date) says it returns 1 on success, but it returns array of action IDs
Summary: API documentation for systemgroup.scheduleApplyErrataToActive (variant withou...
Keywords:
Status: CLOSED DUPLICATE
Alias: None
Product: Red Hat Satellite 5
Classification: Red Hat
Component: API
Version: 560
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
Assignee: Tomas Lestach
QA Contact: Red Hat Satellite QA List
URL:
Whiteboard:
Depends On:
Blocks: sat560-triage
TreeView+ depends on / blocked
 
Reported: 2013-09-24 12:10 UTC by Jan Hutař
Modified: 2013-09-24 12:18 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-09-24 12:18:44 UTC


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.