[
https://issues.apache.org/jira/browse/FLINK-8133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16262704#comment-16262704
]
ASF GitHub Bot commented on FLINK-8133:
---------------------------------------
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5052
[FLINK-8133][REST][docs] Generate REST API documentation
## What is the purpose of the change
This PR adds a generator for the REST API documentation. The generated has
to be run manually (automatic integration is a bit tricky, in particular
detecting changes & failing the build).
The generator can be called by either specifying either
`-Pgenerate-rest-docs` or `-Dgenerate-rest-docs` when building `flink-docs`.
The generated content was added to the REST API documentation
(`/monitoring/rest_api.html`).
Here's a preview of the result:
## Brief change log
* modify URL comparator in RestServerEndpoint to be public
* add a new module `flink-docs` (to not pollute other modules with
dependencies)
* implement generator
* generated dispatcher REST documentation
* integrated generated content into rest_api.md
## Verifying this change
Needs manual verification.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes)
- 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)
- If yes, how is the feature documented? (not applicable)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8133
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5052.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 #5052
----
----
> Generate documentation for new REST API
> ---------------------------------------
>
> Key: FLINK-8133
> URL: https://issues.apache.org/jira/browse/FLINK-8133
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, REST
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Priority: Blocker
> Fix For: 1.5.0
>
>
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
