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

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


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

Description Marcelo Moreira de Mello 2011-06-02 14:37:41 UTC
Description of problem:

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


Method: getApiNamespaces
Description:
Lists available API namespaces
 
Parameters:
 
    string sessionKey
 
Returns:
 
    array:
        struct - namespace
            string "namespace" - API namespace
            string "handler" - API Handler

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

How reproducible:
100%


Actual results:

API returns a list


Expected results:

API return a dict

Comment 1 Marcelo Moreira de Mello 2011-06-02 14:44:10 UTC
Created attachment 502555 [details]
apiNamespaces.py reproducer

Hello, 

 Attached follow an reproducer with shows return type from API. 

# python apiNamespaces.py 
api.getApiNamespaces API returns <type 'dict'>

Cheers, 
Marcelo Moreira de Mello

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

Comment 3 Miroslav Suchý 2011-08-05 08:53:49 UTC
Fixed in spacewalk.git commit f95fdfd251525d86ef8c660fadccc5208643dc25

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


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