Bug 1167753 - API DOC: the types of return values of distchannel methods are lists
Summary: API DOC: the types of return values of distchannel methods are lists
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite 5
Classification: Red Hat
Component: Docs API Guide
Version: 570
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
Assignee: Tomas Lestach
QA Contact: Martin Korbel
URL:
Whiteboard:
Depends On:
Blocks: sat570-lowbug
TreeView+ depends on / blocked
 
Reported: 2014-11-25 11:03 UTC by Martin Korbel
Modified: 2015-01-13 09:45 UTC (History)
0 users

Fixed In Version: spacewalk-java-2.3.8-76
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-01-13 09:45:37 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Martin Korbel 2014-11-25 11:03:45 UTC
Description of problem:
API methods:
distchannel.listDefaultMaps
distchannel.listMapsForOrg
distchannel.listMapsForOrg

These methods have a bad return description in the API documentation.


Version-Release number of selected component (if applicable):
Sat5.7
Sat5.6

How reproducible:
100%

Steps to Reproduce:
1. Try this command
> spacewalk-api --login --server localhost distchannel.listDefaultMaps %session%
Enter username: admin

Enter your password: 
$result = [
            {
              'org_specific' => 'N',
              'arch_name' => 'x86_64',
              'channel_label' => 'rhel-x86_64-server-6',
              'release' => '6Server',
              'os' => 'RHEL Server'
            }
          ];
2. Open the API documentation of this method https://<fqdn>/rhn/apidoc/handlers/DistChannelHandler.jsp

<API>
Method: listDefaultMaps
Description:
Lists the default distribution channel maps

Parameters:

    string sessionKey

Returns:

    struct - distChannelMap
        string "os" - Operationg System
        string "release" - OS Relase
        string "arch_name" - Channel architecture
        string "channel_label" - Channel label
        string "org_specific" - 'Y' organization specific, 'N' default
</API>


Actual results:
Result value is list, but this fact is missing in documentation.

Expected results:
Returns:
 array: 
    struct - distChannelMap
        string "os" - Operationg System
        string "release" - OS Relase
        string "arch_name" - Channel architecture
        string "channel_label" - Channel label
        string "org_specific" - 'Y' organization specific, 'N' default



Additional info:
This problem is already in Sat5.6.

Comment 1 Tomas Lestach 2014-11-25 15:08:12 UTC
spacewalk.git: 5eba8f05d39af5eb97a0a89133df336c56ed275c

Comment 4 Clifford Perry 2015-01-13 09:45:37 UTC
With the release of Red Hat Satellite 5.7 on January 12th 2015 this bug is being moved to a Closed Current Release state. 

The Satellite 5.7 GA Errata:
 - https://rhn.redhat.com/errata/RHSA-2015-0033.html 

Satellite 5.7 Release Notes:
 - https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/5.7/html-single/Release_Notes/index.html

Satellite Customer Portal Blog announcement for release:
 - https://access.redhat.com/blogs/1169563/posts/1315743 

NOTE: This specific bug did not get verified and being closed as assumed fixed. Please reopen if this is not resolved within the release. 

Cliff


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