[FLINK-31383] Add support for documenting additionProperties of the REST API payloads.

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.18.0
• Component/s: Documentation, Runtime / REST
• Labels: pull-request-available
• Assignee: David Morávek
• Reporter: David Morávek
• Created: 09/Mar/23 13:53
• Updated: 10/May/23 11:20
• Resolved: 10/Mar/23 07:11

Description

For implementing the request and response body of the resource requirements endpoint, we need to be able to document "additionalProperties" because these payloads have only top-level dynamic properties of the same type.

This affects both classic (HTML docs) and OpenAPI generators.

An example of what we want to be able to document is:

@JsonAnySetter
@JsonAnyGetter
@JsonSerialize(keyUsing = JobVertexIDKeySerializer.class)
@JsonDeserialize(keyUsing = JobVertexIDKeyDeserializer.class)
private final Map<JobVertexID, JobVertexResourceRequirements> jobVertexResourceRequirements;

Issue Links

• links to: GitHub Pull Request #22139