{"action":"opened","number":5967,"pull_request":{"url":"https://api.github.com/repos/apache/flink/pulls/5967","id":186622170,"html_url":"https://github.com/apache/flink/pull/5967","diff_url":"https://github.com/apache/flink/pull/5967.diff","patch_url":"https://github.com/apache/flink/pull/5967.patch","issue_url":"https://api.github.com/repos/apache/flink/issues/5967","number":5967,"state":"open","locked":false,"title":"[FLINK-8134] add method getDescription() to MessageHeaders","user":{"login":"maxbelov","id":3082096,"avatar_url":"https://avatars3.githubusercontent.com/u/3082096?v=4","gravatar_id":"","url":"https://api.github.com/users/maxbelov","html_url":"https://github.com/maxbelov","followers_url":"https://api.github.com/users/maxbelov/followers","following_url":"https://api.github.com/users/maxbelov/following{/other_user}","gists_url":"https://api.github.com/users/maxbelov/gists{/gist_id}","starred_url":"https://api.github.com/users/maxbelov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/maxbelov/subscriptions","organizations_url":"https://api.github.com/users/maxbelov/orgs","repos_url":"https://api.github.com/users/maxbelov/repos","events_url":"https://api.github.com/users/maxbelov/events{/privacy}","received_events_url":"https://api.github.com/users/maxbelov/received_events","type":"User","site_admin":false},"body":"## What is the purpose of the change\r\n* Add method getDescription() to MessageHeaders interface to provide meaningful REST endpoint description for generated documentation by implementing classes (see **_RestAPIDocGenerator_**).\r\n\r\n\r\n## Brief change log\r\n\r\n  - *Added method **getDescription()** to **MessageHeaders** interface to provide meaningful REST endpoint description in generated documentation*\r\n  - *Overridden this method in all implementing classes and added descriptions*\r\n  - *Generated by **RestAPIDocGenerator** updated documentation file **rest_dispatcher.html** to be included in Flink documentation*\r\n\r\n\r\n## Verifying this change\r\n\r\n*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* \r\n\r\n## Does this pull request potentially affect one of the following parts:\r\n\r\n  - Dependencies (does it add or upgrade a dependency): no\r\n  - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no\r\n  - The serializers: don't know\r\n  - The runtime per-record code paths (performance sensitive): no\r\n  - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: no\r\n  - The S3 file system connector: no\r\n\r\n## Documentation\r\n\r\n  - Does this pull request introduce a new feature? no\r\n","created_at":"2018-05-08T12:43:52Z","updated_at":"2018-05-08T12:43:52Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/apache/flink/pulls/5967/commits","review_comments_url":"https://api.github.com/repos/apache/flink/pulls/5967/comments","review_comment_url":"https://api.github.com/repos/apache/flink/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apache/flink/issues/5967/comments","statuses_url":"https://api.github.com/repos/apache/flink/statuses/d329b5b0bdddee1b07b90ff6d6773fe68a1882ac","head":{"label":"maxbelov:FLINK-8134","ref":"FLINK-8134","sha":"d329b5b0bdddee1b07b90ff6d6773fe68a1882ac","user":{"login":"maxbelov","id":3082096,"avatar_url":"https://avatars3.githubusercontent.com/u/3082096?v=4","gravatar_id":"","url":"https://api.github.com/users/maxbelov","html_url":"https://github.com/maxbelov","followers_url":"https://api.github.com/users/maxbelov/followers","following_url":"https://api.github.com/users/maxbelov/following{/other_user}","gists_url":"https://api.github.com/users/maxbelov/gists{/gist_id}","starred_url":"https://api.github.com/users/maxbelov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/maxbelov/subscriptions","organizations_url":"https://api.github.com/users/maxbelov/orgs","repos_url":"https://api.github.com/users/maxbelov/repos","events_url":"https://api.github.com/users/maxbelov/events{/privacy}","received_events_url":"https://api.github.com/users/maxbelov/received_events","type":"User","site_admin":false},"repo":{"id":130832599,"name":"flink","full_name":"maxbelov/flink","owner":{"login":"maxbelov","id":3082096,"avatar_url":"https://avatars3.githubusercontent.com/u/3082096?v=4","gravatar_id":"","url":"https://api.github.com/users/maxbelov","html_url":"https://github.com/maxbelov","followers_url":"https://api.github.com/users/maxbelov/followers","following_url":"https://api.github.com/users/maxbelov/following{/other_user}","gists_url":"https://api.github.com/users/maxbelov/gists{/gist_id}","starred_url":"https://api.github.com/users/maxbelov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/maxbelov/subscriptions","organizations_url":"https://api.github.com/users/maxbelov/orgs","repos_url":"https://api.github.com/users/maxbelov/repos","events_url":"https://api.github.com/users/maxbelov/events{/privacy}","received_events_url":"https://api.github.com/users/maxbelov/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/maxbelov/flink","description":"Mirror of Apache Flink","fork":true,"url":"https://api.github.com/repos/maxbelov/flink","forks_url":"https://api.github.com/repos/maxbelov/flink/forks","keys_url":"https://api.github.com/repos/maxbelov/flink/keys{/key_id}","collaborators_url":"https://api.github.com/repos/maxbelov/flink/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/maxbelov/flink/teams","hooks_url":"https://api.github.com/repos/maxbelov/flink/hooks","issue_events_url":"https://api.github.com/repos/maxbelov/flink/issues/events{/number}","events_url":"https://api.github.com/repos/maxbelov/flink/events","assignees_url":"https://api.github.com/repos/maxbelov/flink/assignees{/user}","branches_url":"https://api.github.com/repos/maxbelov/flink/branches{/branch}","tags_url":"https://api.github.com/repos/maxbelov/flink/tags","blobs_url":"https://api.github.com/repos/maxbelov/flink/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/maxbelov/flink/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/maxbelov/flink/git/refs{/sha}","trees_url":"https://api.github.com/repos/maxbelov/flink/git/trees{/sha}","statuses_url":"https://api.github.com/repos/maxbelov/flink/statuses/{sha}","languages_url":"https://api.github.com/repos/maxbelov/flink/languages","stargazers_url":"https://api.github.com/repos/maxbelov/flink/stargazers","contributors_url":"https://api.github.com/repos/maxbelov/flink/contributors","subscribers_url":"https://api.github.com/repos/maxbelov/flink/subscribers","subscription_url":"https://api.github.com/repos/maxbelov/flink/subscription","commits_url":"https://api.github.com/repos/maxbelov/flink/commits{/sha}","git_commits_url":"https://api.github.com/repos/maxbelov/flink/git/commits{/sha}","comments_url":"https://api.github.com/repos/maxbelov/flink/comments{/number}","issue_comment_url":"https://api.github.com/repos/maxbelov/flink/issues/comments{/number}","contents_url":"https://api.github.com/repos/maxbelov/flink/contents/{+path}","compare_url":"https://api.github.com/repos/maxbelov/flink/compare/{base}...{head}","merges_url":"https://api.github.com/repos/maxbelov/flink/merges","archive_url":"https://api.github.com/repos/maxbelov/flink/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/maxbelov/flink/downloads","issues_url":"https://api.github.com/repos/maxbelov/flink/issues{/number}","pulls_url":"https://api.github.com/repos/maxbelov/flink/pulls{/number}","milestones_url":"https://api.github.com/repos/maxbelov/flink/milestones{/number}","notifications_url":"https://api.github.com/repos/maxbelov/flink/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/maxbelov/flink/labels{/name}","releases_url":"https://api.github.com/repos/maxbelov/flink/releases{/id}","deployments_url":"https://api.github.com/repos/maxbelov/flink/deployments","created_at":"2018-04-24T09:50:12Z","updated_at":"2018-05-07T17:23:54Z","pushed_at":"2018-05-08T10:47:06Z","git_url":"git://github.com/maxbelov/flink.git","ssh_url":"git@github.com:maxbelov/flink.git","clone_url":"https://github.com/maxbelov/flink.git","svn_url":"https://github.com/maxbelov/flink","homepage":null,"size":153249,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"apache:master","ref":"master","sha":"5249981dc51401b041b380635b19ca1b01141119","user":{"login":"apache","id":47359,"avatar_url":"https://avatars0.githubusercontent.com/u/47359?v=4","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"repo":{"id":20587599,"name":"flink","full_name":"apache/flink","owner":{"login":"apache","id":47359,"avatar_url":"https://avatars0.githubusercontent.com/u/47359?v=4","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/apache/flink","description":"Mirror of Apache Flink","fork":false,"url":"https://api.github.com/repos/apache/flink","forks_url":"https://api.github.com/repos/apache/flink/forks","keys_url":"https://api.github.com/repos/apache/flink/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apache/flink/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apache/flink/teams","hooks_url":"https://api.github.com/repos/apache/flink/hooks","issue_events_url":"https://api.github.com/repos/apache/flink/issues/events{/number}","events_url":"https://api.github.com/repos/apache/flink/events","assignees_url":"https://api.github.com/repos/apache/flink/assignees{/user}","branches_url":"https://api.github.com/repos/apache/flink/branches{/branch}","tags_url":"https://api.github.com/repos/apache/flink/tags","blobs_url":"https://api.github.com/repos/apache/flink/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apache/flink/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apache/flink/git/refs{/sha}","trees_url":"https://api.github.com/repos/apache/flink/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apache/flink/statuses/{sha}","languages_url":"https://api.github.com/repos/apache/flink/languages","stargazers_url":"https://api.github.com/repos/apache/flink/stargazers","contributors_url":"https://api.github.com/repos/apache/flink/contributors","subscribers_url":"https://api.github.com/repos/apache/flink/subscribers","subscription_url":"https://api.github.com/repos/apache/flink/subscription","commits_url":"https://api.github.com/repos/apache/flink/commits{/sha}","git_commits_url":"https://api.github.com/repos/apache/flink/git/commits{/sha}","comments_url":"https://api.github.com/repos/apache/flink/comments{/number}","issue_comment_url":"https://api.github.com/repos/apache/flink/issues/comments{/number}","contents_url":"https://api.github.com/repos/apache/flink/contents/{+path}","compare_url":"https://api.github.com/repos/apache/flink/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apache/flink/merges","archive_url":"https://api.github.com/repos/apache/flink/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apache/flink/downloads","issues_url":"https://api.github.com/repos/apache/flink/issues{/number}","pulls_url":"https://api.github.com/repos/apache/flink/pulls{/number}","milestones_url":"https://api.github.com/repos/apache/flink/milestones{/number}","notifications_url":"https://api.github.com/repos/apache/flink/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apache/flink/labels{/name}","releases_url":"https://api.github.com/repos/apache/flink/releases{/id}","deployments_url":"https://api.github.com/repos/apache/flink/deployments","created_at":"2014-06-07T07:00:10Z","updated_at":"2018-05-08T10:53:48Z","pushed_at":"2018-05-08T12:37:14Z","git_url":"git://github.com/apache/flink.git","ssh_url":"git@github.com:apache/flink.git","clone_url":"https://github.com/apache/flink.git","svn_url":"https://github.com/apache/flink","homepage":null,"size":153306,"stargazers_count":3658,"watchers_count":3658,"language":"Java","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":2487,"mirror_url":null,"archived":false,"open_issues_count":348,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":2487,"open_issues":348,"watchers":3658,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apache/flink/pulls/5967"},"html":{"href":"https://github.com/apache/flink/pull/5967"},"issue":{"href":"https://api.github.com/repos/apache/flink/issues/5967"},"comments":{"href":"https://api.github.com/repos/apache/flink/issues/5967/comments"},"review_comments":{"href":"https://api.github.com/repos/apache/flink/pulls/5967/comments"},"review_comment":{"href":"https://api.github.com/repos/apache/flink/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apache/flink/pulls/5967/commits"},"statuses":{"href":"https://api.github.com/repos/apache/flink/statuses/d329b5b0bdddee1b07b90ff6d6773fe68a1882ac"}},"author_association":"NONE","merged":false,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":null,"comments":0,"review_comments":0,"maintainer_can_modify":true,"commits":1,"additions":448,"deletions":48,"changed_files":57}}
{"actor":{"display_login":"maxbelov"}}