[FLINK-9154][REST][docs] Document WebSubmissionExtension handlers This closes #5833.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/fa321ea9 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/fa321ea9 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/fa321ea9 Branch: refs/heads/master Commit: fa321ea96bc5a58d53c0cf29dbd8fb04ace3c2a8 Parents: e884a3a Author: zentol <[email protected]> Authored: Tue Apr 10 13:38:10 2018 +0200 Committer: zentol <[email protected]> Committed: Wed May 2 15:18:07 2018 +0200 ---------------------------------------------------------------------- docs/_includes/generated/rest_dispatcher.html | 307 +++++++++++++++++++ flink-docs/pom.xml | 6 + .../flink/docs/rest/RestAPIDocGenerator.java | 3 + 3 files changed, 316 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/fa321ea9/docs/_includes/generated/rest_dispatcher.html ---------------------------------------------------------------------- diff --git a/docs/_includes/generated/rest_dispatcher.html b/docs/_includes/generated/rest_dispatcher.html index 98c9d42..36bf242 100644 --- a/docs/_includes/generated/rest_dispatcher.html +++ b/docs/_includes/generated/rest_dispatcher.html @@ -101,6 +101,313 @@ <table class="table table-bordered"> <tbody> <tr> + <td class="text-left" colspan="2"><strong>/jars</strong></td> + </tr> + <tr> + <td class="text-left" style="width: 20%">Verb: <code>GET</code></td> + <td class="text-left">Response code: <code>200 OK</code></td> + </tr> + <tr> + <td colspan="2">description</td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-525177469">Request</button> + <div id="-525177469" class="collapse"> + <pre> + <code> +{} </code> + </pre> + </div> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-1669843955">Response</button> + <div id="-1669843955" class="collapse"> + <pre> + <code> +{ + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo", + "properties" : { + "address" : { + "type" : "string" + }, + "files" : { + "type" : "array", + "items" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "type" : "string" + }, + "uploaded" : { + "type" : "integer" + }, + "entry" : { + "type" : "array", + "items" : { + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo", + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + } + } + } + } + } + } + } + } +} </code> + </pre> + </div> + </td> + </tr> + </tbody> +</table> +<table class="table table-bordered"> + <tbody> + <tr> + <td class="text-left" colspan="2"><strong>/jars/upload</strong></td> + </tr> + <tr> + <td class="text-left" style="width: 20%">Verb: <code>POST</code></td> + <td class="text-left">Response code: <code>200 OK</code></td> + </tr> + <tr> + <td colspan="2">description</td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#919877128">Request</button> + <div id="919877128" class="collapse"> + <pre> + <code> +{ + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:FileUpload", + "properties" : { + "path" : { + "type" : "string" + } + } +} </code> + </pre> + </div> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#1132420209">Response</button> + <div id="1132420209" class="collapse"> + <pre> + <code> +{ + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody", + "properties" : { + "filename" : { + "type" : "string" + }, + "status" : { + "type" : "string", + "enum" : [ "success" ] + } + } +} </code> + </pre> + </div> + </td> + </tr> + </tbody> +</table> +<table class="table table-bordered"> + <tbody> + <tr> + <td class="text-left" colspan="2"><strong>/jars/:jarid</strong></td> + </tr> + <tr> + <td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td> + <td class="text-left">Response code: <code>200 OK</code></td> + </tr> + <tr> + <td colspan="2">description</td> + </tr> + <tr> + <td colspan="2">Path parameters</td> + </tr> + <tr> + <td colspan="2"> + <ul> +<li><code>jarid</code> - description</li> + </ul> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-974639435">Request</button> + <div id="-974639435" class="collapse"> + <pre> + <code> +{} </code> + </pre> + </div> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-789656611">Response</button> + <div id="-789656611" class="collapse"> + <pre> + <code> +{} </code> + </pre> + </div> + </td> + </tr> + </tbody> +</table> +<table class="table table-bordered"> + <tbody> + <tr> + <td class="text-left" colspan="2"><strong>/jars/:jarid/plan</strong></td> + </tr> + <tr> + <td class="text-left" style="width: 20%">Verb: <code>GET</code></td> + <td class="text-left">Response code: <code>200 OK</code></td> + </tr> + <tr> + <td colspan="2">description</td> + </tr> + <tr> + <td colspan="2">Path parameters</td> + </tr> + <tr> + <td colspan="2"> + <ul> +<li><code>jarid</code> - description</li> + </ul> + </td> + </tr> + <tr> + <td colspan="2">Query parameters</td> + </tr> + <tr> + <td colspan="2"> + <ul> +<li><code>entry-class</code> (optional): description</li> +<li><code>parallelism</code> (optional): description</li> +<li><code>program-args</code> (optional): description</li> + </ul> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-181694384">Request</button> + <div id="-181694384" class="collapse"> + <pre> + <code> +{} </code> + </pre> + </div> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#1311035100">Response</button> + <div id="1311035100" class="collapse"> + <pre> + <code> +{ + "type" : "any" +} </code> + </pre> + </div> + </td> + </tr> + </tbody> +</table> +<table class="table table-bordered"> + <tbody> + <tr> + <td class="text-left" colspan="2"><strong>/jars/:jarid/run</strong></td> + </tr> + <tr> + <td class="text-left" style="width: 20%">Verb: <code>POST</code></td> + <td class="text-left">Response code: <code>200 OK</code></td> + </tr> + <tr> + <td colspan="2">description</td> + </tr> + <tr> + <td colspan="2">Path parameters</td> + </tr> + <tr> + <td colspan="2"> + <ul> +<li><code>jarid</code> - description</li> + </ul> + </td> + </tr> + <tr> + <td colspan="2">Query parameters</td> + </tr> + <tr> + <td colspan="2"> + <ul> +<li><code>program-args</code> (optional): description</li> +<li><code>entry-class</code> (optional): description</li> +<li><code>parallelism</code> (optional): description</li> +<li><code>allowNonRestoredState</code> (optional): description</li> +<li><code>savepointPath</code> (optional): description</li> + </ul> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#1936993190">Request</button> + <div id="1936993190" class="collapse"> + <pre> + <code> +{} </code> + </pre> + </div> + </td> + </tr> + <tr> + <td colspan="2"> + <button data-toggle="collapse" data-target="#-914083094">Response</button> + <div id="-914083094" class="collapse"> + <pre> + <code> +{ + "type" : "object", + "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody", + "properties" : { + "jobid" : { + "type" : "any" + } + } +} </code> + </pre> + </div> + </td> + </tr> + </tbody> +</table> +<table class="table table-bordered"> + <tbody> + <tr> <td class="text-left" colspan="2"><strong>/jobmanager/config</strong></td> </tr> <tr> http://git-wip-us.apache.org/repos/asf/flink/blob/fa321ea9/flink-docs/pom.xml ---------------------------------------------------------------------- diff --git a/flink-docs/pom.xml b/flink-docs/pom.xml index f98de57..969e2f7 100644 --- a/flink-docs/pom.xml +++ b/flink-docs/pom.xml @@ -54,6 +54,12 @@ under the License. <version>${project.version}</version> </dependency> <dependency> + <!-- necessary for loading the web-submission extension --> + <groupId>org.apache.flink</groupId> + <artifactId>flink-runtime-web_${scala.binary.version}</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> <groupId>org.apache.flink</groupId> <artifactId>flink-yarn_${scala.binary.version}</artifactId> <version>${project.version}</version> http://git-wip-us.apache.org/repos/asf/flink/blob/fa321ea9/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java ---------------------------------------------------------------------- diff --git a/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java b/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java index 79bf677..70734da 100644 --- a/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java +++ b/flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java @@ -20,6 +20,7 @@ package org.apache.flink.docs.rest; import org.apache.flink.api.java.tuple.Tuple2; import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.JobManagerOptions; import org.apache.flink.configuration.RestOptions; import org.apache.flink.runtime.concurrent.Executors; import org.apache.flink.runtime.dispatcher.DispatcherGateway; @@ -314,6 +315,8 @@ public class RestAPIDocGenerator { static { config = new Configuration(); config.setString(RestOptions.ADDRESS, "localhost"); + // necessary for loading the web-submission extension + config.setString(JobManagerOptions.ADDRESS, "localhost"); try { restConfig = RestServerEndpointConfiguration.fromConfiguration(config); } catch (ConfigurationException e) {
