Bug 1004260

Summary: incorrect description on few API calls
Product: Red Hat Satellite 5 Reporter: Jan Hutař <jhutar>
Component: APIAssignee: Grant Gainey <ggainey>
Status: CLOSED CURRENTRELEASE QA Contact: Martin Korbel <mkorbel>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 560CC: cperry, mkorbel, tlestach
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1004547 (view as bug list) Environment:
Last Closed: 2015-01-13 10:25:36 UTC Type: Bug
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: 1113221    

Description Jan Hutař 2013-09-04 10:01:16 UTC
Description of problem:
There is an incorrect description of few new API calls:

sync.master.getMaster
  Remove the specified Master
sync.master.getMasterByLabel
  Remove the specified Master
sync.master.getMasters
  Get all the masters this slave knows about   (master and slave are with
                                                lover-case first letters,
                                                they are with upper-case in
                                                other descriptions)
sync.master.setCaCert
  Make the specified Master the default for this Slave's satellite-sync
sync.master.setMasterOrgs
  List all organizations the specified Master has exported to this Slave
sync.slave.getAllowedOrgs
  Get all the slaves this master knows about
sync.slave.getSlaves
  Get all the slaves this master knows about (lover-case first letters for
                                              "master" and "slave")
sync.slave.setAllowedOrgs
  Get all the slaves this master knows about
sync.slave.update
  Updates the label of the specified Slave   (looks like it can update other
                                              Slave's config as well)


Version-Release number of selected component (if applicable):
spacewalk-java-2.0.2-31.el6sat.noarch


How reproducible:
always


Steps to Reproduce:
1. Check API documentation for calls above


Actual results:
Looks like a lot of copy&paste issues and few other things.


Expected results:
Description should express what given call actually does.

Comment 1 Tomas Lestach 2013-09-05 14:03:25 UTC
The issues seem to be fixed in upstream within Bug 1004547. Switching to MODIFIED.

Comment 3 Martin Korbel 2014-09-23 11:01:39 UTC
VERIFIED on spacewalk-java-2.3.8-15.el6sat.noarch

sync.master.getMaster
  Find a Master by specifying its ID 
sync.master.getMasterByLabel
 Find a Master by specifying its label 
sync.master.getMasters
 Get all the Masters this Slave knows about 
sync.master.setCaCert
  Set the CA-CERT filename for specified Master on this Slave 
sync.master.setMasterOrgs
  Reset all organizations the specified Master has exported to this Slave
 
sync.slave.getAllowedOrgs
  Get all orgs this Master is willing to export to the specified Slave 
sync.slave.getSlaves
  Get all the Slaves this Master knows about 
sync.slave.setAllowedOrgs
  Set the orgs this Master is willing to export to the specified Slave 
sync.slave.update
  Updates attributes of the specified Slave

Comment 4 Clifford Perry 2015-01-13 10:25:36 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 

Cliff

NOTE: This bug has not been re-verified (moved to RELEASE_PENDING) prior to release. We assume that the bug has indeed been fixed and not regressed since we initially verified it. Please re-open in the future if needed.