Bug 710169 - XMLRPC API getApiCallList documentation is incorrect
Summary: XMLRPC API getApiCallList documentation is incorrect
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Spacewalk
Classification: Community
Component: API
Version: 1.5
Hardware: All
OS: All
low
low
Target Milestone: ---
Assignee: Miroslav Suchý
QA Contact: Red Hat Satellite QA List
URL:
Whiteboard:
Depends On:
Blocks: 710171 space16
TreeView+ depends on / blocked
 
Reported: 2011-06-02 15:02 UTC by Marcelo Moreira de Mello
Modified: 2011-12-22 16:47 UTC (History)
2 users (show)

Fixed In Version: spacewalk-java-1.6.16-1
Clone Of:
: 710171 (view as bug list)
Environment:
Last Closed: 2011-12-22 16:47:21 UTC
Embargoed:


Attachments (Terms of Use)
apiCallList.py reproducer (373 bytes, text/x-python)
2011-06-02 15:06 UTC, Marcelo Moreira de Mello
no flags Details

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.


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