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

• Type: Sub-task
• Status: In Progress
• Priority: Not a Priority
• Resolution: Unresolved
• Affects Version/s: 1.10.0
• Fix Version/s: 3.0.0
• Component/s: Runtime / REST
• Labels: auto-deprioritized-major auto-deprioritized-minor auto-unassigned
• Assignee: Unassigned
• Reporter: Daryl Roberts
• Created: 28/Jan/20 12:53
• Updated: 03/Sep/24 06:51

Description

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 Schepler Till Rohrmann