You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "David Morávek (Jira)" <ji...@apache.org> on 2023/03/10 07:12:00 UTC

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

     [ https://issues.apache.org/jira/browse/FLINK-31383?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Morávek resolved FLINK-31383.
-----------------------------------
    Fix Version/s: 1.18.0
       Resolution: Fixed

> Add support for documenting additionProperties of the REST API payloads.
> ------------------------------------------------------------------------
>
>                 Key: FLINK-31383
>                 URL: https://issues.apache.org/jira/browse/FLINK-31383
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Documentation, Runtime / REST
>            Reporter: David Morávek
>            Assignee: David Morávek
>            Priority: Minor
>              Labels: pull-request-available
>             Fix For: 1.18.0
>
>
> 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.
>  
> An example of what we want to be able to document is:
> {code:java}
> @JsonAnySetter
> @JsonAnyGetter
> @JsonSerialize(keyUsing = JobVertexIDKeySerializer.class)
> @JsonDeserialize(keyUsing = JobVertexIDKeyDeserializer.class)
> private final Map<JobVertexID, JobVertexResourceRequirements> jobVertexResourceRequirements;{code}



--
This message was sent by Atlassian Jira
(v8.20.10#820010)