[FLINK-13136] Fix documentation error about stopping job with restful api #9013

yanghua · 2019-07-08T03:24:08Z

What is the purpose of the change

This pull request fixes documentation error about stopping job with restful api

Brief change log

Fix documentation error about stopping job with restful api

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (yes / no)
The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
The serializers: (yes / no / don't know)
The runtime per-record code paths (performance sensitive): (yes / no / don't know)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / no / don't know)
The S3 file system connector: (yes / no / don't know)

Documentation

Does this pull request introduce a new feature? (yes / no)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

flinkbot · 2019-07-08T03:25:27Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 38bdd2d (Wed Oct 16 08:17:21 UTC 2019)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

klion26 · 2019-07-08T04:47:44Z

docs/_includes/generated/rest_v1_dispatcher.html

      <td colspan="2">
        <ul>
-<li><code>mode</code> (optional): String value that specifies the termination mode. Supported values are: "cancel, stop".</li>
+<li><code>mode</code> (optional): String value that specifies the termination mode. Supported value is: "cancel".</li>


As the html file located in docks/_includes/generated, maybe you should change the source file TerminationModeQueryParameter and regenerate the html file instead of changing the html file directly.

Also as the java doc said this is for the legacy usage, do we need to change it?

Also as the java doc said this is for the legacy usage, do we need to change it?

I think the legacy usage is for cancel mode now. Since stop mode throws an exception, why we should document it for new users?

flinkbot · 2019-07-08T09:56:00Z

CI report for commit 701e7c1: SUCCESS Build

flinkbot · 2019-07-08T10:18:32Z

CI report for commit 3c85f32: FAILURE Build

flinkbot · 2019-07-08T14:23:34Z

CI report for commit fa606d1: SUCCESS Build

yanghua · 2019-07-11T09:04:16Z

Hi @tillrohrmann WDYT about this PR?

flinkbot · 2019-07-23T09:13:31Z

CI report:

2d29087 : FAILURE Build
dbf5079 : FAILURE Build
097af58 : SUCCESS Build
38bdd2d : SUCCESS Build

yanghua · 2019-07-23T12:10:09Z

I am not sure if we need to do the further refactor, for example: removing TerminationModeQueryParameter

yanghua · 2019-07-23T12:12:39Z

@aljoscha WDYT?

GJL

Thank you for your contribution to Apache Flink, @yanghua! Excluding TerminationMode.STOP from the documention is reasonable. However, I do not see the necessity to remove usages of the TerminationMode enum.

GJL · 2019-09-12T07:01:55Z

flink-clients/src/main/java/org/apache/flink/client/program/rest/RestClusterClient.java

 		JobCancellationMessageParameters params = new JobCancellationMessageParameters();
 		params.jobPathParameter.resolve(jobID);
-		params.terminationModeQueryParameter.resolve(Collections.singletonList(TerminationModeQueryParameter.TerminationMode.CANCEL));
+		params.terminationModeQueryParameter.resolve(Collections.singletonList("CANCEL"));


I liked using the enum TerminationModeQueryParameter.TerminationMode better because now we have to repeat String constants. The deprecation of TerminationModeQueryParameter and TerminationMode was wrong and should be reverted. What should be deprecated is TerminationMode.STOP since TerminationMode.CANCEL is still valid for non-checkpointed jobs and batch jobs.

Originally, I also think enum is a good choice than string. However, when I removed TerminationMode.STOP, there is only one enum value CANCEL . I suspect that multiple modes may be the reason why we define TerminationMode and I also saw the deprecation annotation, so I replaced enum with String value. Whatever, I am not against keeping TerminationMode. Will refactor the change soon.

Ok thanks. I will wait for your changes.

… api

GJL

LGTM

GJL · 2019-09-13T08:16:26Z

Merging.

…estful api This closes apache#9013.

rmetzger added review=description? component=Runtime/REST labels Jul 8, 2019

klion26 reviewed Jul 8, 2019

View reviewed changes

yanghua force-pushed the FLINK-13136 branch 3 times, most recently from f7d9ea1 to 3c85f32 Compare July 8, 2019 07:09

yanghua changed the title ~~[FLINK-13136] Fix documentation error about stop job with restful api~~ [FLINK-13136] Fix documentation error about stopping job with restful api Jul 9, 2019

yanghua force-pushed the FLINK-13136 branch from fa606d1 to 2d29087 Compare July 23, 2019 09:01

yanghua force-pushed the FLINK-13136 branch from 2d29087 to dbf5079 Compare July 23, 2019 12:07

GJL self-assigned this Sep 11, 2019

GJL requested changes Sep 12, 2019

View reviewed changes

[FLINK-13136] Fix documentation error about stopping job with restful…

38bdd2d

… api

yanghua force-pushed the FLINK-13136 branch from 097af58 to 38bdd2d Compare September 12, 2019 13:59

GJL approved these changes Sep 13, 2019

View reviewed changes

GJL pushed a commit to GJL/flink that referenced this pull request Sep 13, 2019

[FLINK-13136][docs] Fix documentation error about stopping job with r…

8e5714c

…estful api This closes apache#9013.

asfgit closed this in c59f483 Sep 13, 2019

[FLINK-13136] Fix documentation error about stopping job with restful api #9013

[FLINK-13136] Fix documentation error about stopping job with restful api #9013

Uh oh!

Conversation

yanghua commented Jul 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

Uh oh!

flinkbot commented Jul 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automated Checks

Review Progress

Uh oh!

klion26 Jul 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yanghua Jul 8, 2019

Choose a reason for hiding this comment

Uh oh!

flinkbot commented Jul 8, 2019

Uh oh!

flinkbot commented Jul 8, 2019

Uh oh!

flinkbot commented Jul 8, 2019

Uh oh!

yanghua commented Jul 11, 2019

Uh oh!

flinkbot commented Jul 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CI report:

Uh oh!

yanghua commented Jul 23, 2019

Uh oh!

yanghua commented Jul 23, 2019

Uh oh!

GJL left a comment

Choose a reason for hiding this comment

Uh oh!

GJL Sep 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yanghua Sep 12, 2019

Choose a reason for hiding this comment

Uh oh!

GJL Sep 12, 2019

Choose a reason for hiding this comment

Uh oh!

GJL left a comment

Choose a reason for hiding this comment

Uh oh!

GJL commented Sep 13, 2019

Uh oh!

Uh oh!

yanghua commented Jul 8, 2019 •

edited

Loading

flinkbot commented Jul 8, 2019 •

edited

Loading

klion26 Jul 8, 2019 •

edited

Loading

flinkbot commented Jul 23, 2019 •

edited

Loading

GJL Sep 12, 2019 •

edited

Loading