You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2018/08/21 07:20:37 UTC
[GitHub] zentol closed pull request #6584: [FLINK-10181][rest][docs] Add
anchor links to rest requests
zentol closed pull request #6584: [FLINK-10181][rest][docs] Add anchor links to rest requests
URL: https://github.com/apache/flink/pull/6584
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/_includes/generated/rest_dispatcher.html b/docs/_includes/generated/rest_dispatcher.html
index 845dd8bebdf..ec6989bc6a8 100644
--- a/docs/_includes/generated/rest_dispatcher.html
+++ b/docs/_includes/generated/rest_dispatcher.html
@@ -1,7 +1,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/cluster</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/cluster</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
@@ -37,7 +37,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/config</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/config</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -93,7 +93,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jars</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jars</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -170,7 +170,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jars/upload</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jars/upload</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
@@ -219,7 +219,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jars/:jarid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
@@ -265,7 +265,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jars/:jarid/plan</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid/plan</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -331,7 +331,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jars/:jarid/run</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid/run</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
@@ -419,7 +419,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobmanager/config</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobmanager/config</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -469,7 +469,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobmanager/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobmanager/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -517,7 +517,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -574,7 +574,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
@@ -647,7 +647,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -697,7 +697,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/overview</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/overview</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -744,7 +744,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -902,7 +902,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
@@ -958,7 +958,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/accumulators</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/accumulators</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1049,7 +1049,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1352,7 +1352,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/config</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/config</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1430,7 +1430,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/details/:checkpointid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/details/:checkpointid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1547,7 +1547,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1693,7 +1693,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/config</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/config</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1741,7 +1741,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/exceptions</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/exceptions</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1822,7 +1822,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/execution-result</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/execution-result</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1888,7 +1888,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -1946,7 +1946,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/plan</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/plan</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2000,7 +2000,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/rescaling</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescaling</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
@@ -2064,7 +2064,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/rescaling/:triggerid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescaling/:triggerid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2130,7 +2130,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/savepoints</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/savepoints</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
@@ -2195,7 +2195,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/savepoints/:triggerid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/savepoints/:triggerid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2261,7 +2261,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2386,7 +2386,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/accumulators</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/accumulators</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2459,7 +2459,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/backpressure</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/backpressure</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2541,7 +2541,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2600,7 +2600,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/accumulators</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/accumulators</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2694,7 +2694,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2755,7 +2755,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2860,7 +2860,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -2966,7 +2966,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3047,7 +3047,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3107,7 +3107,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/subtasktimes</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasktimes</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3192,7 +3192,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/jobs/:jobid/vertices/:vertexid/taskmanagers</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/taskmanagers</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3314,7 +3314,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/overview</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/overview</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3382,7 +3382,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/savepoint-disposal</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/savepoint-disposal</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
@@ -3434,7 +3434,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/savepoint-disposal/:triggerid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/savepoint-disposal/:triggerid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3499,7 +3499,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/taskmanagers</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3585,7 +3585,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/taskmanagers/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3635,7 +3635,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/:taskmanagerid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
@@ -3788,7 +3788,7 @@
<table class="table table-bordered">
<tbody>
<tr>
- <td class="text-left" colspan="2"><strong>/taskmanagers/:taskmanagerid/metrics</strong></td>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/:taskmanagerid/metrics</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
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 2c8d187393a..82fdeec7cf6 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
@@ -152,7 +152,7 @@ private static String createHtmlEntry(MessageHeaders<?, ?, ?> spec) {
sb.append("<table class=\"table table-bordered\">\n");
sb.append(" <tbody>\n");
sb.append(" <tr>\n");
- sb.append(" <td class=\"text-left\" colspan=\"2\"><strong>" + spec.getTargetRestEndpointURL() + "</strong></td>\n");
+ sb.append(" <td class=\"text-left\" colspan=\"2\"><h5><strong>" + spec.getTargetRestEndpointURL() + "</strong></h5></td>\n");
sb.append(" </tr>\n");
sb.append(" <tr>\n");
sb.append(" <td class=\"text-left\" style=\"width: 20%\">Verb: <code>" + spec.getHttpMethod() + "</code></td>\n");
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services