added help for the job submission remote API.

git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@3891 71c3de6d-444a-0410-be80-ed276b4c234a

core/src/main/java/hudson/model/Api.java

@@ -22,6 +22,10 @@ import java.io.StringReader;
 /**
  * Used to expose remote access API for ".../api/"
  *
+ * <p>
+ * If the parent object has a <tt>_api.jelly</tt> view, it will be included
+ * in the api index page.
+ *
  * @author Kohsuke Kawaguchi
  * @see Exported
  */
@@ -29,7 +33,7 @@ public class Api extends AbstractModelObject {
     /**
      * Model object to be exposed as XML/JSON/etc.
      */
-    private final Object bean;
+    public final Object bean;
 
     public Api(Object bean) {
         this.bean = bean;

core/src/main/resources/hudson/model/Api/index.jelly

@@ -32,6 +32,8 @@
         For more information about remote API in Hudson, see
         <a href="https://hudson.dev.java.net/remote-api.html">the documentation</a>.
       </p>
+
+      <st:include it="${it.bean}" page="_api.jelly" optional="true" />
     </l:main-panel>
 	</l:layout>
 </j:jelly>

core/src/main/resources/hudson/model/Hudson/_api.jelly

+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form" xmlns:i="jelly:fmt">
+  <h2>Create Job</h2>
+  <p>
+    To create a new job, post <tt>config.xml</tt> to <a href="../createItem">this URL</a> with
+    query parameter <tt>name=<i>JOBNAME</i></tt>. You'll get 200 status code if the creation is successful,
+    or 4xx/5xx code if it fails. <tt>config.xml</tt> is the format Hudson uses to store the project
+    in the file system, so you can see examples of them in <tt>${app.rootDir}</tt>.
+  </p>
+</j:jelly>
\ No newline at end of file