[
https://issues.apache.org/jira/browse/FLINK-8135?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16470297#comment-16470297
]
ASF GitHub Bot commented on FLINK-8135:
---------------------------------------
GitHub user andrew-half opened a pull request:
https://github.com/apache/flink/pull/5985
[FLINK-8135][docs] Add description to MessageParameter
## This pull request adds methods for auto-documenting REST API.
Introduced getDescription() method will generate path and query parameter
description on
[REST API
documentation](https://ci.apache.org/projects/flink/flink-docs-master/monitoring/rest_api.html)
page.
## Brief change log
- An abstract **getDescription()** method was added to the base
**MessageParameter.java** class.
- All extending classes overrides the method with brief parameter
description.
- The method is called in the **RestAPIDocGenerator.java** class for
filling description sections in the output HTML file.
This change is a trivial documentation fix without any test coverage.
## This pull request potentially affect one of the following parts:
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Yarn/Mesos, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- This pull request just adds documentation for an existed API
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/andrew-half/flink FLINK-8135
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5985.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5985
----
commit 5026c42f23837adefbb18eb7421638d72ceef19a
Author: Andrei Poluliakh <andrei_poluliakh@...>
Date: 2018-05-10T08:27:23Z
[FLINK-8135][docs] Add description to MessageParameter
----
> Add description to MessageParameter
> -----------------------------------
>
> Key: FLINK-8135
> URL: https://issues.apache.org/jira/browse/FLINK-8135
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, REST
> Reporter: Chesnay Schepler
> Assignee: Andrei
> Priority: Major
> Fix For: 1.5.0
>
>
> For documentation purposes we should add an {{getDescription()}} method to
> the {{MessageParameter}} class, describing what this particular parameter is
> used for and which values are accepted.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
