Bug 749476

Summary: Incorrect API documentation: channel.software.getDetails
Product: Red Hat Satellite 5 Reporter: Šimon Lukašík <slukasik>
Component: APIAssignee: Tomas Lestach <tlestach>
Status: CLOSED CURRENTRELEASE QA Contact: Martin Korbel <mkorbel>
Severity: low Docs Contact:
Priority: medium    
Version: 541CC: cperry, mkorbel, mminar
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: spacewalk-java-1.7.54-2 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-09-21 09:21:02 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: 819036, 819081    

Description Šimon Lukašík 2011-10-27 07:48:38 UTC
Description of problem:
According to the API documentation of channel.software.getDetails
the API call should return struct(hash) with 21 keys (None of them
is referred to be optional). In reality, the API call returns
a struct with 16 keys. 

The 5 keys which are missing in my cases are:

    maintainer_name
    maintainer_email
    maintainer_phone
    support_policy
    clone_original

could we please amend the documentation to refer these as optional?

Version-Release number of selected component (if applicable):
RHN Satellite 5.4.1+

How reproducible:
deterministic

Steps to Reproduce:
1. Create custom channel (channel.software.create)
2. Pull channel details out (channel.software.getDetails)
3.
  
Actual results:
API result does not correspond with the documentation.

Expected results:
API results corresponds with the documentation.

Additional info:
Not a regression against RHN Satellite 5.3+

Comment 1 Tomas Lestach 2012-01-25 17:20:04 UTC
Simon, you're right for the first 4 attributes. Not for "clone_original", that shall be returned every time.

Returning empty string instead of omitting the attribute in the API ...

spacewalk.git: 7400ba5f68c312777c98ce942ec243859a76c86c

Comment 5 Clifford Perry 2012-09-21 09:21:02 UTC
This issue is resolved with the release of RHN Satellite 5.5. 

As of September 20th 2012, RHN Satellite 5.5 has been generally available. 

Release Notes and other 5.5 documentation can be found here:

 https://access.redhat.com/knowledge/docs/Red_Hat_Network_Satellite/

The associated Errata for the 5.5 release are:

5.5 Satellite GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1296.html

5.5 Upgrade Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1298.html

5.5 RHN Proxy GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1297.html

5.5 RHN Tools GA Errata
 - http://rhn.redhat.com/errata/RHEA-2012-1299.html

Regards,
Clifford
- Engineering Manager, Satellite