Bug 804702

Created attachment 571173 [details]
screenshot deployAllSystems()

Description of problem:
deployAllSystems() documentation  does know show the date parameter when calling the method

https://<SPACEWALK_FQDN>/rhn/apidoc/handlers/ConfigChannelHandler.jsp#deployAllSystems

Method: deployAllSystems
Description:
Schedule an immediate configuration deployment for all systems subscribed to a particular configuration channel.


  Looking the webUI:
-----------------------------------------

Parameters:

    string sessionKey
    string channelLabel - The configuration channel's label.

Returns:

    int - 1 on success, exception thrown otherwise. 

Method: deployAllSystems
Description:
Schedule a configuration deployment for all systems subscribed to a particular configuration channel.

Parameters:

    string sessionKey
    string channelLabel - The configuration channel's label.

Returns:

    int - 1 on success, exception thrown otherwise. 


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


How reproducible:
100%


Steps to Reproduce:
1. Access on the webUI the URL 
https://<SPACEWALK_FQDN>/rhn/apidoc/handlers/ConfigChannelHandler.jsp#deployAllSystems

Actual results:

 date parameter is not showed on documentation for the method signature


Expected results:

  date parameter be showed on  documentation for the method signature

Additional info:

 Looking the code we can observe that date parameter is present

java/code/src/com/redhat/rhn/frontend/xmlrpc/configchannel/ConfigChannelHandler.java
---------------------------------------
747     /**
748      * Schedule a configuration deployment for all systems in a config channel immediately
749      * @param sessionKey the session key
750      * @param channelLabel the channel to remove the files from..
751      * @return 1 if successful with the operation errors out otherwise.
752      *
753      *
754      * @xmlrpc.doc Schedule an immediate configuration deployment for all systems
755      *    subscribed to a particular configuration channel.
756      * @xmlrpc.param #session_key()
757      * @xmlrpc.param #param_desc("string","channelLabel",
758      *                       "The configuration channel's label.")
759      * @xmlrpc.returntype #return_int_success()
760      */
761     public int deployAllSystems(String sessionKey, String channelLabel) {
762         return deployAllSystems(sessionKey, channelLabel, new Date());
763     }

[...]

766     /**
767      * Schedule a configuration deployment for all systems in a config channel
769      * @param channelLabel the channel to remove the files from..
770      * @param date the date to schedule
771      * @return 1 if successful with the operation errors out otherwise.
772      *
773      *
774      * @xmlrpc.doc Schedule a configuration deployment for all systems
775      *    subscribed to a particular configuration channel.
776      * @xmlrpc.param #session_key()
777      * @xmlrpc.param #param_desc("string","channelLabel",
778      *                       "The configuration channel's label.")
779      * @xmlrpc.param #param_desc($date, "The date to schedule the action")
780      * @xmlrpc.returntype #return_int_success()
781      */
782     public int deployAllSystems(String sessionKey, String channelLabel, Date date) {
783         User loggedInUser = getLoggedInUser(sessionKey);
784         XmlRpcConfigChannelHelper configHelper = XmlRpcConfigChannelHelper.getInstance();
785         ConfigurationManager manager = ConfigurationManager.getInstance();
786 
787         ConfigChannel channel = configHelper.lookupGlobal(loggedInUser,
788                 channelLabel);
789         List<ConfigSystemDto> dtos = manager.listChannelSystems(loggedInUser, channel,
790                 null);
791         List<Server> servers = new ArrayList<Server>();
792         for (ConfigSystemDto m : dtos) {
793             Server s = SystemManager.lookupByIdAndUser(m.getId(), loggedInUser);
794             if (s != null) {
795                 servers.add(s);
796             }
797         }
798 
799         try {
800             manager.deployConfiguration(loggedInUser, servers, date);
801         }
802         catch (MissingCapabilityException e) {
803             throw new com.redhat.rhn.frontend.xmlrpc.MissingCapabilityException(
804                 e.getCapability(), e.getServer());
805         }
806         return 1;
807 
808     }