Bug 710169

Summary: XMLRPC API getApiCallList documentation is incorrect
Product: [Community] Spacewalk Reporter: Marcelo Moreira de Mello <mmello>
Component: APIAssignee: Miroslav Suchý <msuchy>
Status: CLOSED CURRENTRELEASE QA Contact: Red Hat Satellite QA List <satqe-list>
Severity: low Docs Contact:
Priority: low    
Version: 1.5CC: mmello, msuchy
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: spacewalk-java-1.6.16-1 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 710171 (view as bug list) Environment:
Last Closed: 2011-12-22 16:47:21 UTC Type: ---
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: 710171, 723481    
Attachments:
Description Flags
apiCallList.py reproducer none

Description Marcelo Moreira de Mello 2011-06-02 15:02:59 UTC
Description of problem:
XMLRPC API getApiCallList documentation is incorrect. The
documentation says that it returns list, but returns a dict. 

Method: getApiCallList
Description:
Lists all available api calls grouped by namespace

Parameters:

    string sessionKey

Returns:

    array:
        array:
            struct - method_info
                string "name" - method name
                string "parameters" - method parameters
                string "exceptions" - method exceptions
                string "return" - method return type



Version-Release number of selected component (if applicable):
Spacewalk 1.5 


How reproducible:
100%

Comment 1 Marcelo Moreira de Mello 2011-06-02 15:06:13 UTC
Created attachment 502567 [details]
apiCallList.py reproducer

Hello, 

 Attached a reproducer in python. 


# python apiCallList.py 
api.getApiCallList API returns <type 'dict'>

Cheers, 
Marcelo Moreira de Mello

Comment 2 Jan Pazdziora (Red Hat) 2011-07-20 11:49:24 UTC
Aligning under space16.

Comment 3 Miroslav Suchý 2011-08-05 09:23:15 UTC
Fixed in spacewalk.git commit a632a65289bf9b2b48f1a85a4abc07b931ce58bf

Comment 4 Milan Zázrivec 2011-12-22 16:47:21 UTC
Spacewalk 1.6 has been released.