You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "Aaron Langford (Jira)" <ji...@apache.org> on 2020/04/02 18:00:00 UTC
[jira] [Comment Edited] (FLINK-16696) Incomplete REST API docs
[ https://issues.apache.org/jira/browse/FLINK-16696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17073956#comment-17073956 ]
Aaron Langford edited comment on FLINK-16696 at 4/2/20, 5:59 PM:
-----------------------------------------------------------------
The comments in the Javadocs are inconsistent with the behavior of the API:
[https://ci.apache.org/projects/flink/flink-docs-release-1.10/api/java/index.html?org/apache/flink/runtime/rest/handler/job/savepoints/SavepointHandlers.html]
The Javadoc claims that the response JSON will be of the form (note that the second key of the object is "savepoint"):
{
{{ "status": {}}
{{ "id": "completed"}}
{{ },}}
{{ "savepoint": {}}
{{ ...}}
}
{{}}}
However, the API actually returns "operation" where the javadocs say "savepoint" is:
{{{}}
{{ {{ "status": {}}}}
{{ {{ "id": "completed"}}}}
{{ {{ },}}}}
{{ {{ "operation": {}}}}
{{ {{ ...}}}}
{{ }}}
{{ {{}}}}}
The REST API docs actually have this correct. So the javadocs need to be corrected AND the REST API docs need to be given more detail as stated in the original description.
was (Author: alangford):
The comments in the Javadocs are inconsistent with the behavior of the API:
[https://ci.apache.org/projects/flink/flink-docs-release-1.10/api/java/index.html?org/apache/flink/runtime/rest/handler/job/savepoints/SavepointHandlers.html]
The Javadoc claims that the response JSON will be of the form (note that the second key of the object is "savepoint"):
{{{}}
{{ "status": {}}
{{ "id": "completed"}}
{{ },}}
{{ "savepoint": {}}
{{ ...}}
{{ }}}
{{}}}
However, the API actually returns "operation" where the javadocs say "savepoint" is:
{{{}}
{{ "status": {}}
{{ "id": "completed"}}
{{ },}}
{{ "operation": {}}
{{ ...}}
{{ }}}
{{}}}
The REST API docs actually have this correct. So the javadocs need to be corrected AND the REST API docs need to be given more detail as stated in the original description.
> Incomplete REST API docs
> ------------------------
>
> Key: FLINK-16696
> URL: https://issues.apache.org/jira/browse/FLINK-16696
> Project: Flink
> Issue Type: Bug
> Components: Documentation, Runtime / REST
> Affects Versions: 1.10.0
> Reporter: Roman Khachatryan
> Priority: Minor
>
> Rest api docs doesn't provide enough details about /jobs/:jobid/savepoints/:triggerid endpoint (how to get completed savepoint location):
> [https://ci.apache.org/projects/flink/flink-docs-stable/monitoring/rest_api.html#api]
>
> Javadoc covers it better:
> [https://ci.apache.org/projects/flink/flink-docs-release-1.10/api/java/index.html?org/apache/flink/runtime/rest/handler/job/savepoints/SavepointHandlers.html]
>
> [http://apache-flink-user-mailing-list-archive.2336050.n4.nabble.com/Savepoint-Location-from-Flink-REST-API-td33808.html]
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)