[
https://issues.apache.org/jira/browse/FLINK-8134?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16451942#comment-16451942
]
Chesnay Schepler commented on FLINK-8134:
-----------------------------------------
The description should contain what the action does and what the response
means. The [existing explanation for
cancel-with-savepoint|https://ci.apache.org/projects/flink/flink-docs-master/monitoring/rest_api.html#cancel-job-with-savepoint]
is a good example, although we should reduce it a bit.
In general the existing explanations on the linked page are usable.
> Add description to MessageHeaders
> ---------------------------------
>
> Key: FLINK-8134
> URL: https://issues.apache.org/jira/browse/FLINK-8134
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, REST
> Reporter: Chesnay Schepler
> Priority: Major
> Fix For: 1.5.0
>
>
> For documentation purposes we should add an {{getDescription()}} method to
> the {{MessageHeaders}} interface, describing what particular action this REST
> call executes.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
