Bug 710152

Summary: XMLRPC API getApiNamespaces 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:
: 710160 (view as bug list) Environment:
Last Closed: 2011-12-22 16:48:00 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: 710160, 723481    
Attachments:
Description Flags
apiNamespaces.py reproducer none

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.