Bug 710162 - XMLRPC API getApiNamespaceCallList documentation is incorrect
Summary: XMLRPC API getApiNamespaceCallList 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: 710164 space16
TreeView+ depends on / blocked
 
Reported: 2011-06-02 14:50 UTC by Marcelo Moreira de Mello
Modified: 2011-12-22 16:49 UTC (History)
2 users (show)

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


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

Description Marcelo Moreira de Mello 2011-06-02 14:50:40 UTC
Description of problem:

XMLRPC API getApiNamespaceCallList documentation is incorrect. The documentation says that it returns list, but returns a dict. 

Method: getApiNamespaceCallList
Description:
Lists all available api calls for the specified namespace

Parameters:

    string sessionKey
    string namespace

Returns:

    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 14:54:17 UTC
Created attachment 502563 [details]
apiNamespacesCallList.py reproducer

Hello, 

 As attach a reproducer in python. 


# python NamespaceCallList.py 
api.getApiNamespaceCallList API returns <type 'dict'>

Cheers, 
Marcelo Moreira de Mello

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

Comment 3 Miroslav Suchý 2011-08-05 09:00:48 UTC
Fixed in spacewalk.git commit ddabb3cd72bc112dafec6b92daf429d06fd4c13f

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


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