[jira] [Commented] (FLINK-15787) Upgrade REST API response to remove '-' from key names.

["Till Rohrmann (Jira)" <ji...@apache.org>]

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

Till Rohrmann commented on FLINK-15787:
---------------------------------------

I think this sounds like a very good improvement Flink should do in order to make the life of the frontend developers easier. Thanks a lot for reporting this issue [~sorahn].

> Upgrade REST API response to remove '-' from key names.
> -------------------------------------------------------
>
>                 Key: FLINK-15787
>                 URL: https://issues.apache.org/jira/browse/FLINK-15787
>             Project: Flink
>          Issue Type: Improvement
>          Components: Runtime / REST
>    Affects Versions: 1.10.0
>            Reporter: Daryl Roberts
>            Priority: Major
>             Fix For: 1.11.0
>
>
> There are some REST API responses that include keys with hyphens in them.  This results in the frontend having to use string-lookups to access those values and we lose the type information when doing that.
> Example from {{/jobs/<jobid>/vertices/<vertex>/backpressure}}
>  {{export interface JobBackpressureInterface {}}
>  {{  status: string;}}
>  {{  'backpressure-level': string;}}
>  {{  'end-timestamp': number;}}
>  {{  subtasks: JobBackpressureSubtaskInterface[];}}
>  {{}}}
>  I would like to update all of these to use {{_}} instead so we can maintain the type information we have in the web-runtime.
> My suggestion to do this with out a version bump to the API is to just make an addition to all the enpoints that include the _ versions as well. Then after the web-runtime has completely switched over to using the new keys, you can deprecate and remove the old hypenated keys at your own pace.
> [~chesnay] [~trohrmann]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)