[jira] [Created] (OOZIE-1183) Update WebServices API documentation

["Robert Kanter (JIRA)" <ji...@apache.org>]

Robert Kanter created OOZIE-1183:
------------------------------------

             Summary: Update WebServices API documentation
                 Key: OOZIE-1183
                 URL: https://issues.apache.org/jira/browse/OOZIE-1183
             Project: Oozie
          Issue Type: Bug
          Components: docs
    Affects Versions: trunk
            Reporter: Robert Kanter
             Fix For: trunk


We recently had some trouble trying to [rerun a coordinator job using the WebServices API|http://oozie.apache.org/docs/3.3.0/WebServicesAPI.html#Re-Runing_a_coordinator_job].  According to the documentation, we were trying to POST a URL like this:
{noformat}PUT http://localhost:11000/oozie/v1/job/0000024-130108101138395-oozie-oozi-C?action=rerun&type=exact&end-action=1&start-action=1{noformat}
but this gave an error.  

After looking through the client and server code, I figured out that there's a huge discrepancy between it and the documentation.  The parameters its using in the PUT request for a coordinator job are:
- action=coord-rerun
- type=[date|action]
- scope=a comma-separated list of date ranges. Each date range element is specified with two dates separated by '::' (if type=date)
- scope=a comma-separated list of action ranges. The action range is specified with two action numbers separated by '-' (if type=action)
- refresh=[true|false] used to indicate if user wants to refresh an action's input and output events.
- nocleanup=[true|false] used to indicate if user wants to cleanup output events for given rerun actions

Based on that, the correct URL to PUT is:
{noformat}http://localhost:11000/oozie/v1/job/0000024-130108101138395-oozie-oozi-C?action=coord-rerun&type=action&scope=1-1&refresh=false&nocleanup=false{noformat}


We should update the documentation with the correct information above.  We should also go through the rest of the WebServices API documentation and make sure its accurate (this isn't the first time I've had to go through the code when using the WebServices API).  

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira