Myasuka commented on a change in pull request #11250: [FLINK-16302][rest]add
log list and read log by name for taskmanager
URL: https://github.com/apache/flink/pull/11250#discussion_r394281662
##########
File path: docs/_includes/generated/rest_v1_dispatcher.html
##########
@@ -4128,3 +4128,116 @@
</tr>
</tbody>
</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left"
colspan="2"><h5><strong>/taskmanagers/:taskmanagerid/logs</strong></h5></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">Returns the list of log files on a TaskManager.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+ <li><code>taskmanagerid</code> - 32-character hexadecimal
string that identifies a task manager.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse"
data-target="#1220778126">Request</button>
+ <div id="1220778127" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse"
data-target="#1531506487">Response</button>
+ <div id="1531506488" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" :
"urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:LogsInfo",
+ "properties" : {
+ "logs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" :
"urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:LogInfo",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "size" : {
+ "type" : "long"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left"
colspan="2"><h5><strong>/taskmanagers/:taskmanagerid/logs/:filename</strong></h5></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">Provides access to get task manager file.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+ <li><code>taskmanagerid</code> - 32-character hexadecimal
string that identifies a task manager.</li>
+ <li><code>filename</code> - string that identifies a file's
name in task manager's log dir.</li>
Review comment:
These descriptions should be generated by java code of `getDescription`.
However, they seems not the same as current descriptions.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
