[jira] [Commented] (FLINK-8134) Add description to MessageHeaders

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-8134?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16467371#comment-16467371 ] 

ASF GitHub Bot commented on FLINK-8134:
---------------------------------------

GitHub user maxbelov opened a pull request:

    https://github.com/apache/flink/pull/5967

    [FLINK-8134] add method getDescription() to MessageHeaders

    ## What is the purpose of the change
    * Add method getDescription() to MessageHeaders interface to provide meaningful REST endpoint description for generated documentation by implementing classes (see **_RestAPIDocGenerator_**).
    
    
    ## Brief change log
    
      - *Added method **getDescription()** to **MessageHeaders** interface to provide meaningful REST endpoint description in generated documentation*
      - *Overridden this method in all implementing classes and added descriptions*
      - *Generated by **RestAPIDocGenerator** updated documentation file **rest_dispatcher.html** to be included in Flink documentation*
    
    
    ## Verifying this change
    
    *This change is a documentation change and can be verified running `mvn package -Dgenerate-rest-docs` and check the description part for all REST endpoints is filled in documentation* 
    
    ## Does this pull request potentially affect one of the following parts:
    
      - Dependencies (does it add or upgrade a dependency): no
      - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no
      - The serializers: don't know
      - 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


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/maxbelov/flink FLINK-8134

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/5967.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 #5967
    
----
commit d329b5b0bdddee1b07b90ff6d6773fe68a1882ac
Author: maxbelov <i....@...>
Date:   2018-05-07T17:18:21Z

    [FLINK-8134] add method getDescription() to MessageHeaders to provide meaningful method description in a generated doc
    update documentation with this descriptions

----


> 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
>            Assignee: Maxim Belov
>            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)