flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Chesnay Schepler (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-8135) Add description to MessageParameter
Date Wed, 25 Apr 2018 09:19:00 GMT

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

Chesnay Schepler commented on FLINK-8135:
-----------------------------------------

When you look the [REST API documentation|https://ci.apache.org/projects/flink/flink-docs-master/monitoring/rest_api.html#dispatcher]
you can find a listing of all path/query parameters that the given call supports, with a placeholder
description.

 For example, {{*/jobs/metrics*}} supports {{get}}, {{agg}} and {{jobs}}, but no explanation
as to what they are for or what values they accept. This is what the description should contain.

Examples:

{{get:}} Comma-separated list of metric names whose values are requested.
 {{agg:}} Comma-separated list of aggregations that should be applied to the given metrics.
(SUM,AVG,MAX,MIN). By default all aggregations are returned.
 {{jobs:}} Comma-separate list of job IDs (example: ABC...) to select jobs to aggregate metrics
over.

Most parameters are rather self-explanatory though (like {{jobid}}).

As for the {{RestAPIDocGenerator}}, {{createPathParameterHtmlList()}} and {{createQueryParameterHtmlList()}}
have to be updated to access the description from the parameter.

> 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
>            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)

Mime
View raw message